Golang集成go-socket.io无法建立WebSocket连接问题求助

问题表现 #

参照go-socket.io包官方示例编写服务端、搭配Web客户端连接时，客户端持续发送长轮询GET请求，始终无法正常建立WebSocket连接。通过浏览器开发者工具抓包查看，响应载荷头部存在部分异常随机字节：

复现代码 #

服务端实现 #

func main() {
    server := socketio.NewServer(nil)
    server.OnConnect("/", func(s socketio.Conn) error {
        s.SetContext("")
        fmt.Println("connected:", s.ID())       
        return nil
    })

    server.OnEvent("/", "notice", func(s socketio.Conn, msg string) {
        fmt.Println("notice:", msg)
        s.Emit("reply", "have "+msg)
    })

    server.OnEvent("/chat", "msg", func(s socketio.Conn, msg string) string {
        s.SetContext(msg)
        return "recv " + msg
    })

    server.OnEvent("/", "bye", func(s socketio.Conn) string {
        last := s.Context().(string)
        s.Emit("bye", last)
        s.Close()
        return last
    })

    server.OnError("/", func(s socketio.Conn, e error) {
        fmt.Println("meet error:", e)
    })

    server.OnDisconnect("/", func(s socketio.Conn, reason string) {
        fmt.Println("closed", reason)
    })

    go server.Serve()
    defer server.Close()

    mux := http.NewServeMux()
    
    mux.Handle("/socket.io/", server) // socket io
    
    log.Println("Serving at localhost:8000...")
    log.Fatal(http.ListenAndServe(":8000", cors.Default().Handler(mux)))
}

客户端实现 #

<script src="https://cdn.socket.io/4.5.0/socket.io.min.js"
  integrity="sha384-7EyYLQZgWBi67fBtVxw60/OWl1kjsfrPFcaU0pp0nAh+i8FD068QogUvg85Ewy1k" crossorigin="anonymous"></script>
<script>
  const socket = io("http://localhost:8000");
  socket.emit("msg", "abc")
</script>

根因定位 #

• 核心故障：客户端与服务端协议版本不兼容：当前使用的go-socket.io v1稳定版仅支持Socket.IO v2版本协议，而前端引入的是v4.5.0版本客户端，两者协议规范不匹配，握手阶段数据解析失败，无法完成WebSocket升级，只能反复发起长轮询重试，响应头部的异常字节就是协议解析错误产生的乱码。
• 事件注册命名空间不匹配：服务端将msg事件注册在/chat命名空间下，但客户端默认连接/根命名空间，即便连接建立成功，也无法正常触发该事件。

修复方案 #

• 对齐协议版本：如果继续使用当前go-socket.io v1版本，将前端Socket.IO客户端替换为2.x版本即可匹配协议；如果要使用v4版本客户端，需替换为支持Socket.IO v3/v4协议的Go服务端实现，或升级go-socket.io至兼容v4协议的v2版本（注意v2版本API存在变动，需同步调整服务端代码）。
• 修正命名空间配置：如果需要使用/chat命名空间，客户端初始化连接时需指定命名空间路径，写法为const socket = io("http://localhost:8000/chat");；如果要在根命名空间使用msg事件，将服务端注册该事件的第一个参数从"/chat"修改为"/"。
• 校验CORS配置：确认使用的CORS中间件允许WebSocket升级所需的Upgrade、Connection请求头，涉及身份凭证传输时不要将允许源设置为通配符*，配置为实际的前端服务地址即可。

内容的提问来源于stack exchange，提问作者Jyhonn