Українська
Контракт хаба й з’єднання
Крок 1. SignalR коротко
Навіщо. HTTP працює за схемою «запит – відповідь»: браузер питає, сервер відповідає. Месенджеру потрібен і зворотний напрямок – сервер має повідомити Bob про повідомлення від Alice, не чекаючи його запиту. ASP.NET Core SignalR тримає відкритим одне з’єднання на кожну вкладку браузера (WebSocket або резервний транспорт) і дає серверові викликати методи клієнтів, а клієнтам – методи сервера. Основи пояснює курс C# у темі SignalR: хаби, Clients, групи, клієнти для .NET і JavaScript.
Chatex використовує три ідеї SignalR:
- Хаб за адресою
/hubs/chat– кінцева точка, до якої підключаються клієнти. - Групи – іменовані набори з’єднань. Кожен чат має групу
chat:{id}; кожне з’єднання кожного учасника вступає до груп чатів свого користувача (рис. 14.2). Подія чату надходить лише до його групи, тож сторонні її ніколи не отримують. - Строго типізований хаб
Hub<IChatClient>– події є методами інтерфейсу, тож компілятор перевіряє їхні імена й аргументи.
Рис. 14.2. Кожне з’єднання вступає до групи кожного чату свого користувача
Крок 2. Що отримують клієнти
Навіщо. Події – це контракт із клієнтом Angular (тема 20), який підписується на них за іменем. Інтерфейс робить контракт явним і перевірюваним.
Що зробити. Створіть папку Hubs:
cs
using Chatex.Core.Messages;
namespace Chatex.Api.Hubs;
/// <summary>
/// Events the server pushes to clients of <see cref="ChatHub"/>. Chat events go to the group <c>chat:{chatId}</c>,
/// so only current members receive them. The frontend is coded against these names and arguments.
/// </summary>
public interface IChatClient
{
Task MessageCreated(MessageDto message);
Task MessageUpdated(MessageDto message);
Task MessageDeleted(Guid chatId, Guid messageId);
/// <summary>A member's read position moved forward. Not sent for channels.</summary>
Task MessagesRead(Guid chatId, Guid userId, Guid lastReadMessageId);
/// <summary>Users joined or were added, including everyone in a newly created chat.</summary>
Task MembersAdded(Guid chatId, Guid[] userIds);
/// <summary>A user left or was removed. The removed user receives it too, then stops getting the chat's events.</summary>
Task MemberRemoved(Guid chatId, Guid userId);
/// <summary>Title, description, handle, avatar or member roles changed; refetch the chat.</summary>
Task ChatUpdated(Guid chatId);
Task ChatDeleted(Guid chatId);
/// <summary>Someone else in the chat is typing. Expire the indicator after about 5 seconds.</summary>
Task Typing(Guid chatId, Guid userId);
/// <summary>A user who shares a chat with you opened their first connection.</summary>
Task UserOnline(Guid userId);
/// <summary>A user who shares a chat with you closed their last connection and did not return within the grace period.</summary>
Task UserOffline(Guid userId, DateTimeOffset lastSeenAt);
}Вісім подій відображають вісім методів IChatNotifier (тема 10); ще три належать самому хабу: Typing, UserOnline, UserOffline. Коментарі підказують клієнтові, що робити з кожною, – наприклад, погасити індикатор набору тексту приблизно через п’ять секунд.
Крок 3. Хто в мережі
Навіщо. Користувач перебуває в мережі, доки має принаймні одне відкрите з’єднання: вкладка на ноутбуці й телефон рахуються окремо, а закриття одного з них не має робити користувача офлайн. Серверові потрібен для кожного користувача набір ідентифікаторів його з’єднань:
- щоб оголошувати «в мережі» під час першого з’єднання й «поза мережею» після закриття останнього;
- щоб одразу додати відкриті з’єднання користувача до групи нового чату, коли його туди додають (наступний розділ).
Chatex працює як один процес, тож цей набір може жити в пам’яті. З кількома серверами з’єднання розподілялися б між ними, і знадобилося б спільне сховище або основа обміну SignalR (backplane; наприклад, Redis) – це свідоме спрощення, яке прямо вказано в README Chatex («присутність у пам’яті, один процес, без backplane»).
Що зробити.
cs
using System.Collections.Concurrent;
namespace Chatex.Api.Hubs;
/// <summary>
/// The open hub connections of each user, in memory. One process, so no backplane is needed.
/// A user is online while they have at least one connection (tabs and devices count separately).
/// </summary>
internal sealed class PresenceTracker
{
private readonly ConcurrentDictionary<Guid, HashSet<string>> _connections = new();
/// <summary>Adds the connection; returns true when it is the user's first one.</summary>
public bool Add(Guid userId, string connectionId)
{
while (true)
{
var set = _connections.GetOrAdd(userId, _ => []);
lock (set)
{
// Remove may have emptied and dropped this set after GetOrAdd returned it; then retry with a fresh one.
if (_connections.TryGetValue(userId, out var current) && ReferenceEquals(current, set))
{
set.Add(connectionId);
return set.Count == 1;
}
}
}
}
/// <summary>Removes the connection; returns true when it was the user's last one.</summary>
public bool Remove(Guid userId, string connectionId)
{
if (!_connections.TryGetValue(userId, out var set))
{
return false;
}
lock (set)
{
if (!set.Remove(connectionId) || set.Count > 0)
{
return false;
}
_connections.TryRemove(new KeyValuePair<Guid, HashSet<string>>(userId, set));
return true;
}
}
public IReadOnlyList<string> GetConnections(Guid userId)
{
if (!_connections.TryGetValue(userId, out var set))
{
return [];
}
lock (set)
{
return [.. set];
}
}
public bool IsOnline(Guid userId)
{
if (!_connections.TryGetValue(userId, out var set))
{
return false;
}
lock (set)
{
return set.Count > 0;
}
}
}ConcurrentDictionary<Guid, HashSet<string>>: словник потокобезпечний, а набори – ні, тому кожен доступ до набору відбувається всерединіlock (set).- Цикл повторних спроб у
Addобробляє стан гонитви: міжGetOrAddіlockінший потік може вилучити останнє з’єднання користувача й прибрати набір зі словника. ПеревіркаReferenceEquals(current, set)це помічає й повторює спробу зі свіжим набором. TryRemove(KeyValuePair)видаляє запис, лише якщо він досі містить саме цей набір, – новіший набір від паралельногоAddлишається недоторканим.[.. set]копіює набір під блокуванням, тож викликачі отримують знімок, який можна безпечно перебирати.
Крок 4. Ідентифікатор користувача з’єднання
Навіщо. SignalR ідентифікує користувачів за Context.UserIdentifier, що типово береться з твердження NameIdentifier. Тема 12 зберегла початкові імена тверджень токена (MapInboundClaims = false), тож ідентифікатор користувача лежить у sub. Невеликий постачальник підказує SignalR, де його шукати.
Що зробити.
cs
using Microsoft.AspNetCore.SignalR;
using Microsoft.IdentityModel.JsonWebTokens;
namespace Chatex.Api.Hubs;
/// <summary>
/// Makes <c>Context.UserIdentifier</c> and <c>Clients.User(id)</c> use the access token's <c>sub</c> claim.
/// The default provider reads NameIdentifier, which is absent because the JWT handler keeps the raw claim names.
/// </summary>
internal sealed class SubClaimUserIdProvider : IUserIdProvider
{
public string? GetUserId(HubConnectionContext connection) =>
connection.User?.FindFirst(JwtRegisteredClaimNames.Sub)?.Value;
}Перевірка
dotnet build проходить успішно.