使用 SignalR 和 Azure Active Directory 构建和保护实时通信

命令 HTTP API 将事件存储到事件存储,但不直接将它们发布到 Kafka 服务总线。可以考虑这种情况,但我不希望命令 API 也充当生产者。

另一个原因是前端SPA应该收到推送通知。应该通知它发布的命令已成功。

所以我需要一个像SignalR这样的通知系统。.

使用场景如下:

  • 前端 SPA 启动并订阅 SignalR 组(主题)
  • 前端 SPA 将数据发布到命令 HTTP API
  • 命令 HTTP API 将从post/put/delete请求中接收的数据转换为事件,并将这些事件存储到事件存储中
  • 命令 HTTP API 将通知推送到 SignalR 组(主题)
  • 订阅 SignalR 组的生产者服务接收通知,然后将事件发布到 Kafka 服务总线
  • 订阅 Kafka 服务总线的使用者从 Kafka 服务总线接收事件,然后构建一个读取模型并将其存储到非 SQL 数据库(Elasticsearch)并向 SignalR 组发送通知
  • 前端 SPA 会收到 Elasticsearch 索引已更新的通知,然后刷新视图。

因此,推送通知系统在此体系结构中起着至关重要的作用。

如果架构的某个部分出现故障(SignalR Hub、Kafka、database、API)会发生什么?我们将在以后的教程中看到它。

在本教程中,我将演示如何构建 SignalR Hub 通知系统,并使用标识提供者通过使用 Azure AD B2C 启用 Oauth2 和 OpenID Connect 来保护 SignalR Hub 通知系统。

Azure Active Directory B2C 提供企业到客户的标识即服务。客户使用其首选的社交、企业或本地帐户标识来获取对应用程序和 API 的单一登录访问权限。

有关 Azure AD B2C 的更多信息,请参阅什么是 Azure Active Directory B2C?

Azure Active Directory B2C

若要将 Azure AD B2C 设置为标识提供者,我需要创建一个与 Azure AD 租户不同的 B2C 租户。

Azure AD B2C 是独立于 Azure Active Directory (Azure AD) 的服务。它基于与 Azure AD 相同的技术构建,但用途不同 - 允许企业构建面向客户的应用程序,然后允许任何人注册这些应用程序,而对用户帐户没有限制。

有关 Azure AD 的更多信息,请参阅什么是 Azure Active Directory?

构建 SignalR Hub 通知

ASP.NET Core SignalR 是一个开源库,可简化向应用程序添加实时Web功能的过程。实时 Web 功能使服务器端代码能够立即将内容推送到客户端。

https://docs.microsoft.com/en-us/aspnet/core/signalr/introduction?WT.mc_id=DOP-MVP-5003013

要构建 SignalR Hub ,您应该定义一个从 Hub 继承的类,如下所示:

using Microsoft.AspNetCore.SignalR;
namespace SignalRChat.Hubs
{
       public class ChatHub : Hub
       {
                public async Task SendMessage(string user, string message)
                {
                      await Clients.All.SendAsync(“ReceiveMessage”, user, message);
                 }
       }
}

要向所有连接的客户端发送消息,您应该使用SendMessage功能并接收消息,连接的客户端应侦听接收消息

您可以使用以下链接开始使用 SignalR:https://docs.microsoft.com/en-us/aspnet/core/tutorials/signalr?view=aspnetcore-6.0&tabs=visual-studio

SendMessage和ReisterMessage作为字符串使用和调用,所以我不会以相同的方式继续,而是使用强类型的方式

所以我创建了一个IHubInvoker接口来调用Hub:

  • 发布 :将 T 类型的消息发布到中心
  • 发布到主题 :将特定主题的 T 类型消息发布到中心
  • 订阅 :订阅主题
  • 取消订阅 :取消订阅主题

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

我创建了一个 IHubNotifier 接口来侦听来自集线器的消息。

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

SignalR Hub 应该继承自 Hub<IHubNotifier>、IHubInvoker

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

在 startup.cs ( configure 方法) 类将 endpoints 与连接相关联。

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

我创建了一个 ISignalRPublisher 接口来订阅主题或将消息发布到中心。

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

所以要订阅一个主题,我应该调用 nameof(IHubInvoker.Subscribe) ,要发布一个主题,我应该调用nameof(IHubInvoker.PublishToTopic)

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

我创建了一个 ISignalRNotifier 接口来开始客户端连接,停止连接并收听消息

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

因此,为了侦听和处理发送到中心的消息,我注册了一个处理程序,当调用具有指定方法名称的中心方法时,将调用该处理程序:nameof(IHubNotifier.OnPublish)

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

ISignalRNotifier 应按如下方式使用

public interface ISignalRNotifier
{
       event Action<string, object> ReceivedOnPublishToTopic;
       Task StartAsync();
       Task OnPublish();
       Task OnPublish(string topic);
       Task StopAsync();
}

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

要将消息发布到 hub,我应该使用 ISignalRPublisher 接口。如果断开连接的客户端尝试向中心发送消息,在发送消息之前会自动连接它

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

保护 SignalR HUB

若要保护SignalR HUB,需要在 Azure AD B2C 租户中注册应用程序,公开终结点

Azure AD B2C 应用程序注册

转到租户并单击"应用注册"并相应地填写表单:提供应用程序名称、支持的帐户类型。在这里,我不需要重定向URI,因为它是一个Web api。

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

单击"公开 API"并设置应用程序 ID URI(在本例中为,https://workshopb2clogcorner.onmicrosoft.com/signalr/hub)

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

配置 SignalR HUB

打开 startup.cs 类并添加以下内容以注册身份验证服务所需的服务,并使用 Microsoft 标识平台保护hub

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

打开appsettings.Development.json 并添加如下内容

将 [ClientID] 替换为您注册的应用程序的标识符,将 [TenantName] 替换为您的租户名称(在我的案例 workshopb2clogcorner 中)。

用户流B2C_1_SignUpIn、B2C_1_PasswordReset和B2C_1_ProfileEdit已在第16部分中配置:https://logcorner.com/building-micro-services-through-event-driven-architecture-part16-azure-active-directory-b2c/

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

要启用身份验证,请使用标志"isAuthenticationEnabled":在 appSettings.json 文件中为 true。

要禁用身份验证,请使用标志"isAuthenticationEnabled":在 appSettings.json 文件中为 false。

在 startup.cs 类中,它的管理方式如下:

bool.TryParse(Configuration[“isAuthenticationEnabled”], out var isAuthenticationEnabled);
if (!isAuthenticationEnabled)
{
        endpoints.MapHub<LogCornerHub<object>>(“/logcornerhub”);
}
else
{
        endpoints.MapHub<LogCornerHub<object>>(“/logcornerhub”).RequireAuthorization();
}

测试

运行应用程序并导航到 http://localhost:5000/logcornerhub 或者 https://localhost:5001/logcornerhub

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

http://localhost:5000/logcornerhub

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

https://localhost:5001/logcornerhub

使用 SignalR 和 Azure Active Directory 构建和保护实时通信

可以看到,hub 已准备好进行客户端连接

代码源可在此处获得:

https://github.com/logcorner/LogCorner.EduSync.Notification.Server/tree/develop