ASP.NET Core SignalR yapılandırması

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirme, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. AddJsonProtocol içinde sonra AddSignalR Startup.ConfigureServiceseklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerOptions nesnedeki özelliği, bağımsız değişkenlerin serileştirmesini ve dönüş değerlerini yapılandırmak için kullanılabilecek bir System.Text.Json JsonSerializerOptions nesnedir. Daha fazla bilgi için System.Text.Json belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine özellik adlarının büyük/küçük harflerini değiştirmeyecek şekilde yapılandırmak için içinde Program.csaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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'a geçiş yapma

içinde desteklenmeyen Newtonsoft.Json özelliklerine ihtiyacınız varsa bkz. geçiş yapmaNewtonsoft.Json.System.Text.Json

MessagePack serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Program.csiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Program.csgeçirilerek yapılandırılır.

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();

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

LogLevel Bir değer yerine, günlük düzeyi adını temsil eden bir string değer de sağlayabilirsiniz. Sabitlere erişiminiz olmayan ortamlarda günlüğe kaydetmeyi LogLevel yapılandırırken SignalR bu yararlı olur.

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

Aşağıdaki tablo kullanılabilir günlük düzeylerini listeler. Sağlamak için sağladığınız değer, günlüğe configureLogging kaydedilecek en düşük günlük düzeyini ayarlar. Bu düzeyde günlüğe kaydedilen iletiler veya tabloda ondan sonra listelenen düzeyler günlüğe kaydedilir.

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Java istemcisi WebSockets'in bu sürümünde kullanılabilen tek aktarımdır.

Java istemcisinde aktarım, üzerindeki HttpHubConnectionBuilderyöntemiyle withTransport seçilir. Java istemcisi varsayılan olarak WebSockets aktarımını kullanır.

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

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Zaman aşımı ve canlı tutma davranışını yapılandırmak için ek seçenekler:

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();

Durum bilgisi olan yeniden bağlanmayı yapılandırma

SignalR durum bilgisi olan yeniden bağlantı, ağ bağlantıları arasında geçiş yapma veya erişimde kısa bir geçici kayıp gibi ağ bağlantılarında geçici bağlantı kesilen istemcilerin algılanan kapalı kalma süresini azaltır.

Durum bilgisi olan yeniden bağlantı bunu şu şekilde elde eder:

• Sunucu ve istemcideki veriler geçici olarak arabelleğe alınıyor.
• Hem sunucu hem de istemci tarafından alınan iletileri (ACK-ing) kabul etme.
• Bağlantının ne zaman çalışır durumda olduğunu tanıma ve bağlantı devre dışıyken gönderilmiş olabilecek iletileri yeniden yürütme.

Durum bilgisi olan yeniden bağlantı, ASP.NET Core 8.0 ve sonraki sürümlerde kullanılabilir.

Hem sunucu hub'ı uç noktasında hem de istemcide durum bilgisi olan yeniden bağlanmayı kabul edin:

• Şu seçeneği etkinleştirmek için sunucu hub'ı uç noktası yapılandırmasını güncelleştirin AllowStatefulReconnects :

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

  İsteğe bağlı olarak, sunucunun izin verdiği bayt cinsinden maksimum arabellek boyutu genel olarak veya belirli bir hub için şu seçenekle StatefulReconnectBufferSize ayarlanabilir:

  Genel StatefulReconnectBufferSize olarak ayarlanan seçenek:

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

  StatefulReconnectBufferSize Belirli bir hub için ayarlanan seçenek:

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

  Seçenek StatefulReconnectBufferSize , varsayılan olarak 100.000 bayt olan isteğe bağlıdır.

• Seçeneği etkinleştirmek için JavaScript veya TypeScript istemci kodunu güncelleştirin withStatefulReconnect :

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

  Seçenek bufferSize , varsayılan olarak 100.000 bayt olan isteğe bağlıdır.

• Seçeneği etkinleştirmek için .NET istemci kodunu güncelleştirin WithStatefulReconnect :

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

  Seçenek StatefulReconnectBufferSize , varsayılan olarak 100.000 bayt olan isteğe bağlıdır.

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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 İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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 istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirmesi, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. Bu yöntem, yönteminizden Startup.ConfigureServices sonra AddSignalR eklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerSettings nesnedeki özelliği, bağımsız değişkenlerin serileştirilmesini yapılandırmak ve değerleri döndürmek için kullanılabilecek bir Json.NET JsonSerializerSettings nesnesidir. Daha fazla bilgi için Json.NET belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine "PascalCase" özellik adlarını kullanacak şekilde yapılandırmak için içinde Startup.ConfigureServicesaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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 serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Startup.ConfigureServicesiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Startup.Configuregeçirilerek yapılandırılır.

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

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

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Nesnenin kendisinde zaman aşımı ve canlı tutma davranışını yapılandırmaya HubConnection yönelik ek seçenekler vardır:

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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

JavaScript İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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

Java istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirmesi, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. Bu yöntem, yönteminizden Startup.ConfigureServices sonra AddSignalR eklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerSettings nesnedeki özelliği, bağımsız değişkenlerin serileştirilmesini yapılandırmak ve değerleri döndürmek için kullanılabilecek bir Json.NET JsonSerializerSettings nesnesidir. Daha fazla bilgi için Json.NET belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine "PascalCase" özellik adlarını kullanacak şekilde yapılandırmak için içinde Startup.ConfigureServicesaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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 serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Startup.ConfigureServicesiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Startup.Configuregeçirilerek yapılandırılır.

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

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

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Java istemcisi WebSockets'in bu sürümünde kullanılabilen tek aktarımdır.

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Nesnenin kendisinde zaman aşımı ve canlı tutma davranışını yapılandırmaya HubConnection yönelik ek seçenekler vardır:

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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

JavaScript İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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

Java istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirme, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. AddJsonProtocol içinde sonra AddSignalR Startup.ConfigureServiceseklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerOptions nesnedeki özelliği, bağımsız değişkenlerin serileştirmesini ve dönüş değerlerini yapılandırmak için kullanılabilecek bir System.Text.Json JsonSerializerOptions nesnedir. Daha fazla bilgi için System.Text.Json belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine özellik adlarının büyük/küçük harflerini değiştirmeyecek şekilde yapılandırmak için içinde Startup.ConfigureServicesaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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'a geçiş yapma

içinde desteklenmeyen Newtonsoft.Json özelliklerine ihtiyacınız varsa bkz. geçiş yapmaNewtonsoft.Json.System.Text.Json

MessagePack serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Startup.ConfigureServicesiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Startup.Configuregeçirilerek yapılandırılır.

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

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

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

LogLevel Bir değer yerine, günlük düzeyi adını temsil eden bir string değer de sağlayabilirsiniz. Sabitlere erişiminiz olmayan ortamlarda günlüğe kaydetmeyi LogLevel yapılandırırken SignalR bu yararlı olur.

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

Aşağıdaki tablo kullanılabilir günlük düzeylerini listeler. Sağlamak için sağladığınız değer, günlüğe configureLogging kaydedilecek en düşük günlük düzeyini ayarlar. Bu düzeyde günlüğe kaydedilen iletiler veya tabloda ondan sonra listelenen düzeyler günlüğe kaydedilir.

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Java istemcisi WebSockets'in bu sürümünde kullanılabilen tek aktarımdır.

Java istemcisinde aktarım, üzerindeki HttpHubConnectionBuilderyöntemiyle withTransport seçilir. Java istemcisi varsayılan olarak WebSockets aktarımını kullanır.

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

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Nesnenin kendisinde zaman aşımı ve canlı tutma davranışını yapılandırmaya HubConnection yönelik ek seçenekler vardır:

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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

JavaScript İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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

Java istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirme, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. AddJsonProtocol içinde sonra AddSignalR Startup.ConfigureServiceseklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerOptions nesnedeki özelliği, bağımsız değişkenlerin serileştirmesini ve dönüş değerlerini yapılandırmak için kullanılabilecek bir System.Text.Json JsonSerializerOptions nesnedir. Daha fazla bilgi için System.Text.Json belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine özellik adlarının büyük/küçük harflerini değiştirmeyecek şekilde yapılandırmak için içinde Startup.ConfigureServicesaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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'a geçiş yapma

içinde desteklenmeyen Newtonsoft.Json özelliklerine ihtiyacınız varsa bkz. geçiş yapmaNewtonsoft.Json.System.Text.Json

MessagePack serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Startup.ConfigureServicesiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Startup.Configuregeçirilerek yapılandırılır.

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

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

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

LogLevel Bir değer yerine, günlük düzeyi adını temsil eden bir string değer de sağlayabilirsiniz. Sabitlere erişiminiz olmayan ortamlarda günlüğe kaydetmeyi LogLevel yapılandırırken SignalR bu yararlı olur.

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

Aşağıdaki tablo kullanılabilir günlük düzeylerini listeler. Sağlamak için sağladığınız değer, günlüğe configureLogging kaydedilecek en düşük günlük düzeyini ayarlar. Bu düzeyde günlüğe kaydedilen iletiler veya tabloda ondan sonra listelenen düzeyler günlüğe kaydedilir.

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Java istemcisi WebSockets'in bu sürümünde kullanılabilen tek aktarımdır.

Java istemcisinde aktarım, üzerindeki HttpHubConnectionBuilderyöntemiyle withTransport seçilir. Java istemcisi varsayılan olarak WebSockets aktarımını kullanır.

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

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Nesnenin kendisinde zaman aşımı ve canlı tutma davranışını yapılandırmaya HubConnection yönelik ek seçenekler vardır:

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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

JavaScript İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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

Java istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirme, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. AddJsonProtocol içinde sonra AddSignalR Startup.ConfigureServiceseklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerOptions nesnedeki özelliği, bağımsız değişkenlerin serileştirmesini ve dönüş değerlerini yapılandırmak için kullanılabilecek bir System.Text.Json JsonSerializerOptions nesnedir. Daha fazla bilgi için System.Text.Json belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine özellik adlarının büyük/küçük harflerini değiştirmeyecek şekilde yapılandırmak için içinde Startup.ConfigureServicesaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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'a geçiş yapma

içinde desteklenmeyen Newtonsoft.Json özelliklerine ihtiyacınız varsa bkz. geçiş yapmaNewtonsoft.Json.System.Text.Json

MessagePack serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Startup.ConfigureServicesiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Startup.Configuregeçirilerek yapılandırılır.

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

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

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

LogLevel Bir değer yerine, günlük düzeyi adını temsil eden bir string değer de sağlayabilirsiniz. Sabitlere erişiminiz olmayan ortamlarda günlüğe kaydetmeyi LogLevel yapılandırırken SignalR bu yararlı olur.

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

Aşağıdaki tablo kullanılabilir günlük düzeylerini listeler. Sağlamak için sağladığınız değer, günlüğe configureLogging kaydedilecek en düşük günlük düzeyini ayarlar. Bu düzeyde günlüğe kaydedilen iletiler veya tabloda ondan sonra listelenen düzeyler günlüğe kaydedilir.

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Java istemcisi WebSockets'in bu sürümünde kullanılabilen tek aktarımdır.

Java istemcisinde aktarım, üzerindeki HttpHubConnectionBuilderyöntemiyle withTransport seçilir. Java istemcisi varsayılan olarak WebSockets aktarımını kullanır.

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

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Nesnenin kendisinde zaman aşımı ve canlı tutma davranışını yapılandırmaya HubConnection yönelik ek seçenekler vardır:

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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 İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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 istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirme, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. AddJsonProtocol içinde sonra AddSignalR Program.cseklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerOptions nesnedeki özelliği, bağımsız değişkenlerin serileştirmesini ve dönüş değerlerini yapılandırmak için kullanılabilecek bir System.Text.Json JsonSerializerOptions nesnedir. Daha fazla bilgi için System.Text.Json belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine özellik adlarının büyük/küçük harflerini değiştirmeyecek şekilde yapılandırmak için içinde Program.csaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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'a geçiş yapma

içinde desteklenmeyen Newtonsoft.Json özelliklerine ihtiyacınız varsa bkz. geçiş yapmaNewtonsoft.Json.System.Text.Json

MessagePack serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Program.csiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Program.csgeçirilerek yapılandırılır.

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();

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

LogLevel Bir değer yerine, günlük düzeyi adını temsil eden bir string değer de sağlayabilirsiniz. Sabitlere erişiminiz olmayan ortamlarda günlüğe kaydetmeyi LogLevel yapılandırırken SignalR bu yararlı olur.

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

Aşağıdaki tablo kullanılabilir günlük düzeylerini listeler. Sağlamak için sağladığınız değer, günlüğe configureLogging kaydedilecek en düşük günlük düzeyini ayarlar. Bu düzeyde günlüğe kaydedilen iletiler veya tabloda ondan sonra listelenen düzeyler günlüğe kaydedilir.

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Java istemcisi WebSockets'in bu sürümünde kullanılabilen tek aktarımdır.

Java istemcisinde aktarım, üzerindeki HttpHubConnectionBuilderyöntemiyle withTransport seçilir. Java istemcisi varsayılan olarak WebSockets aktarımını kullanır.

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

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Nesnenin kendisinde zaman aşımı ve canlı tutma davranışını yapılandırmaya HubConnection yönelik ek seçenekler vardır:

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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 İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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 istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar

JSON/MessagePack serileştirme seçenekleri

ASP.NET Core SignalR , iletileri kodlamak için iki protokolü destekler: JSON ve MessagePack. Her protokolün serileştirme yapılandırma seçenekleri vardır.

JSON serileştirme, uzantı yöntemi kullanılarak AddJsonProtocol sunucuda yapılandırılabilir. AddJsonProtocol içinde sonra AddSignalR Startup.ConfigureServiceseklenebilir. yöntemi, AddJsonProtocol nesne alan bir options temsilci alır. Bu PayloadSerializerOptions nesnedeki özelliği, bağımsız değişkenlerin serileştirmesini ve dönüş değerlerini yapılandırmak için kullanılabilecek bir System.Text.Json JsonSerializerOptions nesnedir. Daha fazla bilgi için System.Text.Json belgelerine bakın.

Örneğin, seri hale getiriciyi varsayılan deve olayı adları yerine özellik adlarının büyük/küçük harflerini değiştirmeyecek şekilde yapılandırmak için içinde Program.csaşağıdaki kodu kullanın:

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

.NET istemcisinde, üzerinde HubConnectionBuilderaynı AddJsonProtocol uzantı yöntemi vardır. Microsoft.Extensions.DependencyInjection Uzantı yöntemini çözümlemek için ad alanının içeri aktarılması gerekir:

// 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'a geçiş yapma

içinde desteklenmeyen Newtonsoft.Json özelliklerine ihtiyacınız varsa bkz. geçiş yapmaNewtonsoft.Json.System.Text.Json

MessagePack serileştirme seçenekleri

MessagePack serileştirmesi, çağrı için AddMessagePackProtocol bir temsilci sağlanarak yapılandırılabilir. Daha fazla ayrıntı için bkz . messagepack in SignalR .

Sunucu seçeneklerini yapılandırma

Aşağıdaki tabloda hub'ları yapılandırma SignalR seçenekleri açıklanmaktadır:

Seçenekleri, içinde arama için bir seçenek temsilcisi AddSignalR sağlayarak tüm hub'lar Program.csiçin yapılandırılabilir.

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

Tek bir hub için seçenekler, içinde AddSignalR sağlanan genel seçenekleri geçersiz kılar ve kullanılarak AddHubOptionsyapılandırılabilir:

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

Gelişmiş HTTP yapılandırma seçenekleri

Aktarımlar ve bellek arabelleği yönetimiyle ilgili gelişmiş ayarları yapılandırmak için kullanın HttpConnectionDispatcherOptions . Bu seçenekler içinde bir temsilci MapHub Program.csgeçirilerek yapılandırılır.

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();

Aşağıdaki tabloda, ASP.NET Core'un SignalRgelişmiş HTTP seçeneklerini yapılandırma seçenekleri açıklanmaktadır:

Uzun Yoklama aktarımı, özelliği kullanılarak yapılandırılabilir ek seçeneklere LongPolling sahiptir:

WebSocket aktarım, özelliği kullanılarak yapılandırılabilir ek seçeneklere WebSockets sahiptir:

İstemci seçeneklerini yapılandırma

İstemci seçenekleri türüne göre HubConnectionBuilder yapılandırılabilir (.NET ve JavaScript istemcilerinde kullanılabilir). Java istemcisinde de kullanılabilir, ancak HttpHubConnectionBuilder oluşturucu yapılandırma seçeneklerinin yanı sıra HubConnection kendisinde de alt sınıf bulunur.

Günlük kaydetmeyi yapılandırma

Günlüğe kaydetme yöntemi kullanılarak .NET İstemcisi'nde ConfigureLogging yapılandırılır. Günlüğe kaydetme sağlayıcıları ve filtreler, sunucudaki gibi kaydedilebilir. Daha fazla bilgi için ASP.NET Core'da oturum açma belgelerine bakın.

Örneğin, Konsol günlüğünü etkinleştirmek için NuGet paketini yükleyin Microsoft.Extensions.Logging.Console . Uzantı yöntemini çağırın AddConsole :

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

JavaScript istemcisinde benzer configureLogging bir yöntem vardır. Üretilmesi gereken günlük iletilerinin en düşük düzeyini gösteren bir LogLevel değer sağlayın. Günlükler tarayıcı konsolu penceresine yazılır.

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

LogLevel Bir değer yerine, günlük düzeyi adını temsil eden bir string değer de sağlayabilirsiniz. Sabitlere erişiminiz olmayan ortamlarda günlüğe kaydetmeyi LogLevel yapılandırırken SignalR bu yararlı olur.

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

Aşağıdaki tablo kullanılabilir günlük düzeylerini listeler. Sağlamak için sağladığınız değer, günlüğe configureLogging kaydedilecek en düşük günlük düzeyini ayarlar. Bu düzeyde günlüğe kaydedilen iletiler veya tabloda ondan sonra listelenen düzeyler günlüğe kaydedilir.

Günlüğe kaydetme hakkında daha fazla bilgi için Tanılama belgelerine SignalR bakın.

SignalR Java istemcisi günlük kaydı için SLF4J kitaplığını kullanır. Bu, kitaplık kullanıcılarının belirli bir günlük bağımlılığını getirerek kendi özel günlük uygulamalarını seçmelerine olanak tanıyan üst düzey bir günlük API'sidir. Aşağıdaki kod parçacığında Java istemcisiyle SignalR nasıl kullanılacağı java.util.logging gösterilmektedir.

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

Bağımlılıklarınızda günlüğe kaydetmeyi yapılandırmazsanız, SLF4J aşağıdaki uyarı iletisiyle varsayılan bir işlemsiz günlükçü yükler:

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.

Bu, güvenli bir şekilde yoksayılabilir.

İzin verilen aktarımları yapılandırma

tarafından SignalR kullanılan aktarımlar çağrısında WithUrl (withUrl JavaScript'te) yapılandırılabilir. bit düzeyinde VEYA değerleri HttpTransportType , istemciyi yalnızca belirtilen aktarımları kullanacak şekilde kısıtlamak için kullanılabilir. Tüm aktarımlar varsayılan olarak etkindir.

Örneğin, Sunucu Tarafından Gönderilen Olaylar aktarımını devre dışı bırakmak, ancak WebSockets ve Uzun Yoklama bağlantılarına izin vermek için:

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

JavaScript istemcisinde aktarımlar, sağlanan withUrlseçenekler nesnesindeki transport alanı olarak ayarlanarak yapılandırılır:

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

Java istemcisi WebSockets'in bu sürümünde kullanılabilen tek aktarımdır.

Java istemcisinde aktarım, üzerindeki HttpHubConnectionBuilderyöntemiyle withTransport seçilir. Java istemcisi varsayılan olarak WebSockets aktarımını kullanır.

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

Taşıyıcı kimlik doğrulamayı yapılandırma

İsteklerle SignalR birlikte kimlik doğrulama verileri sağlamak için seçeneğini (accessTokenFactoryJavaScript'te) kullanarak AccessTokenProvider istenen erişim belirtecini döndüren bir işlev belirtin. .NET İstemcisi'nde, bu erişim belirteci bir HTTP "Taşıyıcı Kimlik Doğrulaması" belirteci olarak geçirilir (üst bilgi türüyle Bearerbirlikte kullanılırAuthorization). JavaScript istemcisinde, tarayıcı API'lerinin üst bilgi uygulama özelliğini kısıtladığı birkaç durum dışında erişim belirteci Taşıyıcı belirteci olarak kullanılır (özellikle Sunucu Tarafından Gönderilen Olaylar ve WebSockets isteklerinde). Böyle durumlarda erişim belirteci sorgu dizesi değeri access_tokenolarak sağlanır.

.NET istemcisinde seçeneği, AccessTokenProvider içindeki WithUrlseçenekler temsilcisi kullanılarak belirtilebilir:

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

JavaScript istemcisinde, erişim belirteci içindeki seçenekler nesnesinde withUrlalanı ayarlanarak accessTokenFactory yapılandırılır:

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();

Java istemcisindeSignalR, HttpHubConnectionBuilder'a erişim belirteci fabrikası sağlayarak kimlik doğrulaması için kullanılacak taşıyıcı belirteci yapılandırabilirsiniz. RxJava Tek Dizesini> sağlamak içinAccessTokenFactory ile kullanın.< Single.defer çağrısıyla, istemciniz için erişim belirteçleri oluşturmak üzere mantık yazabilirsiniz.

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

Zaman aşımı ve etkin tutma seçeneklerini yapılandırma

Nesnenin kendisinde zaman aşımı ve canlı tutma davranışını yapılandırmaya HubConnection yönelik ek seçenekler vardır:

Ek seçenekleri yapılandırma

Java istemcisindeki çeşitli yapılandırma API'lerinde WithUrl HttpHubConnectionBuilder (withUrlJavaScript'te) yönteminde HubConnectionBuilder ek seçenekler yapılandırılabilir:

.NET İstemcisi'nde, bu seçenekler için sağlanan WithUrlseçenekler temsilcisi tarafından değiştirilebilir:

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 İstemcisi'nde, bu seçenekler için withUrlsağlanan bir JavaScript nesnesinde sağlanabilir:

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 istemcisinde, bu seçenekler HttpHubConnectionBuilderHubConnectionBuilder.create("HUB URL")

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

Ek kaynaklar

• ASP.NET Core kullanmaya başlama SignalR
• ASP.NET Core'da hub'ları kullanma SignalR
• ASP.NET Core SignalR JavaScript istemcisi
• ASP.NET Core SignalR .NET İstemcisi
• ASP.NET Core için içinde SignalR MessagePack Hub Protokolü kullanma
• ASP.NET Core SignalR destekli platformlar