Hub'ları SignalR ASP.NET Core

GöreCe Appel veİslaLide

Örnek kodu görüntüleme veya indirme (indirme)

Merkez SignalR nedir?

SignalRHubs API'si, sunucudan bağlı istemcilerde yöntemleri çağırmaya olanak sağlar. Sunucu kodunda, istemci tarafından çağrılan yöntemleri tanımlarsınız. İstemci kodunda, sunucudan çağrılan yöntemleri tanımlarsınız. SignalR gerçek zamanlı istemciden sunucuya ve sunucudan istemciye iletişimleri mümkün kılan her şeyi arkalarında yapar.

SignalRHub'ları yapılandırma

Ara SignalR yazılım, çağrılarak yapılandırılan bazı hizmetler services.AddSignalR gerektirir.

services.AddSignalR();

app.UseRouting();
app.UseEndpoints(endpoints =>
{
    endpoints.MapHub<ChatHub>("/chathub");
});

app.UseSignalR(route =>
{
    route.MapHub<ChatHub>("/chathub");
});

Hub'ları oluşturma ve kullanma

'den devralan bir sınıf bildirerek bir hub oluşturun Hub ve buna genel yöntemler ekleyin. İstemciler olarak tanımlanan yöntemleri public çağırarak.

public class ChatHub : Hub
{
    public Task SendMessage(string user, string message)
    {
        return Clients.All.SendAsync("ReceiveMessage", user, message);
    }
}

Herhangi bir C# yönteminde olduğu gibi, karmaşık türler ve diziler de dahil olmak üzere bir dönüş türü ve parametreler belirtebilirsiniz. SignalR parametrelerinizin ve dönüş değerlerinizin karmaşık nesneleri ve dizilerinin serileştirme ve seriden kaldıran işleme.

Bağlam nesnesi

sınıfı, Hub bağlantı hakkında bilgi içeren aşağıdaki özellikleri içeren bir Context özelliğine sahiptir:

Hub.Context ayrıca aşağıdaki yöntemleri içerir:

İstemciler nesnesi

sınıfı, Hub sunucu ve istemci arasındaki iletişim için aşağıdaki özellikleri içeren bir Clients özelliğine sahiptir:

Hub.Clients ayrıca aşağıdaki yöntemleri içerir:

Yukarıdaki tablolarda yer alan her özellik veya yöntem, yöntemine sahip bir nesne SendAsync döndürür. yöntemi, SendAsync çağrılacak istemci yönteminin adını ve parametrelerini sağlar.

İstemcilere ileti gönderme

Belirli istemcilere çağrı yapmak için nesnesinin özelliklerini Clients kullanın. Aşağıdaki örnekte üç Hub yöntemi vardır:

• SendMessage kullanarak tüm bağlı istemcilere bir ileti Clients.All gönderir.
• SendMessageToCaller kullanarak çağırana bir ileti Clients.Caller gönderir.
• SendMessageToGroup gruptaki tüm istemcilere bir ileti SignalR Users gönderir.

public Task SendMessage(string user, string message)
{
    return Clients.All.SendAsync("ReceiveMessage", user, message);
}

public Task SendMessageToCaller(string user, string message)
{
    return Clients.Caller.SendAsync("ReceiveMessage", user, message);
}

public Task SendMessageToGroup(string user, string message)
{
    return Clients.Group("SignalR Users").SendAsync("ReceiveMessage", user, message);
}

Kesin olarak türü kesin olarak yazıldı hub'lar

kullanmanın bir SendAsync dezavantajı, çağrıl yapılacak istemci yöntemini belirtmek için bir sihirli dizeye bağlı olmasıdır. Bu, yöntem adı yanlış yazılmışsa veya istemcide eksikse kodu çalışma zamanı hatalarına açık bırakır.

kullanmanın bir SendAsync alternatifi, ile türünü kesin olarak Hub Hub<T> yazmadır. Aşağıdaki örnekte, ChatHub istemci yöntemleri adlı bir arabirime ayıklandı. IChatClient

public interface IChatClient
{
    Task ReceiveMessage(string user, string message);
}

Bu arabirim, önceki örneği yeniden düzenlemek için ChatHub kullanılabilir.

public class StronglyTypedChatHub : Hub<IChatClient>
{
    public async Task SendMessage(string user, string message)
    {
        await Clients.All.ReceiveMessage(user, message);
    }

    public Task SendMessageToCaller(string user, string message)
    {
        return Clients.Caller.ReceiveMessage(user, message);
    }
}

kullanma, Hub<IChatClient> istemci yöntemlerinin derleme zamanı denetimine olanak sağlar. Yalnızca arabirimde tanımlanan yöntemlere erişim sağlandığı için bu, sihirli Hub<T> dizelerin kullanımından kaynaklanan sorunları önler.

Türü kesin olarak belirli bir Hub<T> şekilde yazarak özelliğini devre dışı SendAsync bırakmanızı sağlar. Arabirimde tanımlanan tüm yöntemler yine de zaman uyumsuz olarak tanımlanabilir. Aslında, bu yöntemlerin her biri bir Task dönüşletir. Bu bir arabirim olduğu için anahtar sözcüğünü async kullanmayın. Örnek:

public interface IClient
{
    Task ClientMethod();
}

Hub yönteminin adını değiştirme

Varsayılan olarak, sunucu hub'ı yöntemi adı .NET yönteminin adıdır. Ancak, hubMethodName özniteliğini kullanarak bu varsayılanı değiştirebilir ve yöntemi için el ile bir ad belirtebilirsiniz. İstemci, yönteminin iptali için .NET yöntem adı yerine bu adı kullandır.

[HubMethodName("SendMessageToUser")]
public Task DirectMessage(string user, string message)
{
    return Clients.User(user).SendAsync("ReceiveMessage", user, message);
}

Bağlantı için olayları işleme

SignalRHubs API'si bağlantıları OnConnectedAsync yönetmek ve izlemek için ve sanal yöntemleri OnDisconnectedAsync sağlar. İstemci OnConnectedAsync Hub'a bağlandığında, bir gruba ekleme gibi eylemleri gerçekleştirmek için sanal yöntemi geçersiz kılın.

public override async Task OnConnectedAsync()
{
    await Groups.AddToGroupAsync(Context.ConnectionId, "SignalR Users");
    await base.OnConnectedAsync();
}

İstemcinin OnDisconnectedAsync bağlantısı kesiken eylemler gerçekleştirmek için sanal yöntemi geçersiz kılın. İstemcinin bağlantısı kasıtlı olarak kes (örneğin connection.stop() çağrısıyla) exception olursa, parametresi null olur. Ancak, istemcinin bağlantısı bir hata (ağ hatası gibi) nedeniyle kesilirse, parametre exception hatayı açıklayan bir özel durum içerir.

public override async Task OnDisconnectedAsync(Exception exception)
{
    await Groups.RemoveFromGroupAsync(Context.ConnectionId, "SignalR Users");
    await base.OnDisconnectedAsync(exception);
}

Hataları işleme

Hub yöntemlerinize gönderilen özel durumlar, yöntemini çağıran istemciye gönderilir. JavaScript istemcide yöntemi bir invoke JavaScript Promise döndürür. İstemci, kullanarak promise'e eklenmiş bir işleyici ile hata aldığında, catch çağrılır ve JavaScript nesnesi olarak Error geçirtir.

connection.invoke("SendMessage", user, message).catch(err => console.error(err));

Hub'nız bir özel durum oluşturursa bağlantılar kapatılacaktır. Varsayılan olarak, SignalR istemciye genel bir hata iletisi döndürür. Örnek:

Microsoft.AspNetCore.SignalR.HubException: An unexpected error occurred invoking 'MethodName' on the server.

Beklenmeyen özel durumlar genellikle veritabanı bağlantısı başarısız olduğunda tetiklenen bir özel durumdaki veritabanı sunucusunun adı gibi hassas bilgiler içerir. SignalR , bu ayrıntılı hata iletilerini varsayılan olarak bir güvenlik önlemi olarak açığa çıkarmaz. Özel durum ayrıntılarının gizlenme nedeni hakkında daha fazla bilgi için Güvenlikle ilgili dikkat edilmesi gerekenler makalesine bakın.

İstemciye yayılmasını istediğiniz olağanüstü bir koşul varsa sınıfını HubException kullanabilirsiniz. Hub yönteminden HubException bir atarsanız, iletinin tamamını istemciye SignalR gönderir, değiştirilmez.

public Task ThrowException()
{
    throw new HubException("This error will be sent to the client!");
}

İlgili kaynaklar

• ASP.NET Core'a girişSignalR
• JavaScript istemcisi
• Azure'da yayımlama