通过Azure APIM连接Kubernetes中SignalR Hub的客户端配置问题

一、确定APIM访问地址并配置路由 #

1. 获取APIM网关域名：你的APIM实例自带默认网关域名，格式为 https://{你的APIM实例名}.azure-api.net，这是客户端访问的基础地址。
2. 在APIM中创建API并映射后端：
   • 新建API，后端服务指向Kubernetes集群内微服务的ClusterIP服务地址（需确保APIM与K8s集群在同一VNet或通过VNet peering连通，避免暴露节点IP），示例地址：http://{微服务K8s服务名}.{命名空间}.svc.cluster.local:5000。
   • 配置API路径规则，将前端请求路径（如 /notifications/notishub）映射到后端的 /notishub。最终客户端的完整连接地址为 https://{你的APIM实例名}.azure-api.net/notifications/notishub（/notifications为APIM中自定义的API前缀，可按需修改）。

二、配置APIM支持SignalR协议 #

SignalR依赖WebSocket等传输协议，需在APIM中开启对应支持：

• 进入APIM的API设置页面，在“协议”选项中勾选WebSocket，允许该协议的请求。
• 添加入站策略，确保SignalR关键请求头被正确转发到后端，避免被APIM拦截。示例策略：

  <set-header name="Upgrade" exists-action="override">
      <value>@(context.Request.Headers.GetValueOrDefault("Upgrade", ""))</value>
  </set-header>
  <set-header name="Connection" exists-action="override">
      <value>@(context.Request.Headers.GetValueOrDefault("Connection", ""))</value>
  </set-header>
  

三、客户端代码修改 #

将客户端的Hub连接URL替换为APIM的完整地址：

this._hubConnection = new HubConnectionBuilder().WithAutomaticReconnect()
             .WithUrl("https://{你的APIM实例名}.azure-api.net/notifications/notishub")
             .Build();

若APIM启用了订阅密钥验证，需在请求中携带密钥，可通过以下方式配置：

.WithUrl("https://{你的APIM实例名}.azure-api.net/notifications/notishub", options =>
{
options.Headers.Add("Ocp-Apim-Subscription-Key", "你的订阅密钥");
})

## 四、替代方案：使用Azure SignalR Service中转
如果不想在APIM中配置复杂的WebSocket规则，推荐用Azure SignalR Service作为中间层，适配Kubernetes分布式环境：
1. **后端微服务配置**：
   - 安装NuGet包 `Microsoft.Azure.SignalR`
   - 在`Program.cs`中添加Azure SignalR集成：
     ```csharp
     builder.Services.AddSignalR().AddAzureSignalR(builder.Configuration["AzureSignalR:ConnectionString"]);
     ```
2. **客户端连接**：直接连接到Azure SignalR Service的端点，格式为 `https://{你的SignalR实例名}.service.signalr.net/client/?hub=notishub`，无需经过APIM（或也可通过APIM转发，配置更简单）。
3. **优势**：自动处理多实例的SignalR连接路由，规避Kubernetes环境下的会话亲和问题，同时大幅简化APIM配置。

---
内容的提问来源于stack exchange，提问作者Benijamo.net