Конфигурация SignalR ASP.NET Core

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

На сервере можно настроить сериализацию JSON с помощью метода расширения AddJsonProtocol. AddJsonProtocol можно добавить после AddSignalR в Startup.ConfigureServices. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerOptions этого объекта — это System.Text.JsonJsonSerializerOptions объект, который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации System.Text.Json.

Например, чтобы настроить сериализатор так, чтобы не изменять регистр имен свойств, вместо использования имен в стиле camelCase по умолчанию, используйте следующий код в Program.cs:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Переключитесь на Newtonsoft.Json

Если вам нужны функции Newtonsoft.Json , которые не поддерживаются System.Text.Json, см. раздел "Переключиться на Newtonsoft.Json".

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Program.cs.

 builder.Services.AddSignalR(hubOptions =>
 {
     hubOptions.EnableDetailedErrors = true;
     hubOptions.KeepAliveInterval = TimeSpan.FromMinutes(1);
 });

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

builder.Services.AddSignalR().AddHubOptions<ChatHub>(options =>
{
    options.EnableDetailedErrors = true;
});

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Program.cs.

using Microsoft.AspNetCore.Http.Connections;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddSignalR();

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();
app.MapHub<ChatHub>("/chathub", options =>
{
    options.Transports =
        HttpTransportType.WebSockets |
        HttpTransportType.LongPolling;
}
);
app.Run();

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Вместо значения LogLevel можно указать также string значение, представляющее уровень журналирования. Это полезно при настройке SignalR ведения журнала в средах, где отсутствует доступ к LogLevel константам.

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

В следующей таблице перечислены доступные уровни журнала. Указанное значение задает configureLoggingминимальный уровень логирования, который будет зафиксирован. Сообщения, зарегистрированные на этом уровне , или уровни, перечисленные после него в таблице, будут записаны в журнал.

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

В этой версии клиента Java WebSockets является единственным доступным транспортом.

В клиенте Java транспорт выбирается методом withTransport на HttpHubConnectionBuilder. Клиент Java по умолчанию использует транспорт WebSockets.

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

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и режима поддержания активного соединения.

var builder = new HubConnectionBuilder()
    .WithUrl(Navigation.ToAbsoluteUri("/chathub"))
    .WithServerTimeout(TimeSpan.FromSeconds(60))
    .WithKeepAliveInterval(TimeSpan.FromSeconds(30))
    .Build();

builder.On<string, string>("ReceiveMessage", (user, message) => ...

await builder.StartAsync();

var connection = new signalR.HubConnectionBuilder()
  .withUrl("/chatHub")
  .withServerTimeout(60000)
  .withKeepAliveInterval(30000)
  .build();

Настройка повторного подключения с отслеживанием состояния

SignalR Подключение с сохранением состояния уменьшает воспринимаемое время простоя клиентов, имеющих временное отключение в сетевом подключении, например, при переключении сетевых подключений или временной потере доступа.

Для достижения этого используется осознанное повторное подключение:

• Временное буферирование данных на сервере и клиенте.
• Подтверждение полученных сообщений (ACK-ing) как сервером, так и клиентом.
• Обнаружение восстановления подключения и повторная передача сообщений, которые могли быть отправлены во время его отсутствия.

Повторное подключение с отслеживанием состояния доступно в ASP.NET Core 8.0 и новее.

Войдите на повторное подключение с отслеживанием состояния как в конечной точке концентратора сервера, так и в клиенте:

• Обновите конфигурацию конечной точки концентратора сервера, чтобы включить AllowStatefulReconnects параметр.

  app.MapHub<MyHub>("/hubName", options =>
  {
      options.AllowStatefulReconnects = true;
  });
  

  При необходимости максимальный размер буфера в байтах, разрешенных сервером, можно задать глобально или для определенного концентратора с параметром StatefulReconnectBufferSize :

  Глобальный StatefulReconnectBufferSize набор параметров:

  builder.AddSignalR(o => o.StatefulReconnectBufferSize = 1000);
  

  Набор StatefulReconnectBufferSize параметров для определенного концентратора:

  builder.AddSignalR().AddHubOptions<MyHub>(o => o.StatefulReconnectBufferSize = 1000);
  

  Этот StatefulReconnectBufferSize параметр является необязательным с значением по умолчанию 100 000 байт.

• Обновите клиентский withStatefulReconnect код JavaScript или TypeScript, чтобы включить этот параметр:

  const builder = new signalR.HubConnectionBuilder()
    .withUrl("/hubname")
    .withStatefulReconnect({ bufferSize: 1000 });  // Optional, defaults to 100,000
  const connection = builder.build();
  

  Этот bufferSize параметр является необязательным с значением по умолчанию 100 000 байт.

• Обновите код .NET клиента, чтобы включить параметр WithStatefulReconnect.

    var builder = new HubConnectionBuilder()
        .WithUrl("<hub url>")
        .WithStatefulReconnect();
    builder.Services.Configure<HubConnectionOptions>(o => o.StatefulReconnectBufferSize = 1000);
    var hubConnection = builder.Build();
  

  Этот StatefulReconnectBufferSize параметр является необязательным с значением по умолчанию 100 000 байт.

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        // "Foo: Bar" will not be sent with WebSockets or Server-Sent Events requests
        headers: { "Foo": "Bar" },
        transport: signalR.HttpTransportType.LongPolling 
    })
    .build();

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

Сериализация JSON может быть конфигурирована на сервере с помощью метода расширения AddJsonProtocol, который можно добавить после AddSignalR в вашем методе Startup.ConfigureServices. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerSettings этого объекта является объектом Json.NET JsonSerializerSettings , который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации по Json.NET.

Например, чтобы настроить сериализатор для использования имен свойств PascalCase, а не имен вариантов верблюжих по умолчанию, используйте следующий код в Startup.ConfigureServices:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Startup.ConfigureServices.

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

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

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

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Startup.Configure.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseSignalR((configure) =>
    {
        var desiredTransports =
            HttpTransportType.WebSockets |
            HttpTransportType.LongPolling;

        configure.MapHub<ChatHub>("/chathub", (options) =>
        {
            options.Transports = desiredTransports;
        });
    });
}

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и поддержания активности доступны в самом объекте HubConnection :

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

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

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

Сериализация JSON может быть конфигурирована на сервере с помощью метода расширения AddJsonProtocol, который можно добавить после AddSignalR в вашем методе Startup.ConfigureServices. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerSettings этого объекта является объектом Json.NET JsonSerializerSettings , который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации по Json.NET.

Например, чтобы настроить сериализатор для использования имен свойств PascalCase, а не имен вариантов верблюжих по умолчанию, используйте следующий код в Startup.ConfigureServices:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Startup.ConfigureServices.

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

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

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

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Startup.Configure.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseSignalR((configure) =>
    {
        var desiredTransports =
            HttpTransportType.WebSockets |
            HttpTransportType.LongPolling;

        configure.MapHub<ChatHub>("/chathub", (options) =>
        {
            options.Transports = desiredTransports;
        });
    });
}

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

В этой версии клиента Java WebSockets является единственным доступным транспортом.

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и поддержания активности доступны в самом объекте HubConnection :

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

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

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

На сервере можно настроить сериализацию JSON с помощью метода расширения AddJsonProtocol. AddJsonProtocol можно добавить после AddSignalR в Startup.ConfigureServices. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerOptions этого объекта — это System.Text.JsonJsonSerializerOptions объект, который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации System.Text.Json.

Например, чтобы настроить сериализатор так, чтобы не изменять регистр имен свойств, вместо использования имен в стиле camelCase по умолчанию, используйте следующий код в Startup.ConfigureServices:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Переключитесь на Newtonsoft.Json

Если вам нужны функции Newtonsoft.Json , которые не поддерживаются System.Text.Json, см. раздел "Переключиться на Newtonsoft.Json".

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Startup.ConfigureServices.

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

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

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

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Startup.Configure.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapHub<ChatHub>("/chathub", options =>
        {
            options.Transports =
                HttpTransportType.WebSockets |
                HttpTransportType.LongPolling;
        });
    });
}

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Вместо значения LogLevel можно указать также string значение, представляющее уровень журналирования. Это полезно при настройке SignalR ведения журнала в средах, где отсутствует доступ к LogLevel константам.

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

В следующей таблице перечислены доступные уровни журнала. Указанное значение задает configureLoggingминимальный уровень логирования, который будет зафиксирован. Сообщения, зарегистрированные на этом уровне , или уровни, перечисленные после него в таблице, будут записаны в журнал.

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

В этой версии клиента Java WebSockets является единственным доступным транспортом.

В клиенте Java транспорт выбирается методом withTransport на HttpHubConnectionBuilder. Клиент Java по умолчанию использует транспорт WebSockets.

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

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и поддержания активности доступны в самом объекте HubConnection :

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

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

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

На сервере можно настроить сериализацию JSON с помощью метода расширения AddJsonProtocol. AddJsonProtocol можно добавить после AddSignalR в Startup.ConfigureServices. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerOptions этого объекта — это System.Text.JsonJsonSerializerOptions объект, который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации System.Text.Json.

Например, чтобы настроить сериализатор так, чтобы не изменять регистр имен свойств, вместо использования имен в стиле camelCase по умолчанию, используйте следующий код в Startup.ConfigureServices:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Переключитесь на Newtonsoft.Json

Если вам нужны функции Newtonsoft.Json , которые не поддерживаются System.Text.Json, см. раздел "Переключиться на Newtonsoft.Json".

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Startup.ConfigureServices.

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

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

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

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Startup.Configure.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapHub<ChatHub>("/chathub", options =>
        {
            options.Transports =
                HttpTransportType.WebSockets |
                HttpTransportType.LongPolling;
        });
    });
}

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Вместо значения LogLevel можно указать также string значение, представляющее уровень журналирования. Это полезно при настройке SignalR ведения журнала в средах, где отсутствует доступ к LogLevel константам.

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

В следующей таблице перечислены доступные уровни журнала. Указанное значение задает configureLoggingминимальный уровень логирования, который будет зафиксирован. Сообщения, зарегистрированные на этом уровне , или уровни, перечисленные после него в таблице, будут записаны в журнал.

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

В этой версии клиента Java WebSockets является единственным доступным транспортом.

В клиенте Java транспорт выбирается методом withTransport на HttpHubConnectionBuilder. Клиент Java по умолчанию использует транспорт WebSockets.

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

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и поддержания активности доступны в самом объекте HubConnection :

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

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

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

На сервере можно настроить сериализацию JSON с помощью метода расширения AddJsonProtocol. AddJsonProtocol можно добавить после AddSignalR в Startup.ConfigureServices. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerOptions этого объекта — это System.Text.JsonJsonSerializerOptions объект, который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации System.Text.Json.

Например, чтобы настроить сериализатор так, чтобы не изменять регистр имен свойств, вместо использования имен в стиле camelCase по умолчанию, используйте следующий код в Startup.ConfigureServices:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Переключитесь на Newtonsoft.Json

Если вам нужны функции Newtonsoft.Json , которые не поддерживаются System.Text.Json, см. раздел "Переключиться на Newtonsoft.Json".

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Startup.ConfigureServices.

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

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

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

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Startup.Configure.

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    app.UseRouting();

    app.UseEndpoints(endpoints =>
    {
        endpoints.MapHub<ChatHub>("/chathub", options =>
        {
            options.Transports =
                HttpTransportType.WebSockets |
                HttpTransportType.LongPolling;
        });
    });
}

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Вместо значения LogLevel можно указать также string значение, представляющее уровень журналирования. Это полезно при настройке SignalR ведения журнала в средах, где отсутствует доступ к LogLevel константам.

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

В следующей таблице перечислены доступные уровни журнала. Указанное значение задает configureLoggingминимальный уровень логирования, который будет зафиксирован. Сообщения, зарегистрированные на этом уровне , или уровни, перечисленные после него в таблице, будут записаны в журнал.

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

В этой версии клиента Java WebSockets является единственным доступным транспортом.

В клиенте Java транспорт выбирается методом withTransport на HttpHubConnectionBuilder. Клиент Java по умолчанию использует транспорт WebSockets.

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

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и поддержания активности доступны в самом объекте HubConnection :

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        // "Foo: Bar" will not be sent with WebSockets or Server-Sent Events requests
        headers: { "Foo": "Bar" },
        transport: signalR.HttpTransportType.LongPolling 
    })
    .build();

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

На сервере можно настроить сериализацию JSON с помощью метода расширения AddJsonProtocol. AddJsonProtocol можно добавить после AddSignalR в Program.cs. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerOptions этого объекта — это System.Text.JsonJsonSerializerOptions объект, который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации System.Text.Json.

Например, чтобы настроить сериализатор так, чтобы не изменять регистр имен свойств, вместо использования имен в стиле camelCase по умолчанию, используйте следующий код в Program.cs:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Переключитесь на Newtonsoft.Json

Если вам нужны функции Newtonsoft.Json , которые не поддерживаются System.Text.Json, см. раздел "Переключиться на Newtonsoft.Json".

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Program.cs.

builder.Services.AddSignalR(hubOptions =>
{
    hubOptions.EnableDetailedErrors = true;
    hubOptions.KeepAliveInterval = TimeSpan.FromMinutes(1);
});

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

builder.Services.AddSignalR().AddHubOptions<ChatHub>(options =>
{
    options.EnableDetailedErrors = true;
});

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Program.cs.

using Microsoft.AspNetCore.Http.Connections;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddSignalR();

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();
app.MapHub<ChatHub>("/chathub", options =>
{
    options.Transports =
        HttpTransportType.WebSockets |
        HttpTransportType.LongPolling;
}
);
app.Run();

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Вместо значения LogLevel можно указать также string значение, представляющее уровень журналирования. Это полезно при настройке SignalR ведения журнала в средах, где отсутствует доступ к LogLevel константам.

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

В следующей таблице перечислены доступные уровни журнала. Указанное значение задает configureLoggingминимальный уровень логирования, который будет зафиксирован. Сообщения, зарегистрированные на этом уровне , или уровни, перечисленные после него в таблице, будут записаны в журнал.

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

В этой версии клиента Java WebSockets является единственным доступным транспортом.

В клиенте Java транспорт выбирается методом withTransport на HttpHubConnectionBuilder. Клиент Java по умолчанию использует транспорт WebSockets.

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

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и поддержания активности доступны в самом объекте HubConnection :

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        // "Foo: Bar" will not be sent with WebSockets or Server-Sent Events requests
        headers: { "Foo": "Bar" },
        transport: signalR.HttpTransportType.LongPolling 
    })
    .build();

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR

Параметры сериализации JSON/MessagePack

ASP.NET Core SignalR поддерживает два протокола для кодирования сообщений: JSON и MessagePack. Каждый протокол имеет параметры конфигурации сериализации.

На сервере можно настроить сериализацию JSON с помощью метода расширения AddJsonProtocol. AddJsonProtocol можно добавить после AddSignalR в Startup.ConfigureServices. Метод AddJsonProtocol принимает делегат, который получает объект options. Свойство PayloadSerializerOptions этого объекта — это System.Text.JsonJsonSerializerOptions объект, который можно использовать для настройки сериализации аргументов и возвращаемых значений. Дополнительные сведения см. в документации System.Text.Json.

Например, чтобы настроить сериализатор так, чтобы не изменять регистр имен свойств, вместо использования имен в стиле camelCase по умолчанию, используйте следующий код в Program.cs:

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

В клиенте .NET тот же метод расширения AddJsonProtocol существует на HubConnectionBuilder. Необходимо импортировать пространство имен 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();

Переключитесь на Newtonsoft.Json

Если вам нужны функции Newtonsoft.Json , которые не поддерживаются System.Text.Json, см. раздел "Переключиться на Newtonsoft.Json".

Параметры сериализации MessagePack

Настроить сериализацию MessagePack можно, предоставив делегат вызову AddMessagePackProtocol. Дополнительные сведения см. в SignalRразделе MessagePack.

Настройка параметров сервера

В следующей таблице описаны опции настройки SignalR хабов.

Параметры можно настроить для всех центров, предоставив делегат параметров AddSignalR при вызове Program.cs.

 builder.Services.AddSignalR(hubOptions =>
 {
     hubOptions.EnableDetailedErrors = true;
     hubOptions.KeepAliveInterval = TimeSpan.FromMinutes(1);
 });

Параметры для одного узла переопределяют глобальные параметры, предоставляемые в AddSignalR, и могут быть настроены с помощью AddHubOptions.

builder.Services.AddSignalR().AddHubOptions<ChatHub>(options =>
{
    options.EnableDetailedErrors = true;
});

Дополнительные параметры конфигурации HTTP

Используйте HttpConnectionDispatcherOptions для настройки расширенных параметров, связанных с транспортировкой и управлением буфером памяти. Эти параметры настраиваются путем передачи делегата MapHub в Program.cs.

using Microsoft.AspNetCore.Http.Connections;

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddRazorPages();
builder.Services.AddSignalR();

var app = builder.Build();

if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error");
    app.UseHsts();
}

app.UseHttpsRedirection();
app.UseStaticFiles();

app.UseRouting();

app.UseAuthorization();

app.MapRazorPages();
app.MapHub<ChatHub>("/chathub", options =>
{
    options.Transports =
        HttpTransportType.WebSockets |
        HttpTransportType.LongPolling;
}
);
app.Run();

В следующей таблице описаны параметры настройки расширенных параметров HTTP ASP.NET Core SignalR:

Дополнительные параметры транспорта Long Polling могут быть настроены с использованием свойства LongPolling.

Транспорт WebSocket имеет дополнительные параметры, которые можно настроить с помощью WebSockets свойства:

Настройка параметров клиента

Параметры клиента можно настроить для HubConnectionBuilder типа (доступные в клиентах .NET и JavaScript). Он также доступен в клиенте Java, но подкласс HttpHubConnectionBuilder содержит параметры конфигурации построителя, а также сам HubConnection.

Настройка логирования

Логирование настраивается в клиенте .NET с помощью метода ConfigureLogging. Поставщики и фильтры журналирования могут быть зарегистрированы так же, как на сервере. Дополнительные сведения см. в документации по ведению журналов в ASP.NET Core.

Например, чтобы включить ведение журнала консоли, установите Microsoft.Extensions.Logging.Console пакет NuGet. Вызовите метод расширения AddConsole.

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

В клиенте JavaScript существует аналогичный configureLogging метод. Укажите значение минимального уровня сообщений журнала LogLevel, который требуется. Журналы записываются в окно консоли браузера.

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

Вместо значения LogLevel можно указать также string значение, представляющее уровень журналирования. Это полезно при настройке SignalR ведения журнала в средах, где отсутствует доступ к LogLevel константам.

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

В следующей таблице перечислены доступные уровни журнала. Указанное значение задает configureLoggingминимальный уровень логирования, который будет зафиксирован. Сообщения, зарегистрированные на этом уровне , или уровни, перечисленные после него в таблице, будут записаны в журнал.

Дополнительные сведения о ведении журнала см. в документации по диагностикеSignalR.

Клиент SignalR Java использует библиотеку SLF4J для ведения журнала. Это высокоуровневый API ведения журнала, позволяющий пользователям библиотеки выбрать собственную реализацию ведения журнала, введя определенную зависимость ведения журнала. В следующем фрагменте кода показано, как использовать java.util.logging его с клиентом SignalR Java.

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.

Это предупреждение можно игнорировать.

Настройка разрешенных транспортов

Транспорты, используемые SignalR, можно настроить в вызове WithUrl (withUrl в JavaScript). Побитовое ИЛИ-операция значения HttpTransportType может быть использована для ограничения клиента в использовании только указанных средств передачи данных. Все транспорты включены по умолчанию.

Например, чтобы отключить транспорт событий Server-Sent, но разрешить подключения WebSockets и Long Polling:

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

В клиенте JavaScript транспорты настраиваются путем задания transport поля в объекте параметров, предоставленном withUrl.

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

В этой версии клиента Java WebSockets является единственным доступным транспортом.

В клиенте Java транспорт выбирается методом withTransport на HttpHubConnectionBuilder. Клиент Java по умолчанию использует транспорт WebSockets.

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

Настройка проверки подлинности носителя

Чтобы предоставить данные проверки подлинности вместе с SignalR запросами, используйте AccessTokenProvider параметр (accessTokenFactory в JavaScript), чтобы указать функцию, которая возвращает требуемый маркер доступа. В клиенте .NET этот токен доступа передается как HTTP токен "Bearer Authentication" (используя заголовок Authorization с типом Bearer). В клиенте JavaScript токен доступа используется как Bearer token, за исключением нескольких случаев, когда API браузера ограничивают возможность применения заголовков (в частности, в запросах Server-Sent Events и WebSockets). В таких случаях маркер доступа предоставляется как строковое значение access_tokenзапроса.

В клиенте .NET параметр AccessTokenProvider можно указать с помощью делегата параметров в WithUrl.

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

В клиенте JavaScript маркер доступа настраивается путем задания accessTokenFactory поля в объекте параметров в withUrl:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        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. Используйте . При вызове Single.defer можно написать логику для создания маркеров доступа для клиента.

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

Настройте параметры времени ожидания и режим поддержания соединения

Дополнительные параметры настройки времени ожидания и поддержания активности доступны в самом объекте HubConnection :

Настройка дополнительных параметров

Дополнительные параметры можно настроить в методе WithUrl (withUrl в JavaScript) на HubConnectionBuilder, либо с помощью различных API конфигурации на HttpHubConnectionBuilder в клиенте Java.

В клиенте .NET эти параметры можно изменить делегатом параметров, предоставленным WithUrlследующим образом:

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

В клиенте JavaScript эти параметры можно указать в объекте JavaScript, предоставленном withUrlследующим образом:

let connection = new signalR.HubConnectionBuilder()
    .withUrl("/chathub", {
        // "Foo: Bar" will not be sent with WebSockets or Server-Sent Events requests
        headers: { "Foo": "Bar" },
        transport: signalR.HttpTransportType.LongPolling 
    })
    .build();

В клиенте Java эти параметры можно настроить с помощью методов, HttpHubConnectionBuilder возвращаемых из HubConnectionBuilder.create("HUB URL")

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

Дополнительные ресурсы

• Начало работы с ASP.NET Core SignalR
• Использование концентраторов в ASP.NET Core SignalR
• Клиент JavaScript SignalR ASP.NET Core
• клиент ASP.NET Core SignalR .NET
• Использование протокола MessagePack Hub для SignalR ASP.NET Core
• Поддерживаемые платформы ASP.NET Core SignalR