ASP.NET Core SignalR 구성

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

AddJsonProtocol 확장 메서드를 사용하여 JSON serialization을 서버에서 구성할 수 있습니다. AddJsonProtocol에서 AddSignalR 뒤에 Startup.ConfigureServices를 추가할 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerOptions 해당 개체의 속성은 인수의 serialization을 구성하고 값을 반환하는 데 사용할 수 있는 개체입니다System.Text.JsonJsonSerializerOptions. 자세한 내용은 System.Text.Json 설명서를 참조하세요.

예를 들어, 속성 이름의 대소문자를 기본 카멜 표기법 대신 변경하지 않도록 직렬 변환기를 구성하려면 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로 전환Newtonsoft.Json을 참조하세요.

MessagePack 직렬화 옵션

MessagePack serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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();

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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 로깅을 구성할 때 유용합니다.

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

다음 표에서는 사용 가능한 로그 수준을 나열합니다. 기록될 configureLogging 로그 수준을 설정하기 위해 제공하는 값입니다. 이 수준에서 기록된 메시지 또는 테이블에 나열된 수준이 기록됩니다.

로깅에 대한 자세한 내용은 진단 설명서를 참조SignalR하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. 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)를 승인합니다.
• 연결이 종료된 시점을 인식하고 연결이 중단된 동안 전송되었을 수 있는 메시지를 재생합니다.

상태 저장 재연결 기능은 .NET 8 이상에서 사용할 수 있습니다.

서버 허브 엔드포인트와 클라이언트 모두에서 상태 저장 다시 연결에 옵트인합니다.

• 다음 옵션을 사용하도록 서버 허브 엔드포인트 구성을 업데이트합니다.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바이트인 선택 사항입니다.

• JavaScript 또는 TypeScript 클라이언트 코드를 업데이트하여 옵션을 사용하도록 설정합니다.withStatefulReconnect

  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바이트인 선택 사항입니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

서버에서 JSON serialization은 AddJsonProtocol 확장 메서드를 사용하여 구성할 수 있으며, 이 메서드는 AddSignalR 메서드에 Startup.ConfigureServices 뒤에 추가될 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerSettings 해당 개체의 속성은 인수 및 반환 값의 serialization을 구성하는 데 사용할 수 있는 Json.NET JsonSerializerSettings 개체입니다. 자세한 내용은 Json.NET 설명서를 참조하세요.

예를 들어 기본적으로 "카멜 표기법" 이름 대신 "PascalCase" 속성 이름을 사용하도록 serializer를 구성하려면 다음 코드 블록에 을 사용하십시오.

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 serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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;
        });
    });
}

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. Single.defer를 호출하면 클라이언트에 대한 액세스 토큰을 생성하는 논리를 작성할 수 있습니다.

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

시간 제한 및 연결 유지 옵션 구성

시간 제한 및 유지 동작을 구성하는 추가 옵션은 HubConnection 개체 자체에서 사용할 수 있습니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

서버에서 JSON serialization은 AddJsonProtocol 확장 메서드를 사용하여 구성할 수 있으며, 이 메서드는 AddSignalR 메서드에 Startup.ConfigureServices 뒤에 추가될 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerSettings 해당 개체의 속성은 인수 및 반환 값의 serialization을 구성하는 데 사용할 수 있는 Json.NET JsonSerializerSettings 개체입니다. 자세한 내용은 Json.NET 설명서를 참조하세요.

예를 들어 기본적으로 "카멜 표기법" 이름 대신 "PascalCase" 속성 이름을 사용하도록 serializer를 구성하려면 다음 코드 블록에 을 사용하십시오.

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 serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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;
        });
    });
}

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. Single.defer를 호출하면 클라이언트에 대한 액세스 토큰을 생성하는 논리를 작성할 수 있습니다.

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

시간 제한 및 연결 유지 옵션 구성

시간 제한 및 유지 동작을 구성하는 추가 옵션은 HubConnection 개체 자체에서 사용할 수 있습니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

AddJsonProtocol 확장 메서드를 사용하여 JSON serialization을 서버에서 구성할 수 있습니다. AddJsonProtocol에서 AddSignalR 뒤에 Startup.ConfigureServices를 추가할 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerOptions 해당 개체의 속성은 인수의 serialization을 구성하고 값을 반환하는 데 사용할 수 있는 개체입니다System.Text.JsonJsonSerializerOptions. 자세한 내용은 System.Text.Json 설명서를 참조하세요.

예를 들어, 속성 이름의 대소문자를 기본 카멜 표기법 대신 변경하지 않도록 직렬 변환기를 구성하려면 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로 전환Newtonsoft.Json을 참조하세요.

MessagePack 직렬화 옵션

MessagePack serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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;
        });
    });
}

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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 로깅을 구성할 때 유용합니다.

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

다음 표에서는 사용 가능한 로그 수준을 나열합니다. 기록될 configureLogging 로그 수준을 설정하기 위해 제공하는 값입니다. 이 수준에서 기록된 메시지 또는 테이블에 나열된 수준이 기록됩니다.

로깅에 대한 자세한 내용은 진단 설명서를 참조SignalR하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. Single.defer를 호출하면 클라이언트에 대한 액세스 토큰을 생성하는 논리를 작성할 수 있습니다.

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

시간 제한 및 연결 유지 옵션 구성

시간 제한 및 유지 동작을 구성하는 추가 옵션은 HubConnection 개체 자체에서 사용할 수 있습니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

AddJsonProtocol 확장 메서드를 사용하여 JSON serialization을 서버에서 구성할 수 있습니다. AddJsonProtocol에서 AddSignalR 뒤에 Startup.ConfigureServices를 추가할 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerOptions 해당 개체의 속성은 인수의 serialization을 구성하고 값을 반환하는 데 사용할 수 있는 개체입니다System.Text.JsonJsonSerializerOptions. 자세한 내용은 System.Text.Json 설명서를 참조하세요.

예를 들어, 속성 이름의 대소문자를 기본 카멜 표기법 대신 변경하지 않도록 직렬 변환기를 구성하려면 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로 전환Newtonsoft.Json을 참조하세요.

MessagePack 직렬화 옵션

MessagePack serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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;
        });
    });
}

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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 로깅을 구성할 때 유용합니다.

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

다음 표에서는 사용 가능한 로그 수준을 나열합니다. 기록될 configureLogging 로그 수준을 설정하기 위해 제공하는 값입니다. 이 수준에서 기록된 메시지 또는 테이블에 나열된 수준이 기록됩니다.

로깅에 대한 자세한 내용은 진단 설명서를 참조SignalR하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. Single.defer를 호출하면 클라이언트에 대한 액세스 토큰을 생성하는 논리를 작성할 수 있습니다.

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

시간 제한 및 연결 유지 옵션 구성

시간 제한 및 유지 동작을 구성하는 추가 옵션은 HubConnection 개체 자체에서 사용할 수 있습니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

AddJsonProtocol 확장 메서드를 사용하여 JSON serialization을 서버에서 구성할 수 있습니다. AddJsonProtocol에서 AddSignalR 뒤에 Startup.ConfigureServices를 추가할 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerOptions 해당 개체의 속성은 인수의 serialization을 구성하고 값을 반환하는 데 사용할 수 있는 개체입니다System.Text.JsonJsonSerializerOptions. 자세한 내용은 System.Text.Json 설명서를 참조하세요.

예를 들어, 속성 이름의 대소문자를 기본 카멜 표기법 대신 변경하지 않도록 직렬 변환기를 구성하려면 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로 전환Newtonsoft.Json을 참조하세요.

MessagePack 직렬화 옵션

MessagePack serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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;
        });
    });
}

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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 로깅을 구성할 때 유용합니다.

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

다음 표에서는 사용 가능한 로그 수준을 나열합니다. 기록될 configureLogging 로그 수준을 설정하기 위해 제공하는 값입니다. 이 수준에서 기록된 메시지 또는 테이블에 나열된 수준이 기록됩니다.

로깅에 대한 자세한 내용은 진단 설명서를 참조SignalR하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. Single.defer를 호출하면 클라이언트에 대한 액세스 토큰을 생성하는 논리를 작성할 수 있습니다.

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

시간 제한 및 연결 유지 옵션 구성

시간 제한 및 유지 동작을 구성하는 추가 옵션은 HubConnection 개체 자체에서 사용할 수 있습니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

AddJsonProtocol 확장 메서드를 사용하여 JSON serialization을 서버에서 구성할 수 있습니다. AddJsonProtocol에서 AddSignalR 뒤에 Program.cs를 추가할 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerOptions 해당 개체의 속성은 인수의 serialization을 구성하고 값을 반환하는 데 사용할 수 있는 개체입니다System.Text.JsonJsonSerializerOptions. 자세한 내용은 System.Text.Json 설명서를 참조하세요.

예를 들어, 속성 이름의 대소문자를 기본 카멜 표기법 대신 변경하지 않도록 직렬 변환기를 구성하려면 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로 전환Newtonsoft.Json을 참조하세요.

MessagePack 직렬화 옵션

MessagePack serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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();

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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 로깅을 구성할 때 유용합니다.

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

다음 표에서는 사용 가능한 로그 수준을 나열합니다. 기록될 configureLogging 로그 수준을 설정하기 위해 제공하는 값입니다. 이 수준에서 기록된 메시지 또는 테이블에 나열된 수준이 기록됩니다.

로깅에 대한 자세한 내용은 진단 설명서를 참조SignalR하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. Single.defer를 호출하면 클라이언트에 대한 액세스 토큰을 생성하는 논리를 작성할 수 있습니다.

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

시간 제한 및 연결 유지 옵션 구성

시간 제한 및 유지 동작을 구성하는 추가 옵션은 HubConnection 개체 자체에서 사용할 수 있습니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼

JSON/MessagePack 직렬화 옵션들

ASP.NET Core SignalR 는 메시지를 인코딩하기 위한 두 가지 프로토콜인 JSON 및 MessagePack을 지원합니다. 각 프로토콜에는 serialization 구성 옵션이 있습니다.

AddJsonProtocol 확장 메서드를 사용하여 JSON serialization을 서버에서 구성할 수 있습니다. AddJsonProtocol에서 AddSignalR 뒤에 Startup.ConfigureServices를 추가할 수 있습니다. 메서드는 AddJsonProtocol 개체를 받는 대리자를 options 사용합니다. PayloadSerializerOptions 해당 개체의 속성은 인수의 serialization을 구성하고 값을 반환하는 데 사용할 수 있는 개체입니다System.Text.JsonJsonSerializerOptions. 자세한 내용은 System.Text.Json 설명서를 참조하세요.

예를 들어, 속성 이름의 대소문자를 기본 카멜 표기법 대신 변경하지 않도록 직렬 변환기를 구성하려면 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로 전환Newtonsoft.Json을 참조하세요.

MessagePack 직렬화 옵션

MessagePack serialization은 AddMessagePackProtocol 호출에 델리게이트를 제공하여 구성할 수 있습니다. 자세한 내용은 MessagePack in을 SignalR 참조하세요.

서버 옵션 구성

다음 표에서는 허브를 구성하는 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();

다음 표에서는 ASP.NET Core SignalR의 고급 HTTP 옵션을 구성하는 옵션에 대해 설명합니다.

긴 폴링 전송에는 LongPolling 속성을 사용하여 구성할 수 있는 추가 옵션이 있습니다.

WebSocket 전송에는 속성을 사용하여 WebSockets 구성할 수 있는 추가 옵션이 있습니다.

클라이언트 옵션 구성

클라이언트 옵션은 형식( HubConnectionBuilder .NET 및 JavaScript 클라이언트에서 사용 가능)에서 구성할 수 있습니다. Java 클라이언트에서도 사용할 수 있지만, 작성기 구성 옵션은 HttpHubConnectionBuilder 서브클래스에 포함되어 있으며, HubConnection 자체에도 포함되어 있습니다.

로깅 구성

로깅은 .NET 클라이언트에서 ConfigureLogging 메서드를 사용하여 구성됩니다. 로깅 공급자 및 필터는 서버에 있는 것과 동일한 방식으로 등록할 수 있습니다. 자세한 내용은 ASP.NET Core의 로깅 설명서를 참조하세요.

예를 들어 콘솔 로깅을 사용하도록 설정하려면 NuGet 패키지를 설치 Microsoft.Extensions.Logging.Console 합니다. 확장 메서드를 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 로깅을 구성할 때 유용합니다.

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

다음 표에서는 사용 가능한 로그 수준을 나열합니다. 기록될 configureLogging 로그 수준을 설정하기 위해 제공하는 값입니다. 이 수준에서 기록된 메시지 또는 테이블에 나열된 수준이 기록됩니다.

로깅에 대한 자세한 내용은 진단 설명서를 참조SignalR하세요.

Java 클라이언트는 SignalR 로깅에 SLF4J 라이브러리를 사용합니다. 라이브러리 사용자가 특정 로깅 종속성을 가져와서 고유한 특정 로깅 구현을 선택할 수 있도록 하는 상위 수준 로깅 API입니다. 다음 코드 조각은 java.util.logging을(를) Java 클라이언트 SignalR와 함께 사용하는 방법을 보여줍니다.

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 JavaScript의 withUrl 호출에서 설정할 수 있습니다. 값 HttpTransportType 의 비트 OR을 사용하여 지정된 전송만 사용하도록 클라이언트를 제한할 수 있습니다. 모든 전송은 기본적으로 사용하도록 설정됩니다.

예를 들어 Server-Sent 이벤트 전송을 사용하지 않도록 설정하지만 WebSocket 및 긴 폴링 연결을 허용하려면 다음을 수행합니다.

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 인증 데이터를 제공하려면 JavaScript에서 옵션을AccessTokenProvider 사용하여 accessTokenFactory 원하는 액세스 토큰을 반환하는 함수를 지정합니다. .NET 클라이언트에서 이 액세스 토큰은 HTTP "Bearer 인증" 토큰으로 전달됩니다(Authorization 헤더를 Bearer 형식으로 사용하여). JavaScript 클라이언트에서 액세스 토큰은 브라우저 API가 헤더를 적용하는 기능(특히 Server-Sent 이벤트 및 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의 options 객체에서 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에 액세스 토큰 팩터리를 제공하여 인증에 사용할 전달자 토큰을 구성할 수 있습니다. WithAccessTokenFactory를 사용하여 RxJava단일<문자열>을 제공합니다. Single.defer를 호출하면 클라이언트에 대한 액세스 토큰을 생성하는 논리를 작성할 수 있습니다.

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

시간 제한 및 연결 유지 옵션 구성

시간 제한 및 유지 동작을 구성하는 추가 옵션은 HubConnection 개체 자체에서 사용할 수 있습니다.

추가 옵션 구성

Java 클라이언트에서는 WithUrl 메서드의 withUrl(HubConnectionBuilder는 JavaScript) 또는 다양한 구성 HttpHubConnectionBuilder API에서 추가 옵션을 구성할 수 있습니다.

이 옵션은 .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 클라이언트에서는 withUrl에 제공된 JavaScript 객체를 통해 이러한 옵션을 설정할 수 있습니다.

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에서 허브 사용
• ASP.NET Core SignalR JavaScript 클라이언트
• ASP.NET Core SignalR .NET 클라이언트
• ASP.NET Core에 SignalR MessagePack Hub 프로토콜 사용
• ASP.NET Core SignalR 지원 플랫폼