ASP.NET Core SignalR 配置ASP.NET Core SignalR configuration

本文内容

JSON/MessagePack 序列化选项JSON/MessagePack serialization options

ASP.NET Core SignalR 支持两个用于编码消息的协议： JSON和MessagePack。每个协议都具有序列化配置选项。

可以使用AddJsonProtocol扩展方法在服务器上配置 JSON 序列化。AddJsonProtocol可以在 Startup.ConfigureServices后添加。AddJsonProtocol 方法采用接收 options 对象的委托。该对象上的PayloadSerializerOptions属性是一个 System.Text.Json JsonSerializerOptions 对象，可用于配置自变量和返回值的序列化。有关详细信息，请参阅system.object 文档。

例如，若要将序列化程序配置为不更改属性名称的大小写（而不是默认的 "camelCase" 名称），请在 Startup.ConfigureServices中使用以下代码：

services.AddSignalR()
    .AddJsonProtocol(options => {
        options.PayloadSerializerOptions.PropertyNamingPolicy = null
    });

在 .NET 客户端中， HubConnectionBuilder上存在相同的 AddJsonProtocol 扩展方法。必须导入 Microsoft.Extensions.DependencyInjection 命名空间才能解析扩展方法：

// At the top of the file:
using Microsoft.Extensions.DependencyInjection;
// When constructing your connection:
var connection = new HubConnectionBuilder()
    .AddJsonProtocol(options => {
        options.PayloadSerializerOptions.PropertyNamingPolicy = null;
    })
    .Build();

备注

目前不能在 JavaScript 客户端中配置 JSON 序列化。

切换到 Newtonsoft.jsonSwitch to Newtonsoft.Json

如果需要 System.Text.Json不支持的 Newtonsoft.Json 功能，请参阅切换到 newtonsoft.json。

MessagePack 序列化选项MessagePack serialization options

可以通过向AddMessagePackProtocol调用提供委托来配置 MessagePack 序列化。有关更多详细信息，请参阅SignalR 中的 MessagePack 。

备注

目前不能在 JavaScript 客户端中配置 MessagePack 序列化。

配置服务器选项Configure server options

下表描述了用于配置 SignalR 中心的选项：

可以通过向 Startup.ConfigureServices中的 AddSignalR 调用提供选项委托，为所有中心配置选项。

public void ConfigureServices(IServiceCollection services)
{
    services.AddSignalR(hubOptions =>
    {
        hubOptions.EnableDetailedErrors = true;
        hubOptions.KeepAliveInterval = TimeSpan.FromMinutes(1);
    });
}

单个集线器的选项将覆盖 AddSignalR 中提供的全局选项，并且可以使用 AddHubOptions进行配置：

services.AddSignalR().AddHubOptions<MyHub>(options =>
{
    options.EnableDetailedErrors = true;
});

高级 HTTP 配置选项Advanced HTTP configuration options

使用 HttpConnectionDispatcherOptions 配置与传输和内存缓冲区管理相关的高级设置。可以通过将委托传递到 Startup.Configure中的MapHub<t >来配置这些选项。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapHub<MyHub>("/myhub", options =>
        {
            options.Transports =
                HttpTransportType.WebSockets |
                HttpTransportType.LongPolling;
        });
    });
}

下表描述了用于配置 ASP.NET Core SignalR 的高级 HTTP 选项的选项：

长轮询传输具有可使用 LongPolling 属性配置的其他选项：

WebSocket 传输具有可使用 WebSockets 属性配置的其他选项：

配置客户端选项Configure client options

可以在 HubConnectionBuilder 类型上配置客户端选项（在 .NET 和 JavaScript 客户端中提供）。Java 客户端中也提供了此功能，但 HttpHubConnectionBuilder 子类包含生成器配置选项，以及 HubConnection 本身。

配置日志记录Configure logging

使用 ConfigureLogging 方法在 .NET 客户端中配置日志记录。日志提供程序和筛选器的注册方式与服务器上相同。有关详细信息，请参阅ASP.NET Core 文档中的日志记录。

备注

若要注册日志记录提供程序，必须安装所需的包。有关完整列表，请参阅文档的内置日志记录提供程序部分。

例如，若要启用控制台日志记录，请安装 Microsoft.Extensions.Logging.Console NuGet 包。调用 AddConsole 扩展方法：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub")
    .ConfigureLogging(logging => {
        logging.SetMinimumLevel(LogLevel.Information);
        logging.AddConsole();
    })
    .Build();

在 JavaScript 客户端中，存在类似的 configureLogging 方法。提供一个 LogLevel 值，该值指示要生成的日志消息的最小级别。日志将写入浏览器控制台窗口中。

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub")
    .configureLogging(signalR.LogLevel.Information)
    .build();

您还可以提供表示日志级别名称的 string 值，而不是 LogLevel 值。在无法访问 LogLevel 常量的环境中配置 SignalR 日志记录时，这非常有用。

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub")
    .configureLogging("warn")
    .build();

下表列出了可用的日志级别。你为 configureLogging 提供的值设置将记录的最小日志级别。将记录在此级别上记录的消息或在表中列出的级别。

备注

若要完全禁用日志记录，请在 configureLogging 方法中指定 signalR.LogLevel.None。

有关日志记录的详细信息，请参阅SignalR Diagnostics 文档。

SignalR Java 客户端使用SLF4J库进行日志记录。这是一个高级日志记录 API，它允许库的用户通过引入特定的日志记录依赖项来选择自己的特定日志记录实现。以下代码片段演示了如何在 SignalR Java 客户端中使用 java.util.logging。

implementation 'org.slf4j:slf4j-jdk14:1.7.25'

如果未在依赖项中配置日志记录，SLF4J 将加载默认的非操作记录器，并提供以下警告消息：

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

可以安全地忽略此情况。

配置允许的传输Configure allowed transports

可以在 WithUrl 调用（JavaScript 中的withUrl）中配置 SignalR 使用的传输。HttpTransportType 的值的按位 "或" 可用于将客户端限制为仅使用指定的传输。默认情况下，将启用所有传输。

例如，若要禁用服务器发送的事件传输，但允许 Websocket 和长轮询连接，请执行以下操作：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", HttpTransportType.WebSockets | HttpTransportType.LongPolling)
    .Build();

在 JavaScript 客户端中，通过在提供给 withUrl的 options 对象上设置 transport 字段来配置传输：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", { transport: signalR.HttpTransportType.WebSockets | signalR.HttpTransportType.LongPolling })
    .build();

此版本的 Java 客户端 websocket 是唯一可用的传输。

在 Java 客户端中，通过 HttpHubConnectionBuilder上的 withTransport 方法选择传输。Java 客户端默认使用 Websocket 传输。

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/myhub")
    .withTransport(TransportEnum.WEBSOCKETS)
    .build();

备注

SignalR Java 客户端尚不支持传输回退。

配置持有者身份验证Configure bearer authentication

若要随 SignalR 请求一起提供身份验证数据，请使用 AccessTokenProvider 选项（JavaScript 中的accessTokenFactory）来指定返回所需访问令牌的函数。在 .NET 客户端中，此访问令牌作为 HTTP "持有者身份验证" 令牌传入（使用 Bearer类型的 Authorization 标头）。在 JavaScript 客户端中，访问令牌用作持有者令牌，但在某些情况下，浏览器 api 限制应用标头的能力（具体而言，在服务器发送事件和 websocket 请求中）。在这些情况下，访问令牌作为查询字符串值提供 access_token。

在 .NET 客户端中，可以使用 WithUrl中的 options 委托指定 AccessTokenProvider 选项：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", options => {
        options.AccessTokenProvider = async () => {
            // Get and return the access token.
        };
    })
    .Build();

在 JavaScript 客户端中，通过在 withUrl中的 options 对象上设置 accessTokenFactory 字段来配置访问令牌：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", {
        accessTokenFactory: () => {
            // Get and return the access token.
            // This function can return a JavaScript Promise if asynchronous
            // logic is required to retrieve the access token.
        }
    })
    .build();

在 SignalR Java 客户端中，可以通过向HttpHubConnectionBuilder提供访问令牌工厂来配置用于身份验证的持有者令牌。使用withAccessTokenFactory提供RxJava单一<字符串 >。如果调用了单延迟，你可以编写逻辑来为客户端生成访问令牌。

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/myhub")
    .withAccessTokenProvider(Single.defer(() -> {
        // Your logic here.
        return Single.just("An Access Token");
    })).build();

配置超时和 keep-alive 选项Configure timeout and keep-alive options

用于配置超时和保持活动状态的其他选项在 HubConnection 对象本身上可用：

• .NET
• JavaScript
• Java

在 .NET 客户端中，超时值指定为 TimeSpan 值。

配置其他选项Configure additional options

可以在 HubConnectionBuilder 上的 WithUrl （JavaScript 中的withUrl）方法中配置其他选项，或在 Java 客户端中 HttpHubConnectionBuilder 上的各种配置 Api 上配置其他选项：

• .NET
• JavaScript
• Java

在 .NET 客户端中，可以通过提供给 WithUrl的 options 委托来修改这些选项：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", options => {
        options.Headers["Foo"] = "Bar";
        options.Cookies.Add(new Cookie(/* ... */);
        options.ClientCertificates.Add(/* ... */);
    })
    .Build();

在 JavaScript 客户端中，可以在提供给 withUrl的 JavaScript 对象中提供这些选项：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", {
        skipNegotiation: true,
        transport: signalR.HttpTransportType.WebSockets
    })
    .build();

在 Java 客户端中，可以通过从 HubConnectionBuilder.create("HUB URL") 返回的 HttpHubConnectionBuilder 中的方法来配置这些选项。

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/myhub")
        .withHeader("Foo", "Bar")
        .shouldSkipNegotiate(true)
        .withHandshakeResponseTimeout(30*1000)
        .build();

其他资源Additional resources

• ASP.NET Core SignalR 入门
• 在 ASP.NET Core 中使用中心 SignalR
• ASP.NET Core SignalR JavaScript 客户端
• .NET 客户端 SignalR ASP.NET Core
• 在 SignalR 中使用 MessagePack 集线器协议 ASP.NET Core
• ASP.NET Core SignalR 支持的平台

JSON/MessagePack 序列化选项JSON/MessagePack serialization options

ASP.NET Core SignalR 支持两个用于编码消息的协议： JSON和MessagePack。每个协议都具有序列化配置选项。

可以使用AddJsonProtocol扩展方法在服务器上配置 JSON 序列化，该方法可在 Startup.ConfigureServices 方法中的AddSignalR之后添加。AddJsonProtocol 方法采用接收 options 对象的委托。该对象的PayloadSerializerSettings属性是可用于配置自变量和返回值的序列化 JsonSerializerSettings 对象的 JSON.NET。有关详细信息，请参阅JSON.NET 文档。

例如，若要将序列化程序配置为使用 "PascalCase" 属性名称，而不是默认的 "camelCase" 名称，请在 Startup.ConfigureServices中使用以下代码：

services.AddSignalR()
    .AddJsonProtocol(options => {
        options.PayloadSerializerSettings.ContractResolver =
            new DefaultContractResolver();
    });

在 .NET 客户端中， HubConnectionBuilder上存在相同的 AddJsonProtocol 扩展方法。必须导入 Microsoft.Extensions.DependencyInjection 命名空间才能解析扩展方法：

// At the top of the file:
using Microsoft.Extensions.DependencyInjection;
// When constructing your connection:
var connection = new HubConnectionBuilder()
    .AddJsonProtocol(options => {
        options.PayloadSerializerSettings.ContractResolver =
            new DefaultContractResolver();
    })
    .Build();

备注

目前不能在 JavaScript 客户端中配置 JSON 序列化。

MessagePack 序列化选项MessagePack serialization options

可以通过向AddMessagePackProtocol调用提供委托来配置 MessagePack 序列化。有关更多详细信息，请参阅SignalR 中的 MessagePack 。

备注

目前不能在 JavaScript 客户端中配置 MessagePack 序列化。

配置服务器选项Configure server options

下表描述了用于配置 SignalR 中心的选项：

可以通过向 Startup.ConfigureServices中的 AddSignalR 调用提供选项委托，为所有中心配置选项。

public void ConfigureServices(IServiceCollection services)
{
    services.AddSignalR(hubOptions =>
    {
        hubOptions.EnableDetailedErrors = true;
        hubOptions.KeepAliveInterval = TimeSpan.FromMinutes(1);
    });
}

单个集线器的选项将覆盖 AddSignalR 中提供的全局选项，并且可以使用 AddHubOptions进行配置：

services.AddSignalR().AddHubOptions<MyHub>(options =>
{
    options.EnableDetailedErrors = true;
});

高级 HTTP 配置选项Advanced HTTP configuration options

使用 HttpConnectionDispatcherOptions 配置与传输和内存缓冲区管理相关的高级设置。可以通过将委托传递到 Startup.Configure中的MapHub<t >来配置这些选项。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseSignalR((configure) =>
    {
        var desiredTransports =
            HttpTransportType.WebSockets |
            HttpTransportType.LongPolling;
        configure.MapHub<MyHub>("/myhub", (options) =>
        {
            options.Transports = desiredTransports;
        });
    });
}

下表描述了用于配置 ASP.NET Core SignalR 的高级 HTTP 选项的选项：

长轮询传输具有可使用 LongPolling 属性配置的其他选项：

WebSocket 传输具有可使用 WebSockets 属性配置的其他选项：

配置客户端选项Configure client options

可以在 HubConnectionBuilder 类型上配置客户端选项（在 .NET 和 JavaScript 客户端中提供）。Java 客户端中也提供了此功能，但 HttpHubConnectionBuilder 子类包含生成器配置选项，以及 HubConnection 本身。

配置日志记录Configure logging

使用 ConfigureLogging 方法在 .NET 客户端中配置日志记录。日志提供程序和筛选器的注册方式与服务器上相同。有关详细信息，请参阅ASP.NET Core 文档中的日志记录。

备注

若要注册日志记录提供程序，必须安装所需的包。有关完整列表，请参阅文档的内置日志记录提供程序部分。

例如，若要启用控制台日志记录，请安装 Microsoft.Extensions.Logging.Console NuGet 包。调用 AddConsole 扩展方法：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub")
    .ConfigureLogging(logging => {
        logging.SetMinimumLevel(LogLevel.Information);
        logging.AddConsole();
    })
    .Build();

在 JavaScript 客户端中，存在类似的 configureLogging 方法。提供一个 LogLevel 值，该值指示要生成的日志消息的最小级别。日志将写入浏览器控制台窗口中。

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub")
    .configureLogging(signalR.LogLevel.Information)
    .build();

备注

若要完全禁用日志记录，请在 configureLogging 方法中指定 signalR.LogLevel.None。

有关日志记录的详细信息，请参阅SignalR Diagnostics 文档。

SignalR Java 客户端使用SLF4J库进行日志记录。这是一个高级日志记录 API，它允许库的用户通过引入特定的日志记录依赖项来选择自己的特定日志记录实现。以下代码片段演示了如何在 SignalR Java 客户端中使用 java.util.logging。

implementation 'org.slf4j:slf4j-jdk14:1.7.25'

如果未在依赖项中配置日志记录，SLF4J 将加载默认的非操作记录器，并提供以下警告消息：

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

可以安全地忽略此情况。

配置允许的传输Configure allowed transports

可以在 WithUrl 调用（JavaScript 中的withUrl）中配置 SignalR 使用的传输。HttpTransportType 的值的按位 "或" 可用于将客户端限制为仅使用指定的传输。默认情况下，将启用所有传输。

例如，若要禁用服务器发送的事件传输，但允许 Websocket 和长轮询连接，请执行以下操作：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", HttpTransportType.WebSockets | HttpTransportType.LongPolling)
    .Build();

在 JavaScript 客户端中，通过在提供给 withUrl的 options 对象上设置 transport 字段来配置传输：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", { transport: signalR.HttpTransportType.WebSockets | signalR.HttpTransportType.LongPolling })
    .build();

此版本的 Java 客户端 websocket 是唯一可用的传输。

配置持有者身份验证Configure bearer authentication

若要随 SignalR 请求一起提供身份验证数据，请使用 AccessTokenProvider 选项（JavaScript 中的accessTokenFactory）来指定返回所需访问令牌的函数。在 .NET 客户端中，此访问令牌作为 HTTP "持有者身份验证" 令牌传入（使用 Bearer类型的 Authorization 标头）。在 JavaScript 客户端中，访问令牌用作持有者令牌，但在某些情况下，浏览器 api 限制应用标头的能力（具体而言，在服务器发送事件和 websocket 请求中）。在这些情况下，访问令牌作为查询字符串值提供 access_token。

在 .NET 客户端中，可以使用 WithUrl中的 options 委托指定 AccessTokenProvider 选项：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", options => {
        options.AccessTokenProvider = async () => {
            // Get and return the access token.
        };
    })
    .Build();

在 JavaScript 客户端中，通过在 withUrl中的 options 对象上设置 accessTokenFactory 字段来配置访问令牌：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", {
        accessTokenFactory: () => {
            // Get and return the access token.
            // This function can return a JavaScript Promise if asynchronous
            // logic is required to retrieve the access token.
        }
    })
    .build();

在 SignalR Java 客户端中，可以通过向HttpHubConnectionBuilder提供访问令牌工厂来配置用于身份验证的持有者令牌。使用withAccessTokenFactory提供RxJava单一<字符串 >。如果调用了单延迟，你可以编写逻辑来为客户端生成访问令牌。

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/myhub")
    .withAccessTokenProvider(Single.defer(() -> {
        // Your logic here.
        return Single.just("An Access Token");
    })).build();

配置超时和 keep-alive 选项Configure timeout and keep-alive options

用于配置超时和保持活动状态的其他选项在 HubConnection 对象本身上可用：

• .NET
• JavaScript
• Java

在 .NET 客户端中，超时值指定为 TimeSpan 值。

配置其他选项Configure additional options

可以在 HubConnectionBuilder 上的 WithUrl （JavaScript 中的withUrl）方法中配置其他选项，或在 Java 客户端中 HttpHubConnectionBuilder 上的各种配置 Api 上配置其他选项：

• .NET
• JavaScript
• Java

在 .NET 客户端中，可以通过提供给 WithUrl的 options 委托来修改这些选项：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", options => {
        options.Headers["Foo"] = "Bar";
        options.Cookies.Add(new Cookie(/* ... */);
        options.ClientCertificates.Add(/* ... */);
    })
    .Build();

在 JavaScript 客户端中，可以在提供给 withUrl的 JavaScript 对象中提供这些选项：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", {
        skipNegotiation: true,
        transport: signalR.HttpTransportType.WebSockets
    })
    .build();

在 Java 客户端中，可以通过从 HubConnectionBuilder.create("HUB URL") 返回的 HttpHubConnectionBuilder 中的方法来配置这些选项。

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/myhub")
        .withHeader("Foo", "Bar")
        .shouldSkipNegotiate(true)
        .withHandshakeResponseTimeout(30*1000)
        .build();

其他资源Additional resources

• ASP.NET Core SignalR 入门
• 在 ASP.NET Core 中使用中心 SignalR
• ASP.NET Core SignalR JavaScript 客户端
• .NET 客户端 SignalR ASP.NET Core
• 在 SignalR 中使用 MessagePack 集线器协议 ASP.NET Core
• ASP.NET Core SignalR 支持的平台

JSON/MessagePack 序列化选项JSON/MessagePack serialization options

ASP.NET Core SignalR 支持两个用于编码消息的协议： JSON和MessagePack。每个协议都具有序列化配置选项。

可以使用AddJsonProtocol扩展方法在服务器上配置 JSON 序列化，该方法可在 Startup.ConfigureServices 方法中的AddSignalR之后添加。AddJsonProtocol 方法采用接收 options 对象的委托。该对象的PayloadSerializerSettings属性是可用于配置自变量和返回值的序列化 JsonSerializerSettings 对象的 JSON.NET。有关详细信息，请参阅JSON.NET 文档。

例如，若要将序列化程序配置为使用 "PascalCase" 属性名称，而不是默认的 "camelCase" 名称，请在 Startup.ConfigureServices中使用以下代码：

services.AddSignalR()
    .AddJsonProtocol(options => {
        options.PayloadSerializerSettings.ContractResolver =
            new DefaultContractResolver();
    });

在 .NET 客户端中， HubConnectionBuilder上存在相同的 AddJsonProtocol 扩展方法。必须导入 Microsoft.Extensions.DependencyInjection 命名空间才能解析扩展方法：

// At the top of the file:
using Microsoft.Extensions.DependencyInjection;
// When constructing your connection:
var connection = new HubConnectionBuilder()
    .AddJsonProtocol(options => {
        options.PayloadSerializerSettings.ContractResolver =
            new DefaultContractResolver();
    })
    .Build();

备注

目前不能在 JavaScript 客户端中配置 JSON 序列化。

MessagePack 序列化选项MessagePack serialization options

可以通过向AddMessagePackProtocol调用提供委托来配置 MessagePack 序列化。有关更多详细信息，请参阅SignalR 中的 MessagePack 。

备注

目前不能在 JavaScript 客户端中配置 MessagePack 序列化。

配置服务器选项Configure server options

下表描述了用于配置 SignalR 中心的选项：

可以通过向 Startup.ConfigureServices中的 AddSignalR 调用提供选项委托，为所有中心配置选项。

public void ConfigureServices(IServiceCollection services)
{
    services.AddSignalR(hubOptions =>
    {
        hubOptions.EnableDetailedErrors = true;
        hubOptions.KeepAliveInterval = TimeSpan.FromMinutes(1);
    });
}

单个集线器的选项将覆盖 AddSignalR 中提供的全局选项，并且可以使用 AddHubOptions进行配置：

services.AddSignalR().AddHubOptions<MyHub>(options =>
{
    options.EnableDetailedErrors = true;
});

高级 HTTP 配置选项Advanced HTTP configuration options

使用 HttpConnectionDispatcherOptions 配置与传输和内存缓冲区管理相关的高级设置。可以通过将委托传递到 Startup.Configure中的MapHub<t >来配置这些选项。

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseSignalR((configure) =>
    {
        var desiredTransports =
            HttpTransportType.WebSockets |
            HttpTransportType.LongPolling;
        configure.MapHub<MyHub>("/myhub", (options) =>
        {
            options.Transports = desiredTransports;
        });
    });
}

下表描述了用于配置 ASP.NET Core SignalR 的高级 HTTP 选项的选项：

长轮询传输具有可使用 LongPolling 属性配置的其他选项：

WebSocket 传输具有可使用 WebSockets 属性配置的其他选项：

配置客户端选项Configure client options

可以在 HubConnectionBuilder 类型上配置客户端选项（在 .NET 和 JavaScript 客户端中提供）。Java 客户端中也提供了此功能，但 HttpHubConnectionBuilder 子类包含生成器配置选项，以及 HubConnection 本身。

配置日志记录Configure logging

使用 ConfigureLogging 方法在 .NET 客户端中配置日志记录。日志提供程序和筛选器的注册方式与服务器上相同。有关详细信息，请参阅ASP.NET Core 文档中的日志记录。

备注

若要注册日志记录提供程序，必须安装所需的包。有关完整列表，请参阅文档的内置日志记录提供程序部分。

例如，若要启用控制台日志记录，请安装 Microsoft.Extensions.Logging.Console NuGet 包。调用 AddConsole 扩展方法：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub")
    .ConfigureLogging(logging => {
        logging.SetMinimumLevel(LogLevel.Information);
        logging.AddConsole();
    })
    .Build();

在 JavaScript 客户端中，存在类似的 configureLogging 方法。提供一个 LogLevel 值，该值指示要生成的日志消息的最小级别。日志将写入浏览器控制台窗口中。

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub")
    .configureLogging(signalR.LogLevel.Information)
    .build();

备注

若要完全禁用日志记录，请在 configureLogging 方法中指定 signalR.LogLevel.None。

有关日志记录的详细信息，请参阅SignalR Diagnostics 文档。

SignalR Java 客户端使用SLF4J库进行日志记录。这是一个高级日志记录 API，它允许库的用户通过引入特定的日志记录依赖项来选择自己的特定日志记录实现。以下代码片段演示了如何在 SignalR Java 客户端中使用 java.util.logging。

implementation 'org.slf4j:slf4j-jdk14:1.7.25'

如果未在依赖项中配置日志记录，SLF4J 将加载默认的非操作记录器，并提供以下警告消息：

SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.

可以安全地忽略此情况。

配置允许的传输Configure allowed transports

可以在 WithUrl 调用（JavaScript 中的withUrl）中配置 SignalR 使用的传输。HttpTransportType 的值的按位 "或" 可用于将客户端限制为仅使用指定的传输。默认情况下，将启用所有传输。

例如，若要禁用服务器发送的事件传输，但允许 Websocket 和长轮询连接，请执行以下操作：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", HttpTransportType.WebSockets | HttpTransportType.LongPolling)
    .Build();

在 JavaScript 客户端中，通过在提供给 withUrl的 options 对象上设置 transport 字段来配置传输：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", { transport: signalR.HttpTransportType.WebSockets | signalR.HttpTransportType.LongPolling })
    .build();

配置持有者身份验证Configure bearer authentication

若要随 SignalR 请求一起提供身份验证数据，请使用 AccessTokenProvider 选项（JavaScript 中的accessTokenFactory）来指定返回所需访问令牌的函数。在 .NET 客户端中，此访问令牌作为 HTTP "持有者身份验证" 令牌传入（使用 Bearer类型的 Authorization 标头）。在 JavaScript 客户端中，访问令牌用作持有者令牌，但在某些情况下，浏览器 api 限制应用标头的能力（具体而言，在服务器发送事件和 websocket 请求中）。在这些情况下，访问令牌作为查询字符串值提供 access_token。

在 .NET 客户端中，可以使用 WithUrl中的 options 委托指定 AccessTokenProvider 选项：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", options => {
        options.AccessTokenProvider = async () => {
            // Get and return the access token.
        };
    })
    .Build();

在 JavaScript 客户端中，通过在 withUrl中的 options 对象上设置 accessTokenFactory 字段来配置访问令牌：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", {
        accessTokenFactory: () => {
            // Get and return the access token.
            // This function can return a JavaScript Promise if asynchronous
            // logic is required to retrieve the access token.
        }
    })
    .build();

在 SignalR Java 客户端中，可以通过向HttpHubConnectionBuilder提供访问令牌工厂来配置用于身份验证的持有者令牌。使用withAccessTokenFactory提供RxJava单一<字符串 >。如果调用了单延迟，你可以编写逻辑来为客户端生成访问令牌。

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/myhub")
    .withAccessTokenProvider(Single.defer(() -> {
        // Your logic here.
        return Single.just("An Access Token");
    })).build();

配置超时和 keep-alive 选项Configure timeout and keep-alive options

用于配置超时和保持活动状态的其他选项在 HubConnection 对象本身上可用：

• .NET
• JavaScript
• Java

在 .NET 客户端中，超时值指定为 TimeSpan 值。

配置其他选项Configure additional options

可以在 HubConnectionBuilder 上的 WithUrl （JavaScript 中的withUrl）方法中配置其他选项，或在 Java 客户端中 HttpHubConnectionBuilder 上的各种配置 Api 上配置其他选项：

• .NET
• JavaScript
• Java

在 .NET 客户端中，可以通过提供给 WithUrl的 options 委托来修改这些选项：

var connection = new HubConnectionBuilder()
    .WithUrl("https://example.com/myhub", options => {
        options.Headers["Foo"] = "Bar";
        options.Cookies.Add(new Cookie(/* ... */);
        options.ClientCertificates.Add(/* ... */);
    })
    .Build();

在 JavaScript 客户端中，可以在提供给 withUrl的 JavaScript 对象中提供这些选项：

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/myhub", {
        skipNegotiation: true,
        transport: signalR.HttpTransportType.WebSockets
    })
    .build();

在 Java 客户端中，可以通过从 HubConnectionBuilder.create("HUB URL") 返回的 HttpHubConnectionBuilder 中的方法来配置这些选项。

HubConnection hubConnection = HubConnectionBuilder.create("https://example.com/myhub")
        .withHeader("Foo", "Bar")
        .shouldSkipNegotiate(true)
        .withHandshakeResponseTimeout(30*1000)
        .build();

其他资源Additional resources

• ASP.NET Core SignalR 入门
• 在 ASP.NET Core 中使用中心 SignalR
• ASP.NET Core SignalR JavaScript 客户端
• .NET 客户端 SignalR ASP.NET Core
• 在 SignalR 中使用 MessagePack 集线器协议 ASP.NET Core
• ASP.NET Core SignalR 支持的平台