go websocket: bad handshake|极客教程

go websocket: bad handshake

在使用Go语言开发Web应用程序时，经常会涉及到与客户端建立WebSocket连接的需求。WebSocket是HTML5的一种新协议，可以在客户端和服务器之间建立持久性的全双工通信。在Go语言中，可以使用标准库中的gorilla/websocket包来处理WebSocket连接。

但是在实际开发过程中，有时候可能会遇到“bad handshake”错误。这个错误通常是由于客户端和服务器之间的握手过程发生问题所引起的。本文将详细解释在Go中遇到“bad handshake”错误的原因以及解决方法。

WebSocket握手过程

在使用WebSocket建立连接时，客户端和服务器之间会经历一个握手的过程。这个握手过程是WebSocket协议的一部分，用来协商升级协议和传输数据。具体握手过程如下：

客户端向服务器发送HTTP请求，请求头中包含WebSocket相关信息，例如Upgrade: websocket和Connection: Upgrade等字段。
服务器接收到请求后，验证请求头信息，然后返回HTTP响应，响应头中包含Upgrade: websocket和Connection: Upgrade字段，表示接受WebSocket协议。
客户端接收到响应后，验证响应头信息，如果返回状态码为101表示握手成功，之后客户端和服务器之间可以进行WebSocket通信。

常见原因及解决方法

在实际开发过程中，可能会出现客户端和服务器之间不能正常进行WebSocket握手的情况，造成“bad handshake”错误。下面列举了一些常见的原因以及解决方法。

1. 请求头信息不完整

客户端在发送HTTP请求时，可能会缺少必要的WebSocket协议字段，导致服务器无法识别WebSocket请求。这种情况下，可以在客户端代码中添加必要的请求头信息，例如：

import (
    "github.com/gorilla/websocket"
    "net/http"
)

func wsHandler(w http.ResponseWriter, r *http.Request) {
    upgrade := websocket.Upgrader{
        CheckOrigin: func(r *http.Request) bool {
            return true
        },
    }

    conn, err := upgrade.Upgrade(w, r, nil)
    if err != nil {
        w.WriteHeader(http.StatusBadRequest)
        return
    }

    defer conn.Close()

    for {
        _, msg, err := conn.ReadMessage()
        if err != nil {
            break
        }

        err = conn.WriteMessage(websocket.TextMessage, msg)
        if err != nil {
            break
        }
    }
}

func main() {
    http.HandleFunc("/ws", wsHandler)
    http.ListenAndServe(":8080", nil)
}

上述代码中，使用websocket.Upgrader结构体来处理WebSocket连接，将CheckOrigin设置为接受所有请求。这样可以确保客户端发送的请求头信息是完整的。

2. 客户端与服务器协议不匹配

客户端和服务器之间使用的WebSocket协议版本不匹配，也会导致“bad handshake”错误。在这种情况下，可以使用websocket.Upgrader结构体的Subprotocols字段指定协商的子协议，例如：

import (
    "github.com/gorilla/websocket"
    "net/http"
)

func wsHandler(w http.ResponseWriter, r *http.Request) {
    upgrade := websocket.Upgrader{
        CheckOrigin: func(r *http.Request) bool {
            return true
        },
        Subprotocols: []string{"chat"},
    }

    conn, err := upgrade.Upgrade(w, r, nil)
    if err != nil {
        w.WriteHeader(http.StatusBadRequest)
        return
    }

    defer conn.Close()

    for {
        _, msg, err := conn.ReadMessage()
        if err != nil {
            break
        }

        err = conn.WriteMessage(websocket.TextMessage, msg)
        if err != nil {
            break
        }
    }
}

func main() {
    http.HandleFunc("/ws", wsHandler)
    http.ListenAndServe(":8080", nil)
}

上述代码中，使用websocket.Upgrader结构体的Subprotocols字段指定协商的子协议为chat，这样可以确保客户端和服务器之间使用的协议版本是匹配的。

3. CORS策略限制

在客户端与服务器之间进行跨域WebSocket通信时，可能会受到CORS策略的限制，导致“bad handshake”错误。解决方法是在服务器端设置CORS策略，允许跨域请求。可以使用以下代码示例：

import (
    "github.com/gorilla/websocket"
    "net/http"
)

func wsHandler(w http.ResponseWriter, r *http.Request) {
    upgrade := websocket.Upgrader{
        CheckOrigin: func(r *http.Request) bool {
            return true
        },
    }

    conn, err := upgrade.Upgrade(w, r, nil)
    if err != nil {
        w.WriteHeader(http.StatusBadRequest)
        return
    }

    defer conn.Close()

    for {
        _, msg, err := conn.ReadMessage()
        if err != nil {
            break
        }

        err = conn.WriteMessage(websocket.TextMessage, msg)
        if err != nil {
            break
        }
    }
}

func main() {
    http.HandleFunc("/ws", wsHandler)

    // 设置CORS策略允许跨域请求
    cors := handlers.CORS(
        handlers.AllowedHeaders([]string{"X-Requested-With", "Content-Type", "Authorization"}),
        handlers.AllowedMethods([]string{"GET", "POST", "PUT", "DELETE", "OPTIONS"}),
        handlers.AllowedOrigins([]string{"*"}),
    )

    http.ListenAndServe(":8080", cors(http.DefaultServeMux))
}

在上述代码中，使用handlers.CORS函数设置CORS策略，允许跨域请求。这样可以解决CORS策略限制导致的“bad handshake”错误。