如何配置YARP反向代理解决Socket.io连接报错问题？

该需求可以实现，YARP原生满足Socket.io反向代理的所有要求，连接报错的核心原因是未适配Socket.io长连接、握手流程所需的代理配置，按照以下步骤配置即可解决。

核心适配要求 #

Socket.io建立连接时会先后走HTTP长轮询握手、WebSocket升级流程，反向代理必须满足以下要求才能正常转发请求：

• 开启WebSocket代理能力
• 关闭普通短请求的默认超时逻辑，适配长连接场景
• 集群部署时必须开启粘性会话，保证同一客户端的所有握手、连接请求落到同一个后端Socket.io节点
• 不要篡改Connection、Upgrade、Sec-WebSocket-*系列协议头，YARP默认不会修改这类字段，避免自定义中间件错误覆盖即可

具体配置步骤 #

1. 配置YARP路由与集群规则 #

在appsettings.json中添加Socket.io专属的路由和集群配置，示例如下：

{
  "ReverseProxy": {
    "Routes": {
      "socketio-route": {
        "ClusterId": "socketio-cluster",
        "Match": {
          "Path": "/socket.io/{**remainder}"
        },
        "Timeouts": {
          "RequestTimeout": null
        }
      }
    },
    "Clusters": {
      "socketio-cluster": {
        "SessionAffinity": {
          "Enabled": true,
          "Policy": "Cookie",
          "AffinityKeyName": "sio_yarp_affinity",
          "Cookie": {
            "HttpOnly": true,
            "SecurePolicy": "SameAsRequest",
            "SameSite": "Lax"
          }
        },
        "Destinations": {
          "socketio-node1": {
            "Address": "http://你的后端Socket.io服务内网地址:端口/"
          }
        }
      }
    }
  }
}

注意：如果你的Socket.io服务自定义了连接路径，需要把路由匹配规则里的/socket.io/替换为实际使用的路径。多实例集群部署时，在Destinations节点下追加所有后端Socket.io实例地址即可。

2. 配置服务启动代码 #

在Program.cs中按顺序注册WebSocket中间件与YARP代理，注意中间件顺序不能颠倒，WebSocket中间件必须放在YARP路由映射之前注册，否则WebSocket升级请求会被拦截：

var builder = WebApplication.CreateBuilder(args);

// 注册YARP反向代理服务，加载配置文件中的规则
builder.Services.AddReverseProxy()
    .LoadFromConfig(builder.Configuration.GetSection("ReverseProxy"));

var app = builder.Build();

// 先启用WebSocket支持，再映射YARP路由
app.UseWebSockets();
app.MapReverseProxy();

app.Run();

常见问题排查 #

如果配置后仍然连接失败，按以下顺序排查：

• 跨域场景下，前端开启withCredentials: true时，需要将粘性会话Cookie的SameSite属性设置为None，同时开启Secure属性，配合HTTPS使用
• 检查YARP与后端Socket.io服务之间是否存在其他会截断长连接的网络设备，需要保证整条链路的空闲超时设置大于Socket.io的心跳间隔
• CORS策略只需要在YARP层或者后端Socket.io服务其中一侧配置即可，不要重复配置导致冲突
• 单实例部署如果不需要粘性会话可以关闭该配置，但集群部署必须开启，否则握手阶段请求分散到不同节点会直接触发连接错误

内容的提问来源于stack exchange，提问作者Joáo Páris