如何在Golang中启动和关闭Websocket连接

时间：2023-04-15 03:14

Websocket是一种能够在客户端和服务器之间进行实时双向通信的网络协议。它可以在不使用HTTP轮询的情况下，同时实现高效的数据传输和低延迟的交互效果。Golang是一种开源的高性能编程语言，拥有卓越的并发性能和优秀的代码质量。在Websocket通信中，Golang也有着优秀的实现方式。本文将介绍如何在Golang中启动和关闭Websocket连接。

Websocket在Golang中的实现

在Golang中实现Websocket，需要进行以下几个步骤：

导入相应的包

在Go语言中，实现Websocket需要WebSocket和Http包的支持。代码如下：

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

其中，github.com/gorilla/websocket是一个优秀的、支持多种协议的WebSocket包。它包含了一些WebSocket相关的结构体和函数，我们可以用它来快速地实现一个WebSocket的连接。

定义WebSocket连接处理函数

在处理WebSocket连接的函数中，我们需要完成以下几个任务：

a. 定义WebSocket升级

对于一个HTTP请求，如果需要升级为WebSocket连接，我们需要对其进行处理，并返回相关的升级请求。代码如下：

var upgrader = websocket.Upgrader{    ReadBufferSize:  1024,    WriteBufferSize: 1024,    CheckOrigin: func(r *http.Request) bool {        return true    },}func websocketHandler(w http.ResponseWriter, r *http.Request) {    // 升级为WebSocket连接    ws, err := upgrader.Upgrade(w, r, nil)    if err != nil {        log.Println(err)        return    }        // 实现WebSocket通信    ...}

在这段代码中，我们使用了Upgrader结构体，它是gorilla/websocket库中实现WebSocket升级的函数。

Upgrader包含了读写缓存区大小和CheckOrigin函数。CheckOrigin用于检查请求是否是来自一个合法的源。如果该方法返回false，那么升级请求就会被拒绝。由于我们在本示例中并不需要检查合法性，因此我们的CheckOrigin总是返回true。

在调用Upgrader.Upgrade方法后，我们会得到一个WebSocket对象ws。在该对象上，我们可以调用ReadMessage和WriteMessage等方法，完成后续的WebSocket通信。

b. 读取WebSocket消息

在得到WebSocket连接之后，我们需要不断地读取客户端发送过来的消息。读取WebSocket消息可以使用ReadMessage方法。代码如下：

func websocketHandler(w http.ResponseWriter, r *http.Request) {    ...        for {        // 读取消息        _, message, err := ws.ReadMessage()        if err != nil {            log.Println(err)            break        }                // 处理消息        ...    }}

在这段代码中，我们利用for循环来不断地从WebSocket中读取消息。如果读取失败，则说明WebSocket连接已经关闭，我们退出循环。

c. 发送WebSocket消息

在处理完客户端发送的消息之后，我们可能需要将一些处理结果发送给客户端。发送WebSocket消息可以使用WriteMessage方法。代码如下：

func websocketHandler(w http.ResponseWriter, r *http.Request) {    ...        for {        ...                // 发送消息        err = ws.WriteMessage(websocket.TextMessage, []byte(reply))        if err != nil {            log.Println(err)            break        }    }}

在这段代码中，我们通过WriteMessage方法向客户端发送了一个消息。该方法的第一个参数是消息的类型，我们可以指定为TextMessage或BinaryMessage；第二个参数是一个字节数组，它包含了要发送的数据。

启动WebSocket服务

在完成以上步骤之后，我们就可以启动一个WebSocket服务。代码如下：

func main() {    http.HandleFunc("/ws", websocketHandler)    log.Println("Server started at http://127.0.0.1:8080")    http.ListenAndServe(":8080", nil)}

在这段代码中，我们调用了http.HandleFunc函数，将"/ws"路径映射到我们的WebSocket处理函数websocketHandler。最后，我们调用http.ListenAndServe启动服务。

关闭WebSocket连接

在使用WebSocket之后，我们需要手动关闭连接。正常地关闭WebSocket连接需要注意以下几点：

a. 服务器端主动关闭

当服务器端需要关闭WebSocket连接时，可以调用WebSocket.Close方法。代码如下：

func websocketHandler(w http.ResponseWriter, r *http.Request) {    defer ws.Close() // 关闭WebSocket连接        for {        ...    }}

在该代码中，我们使用defer语句在websocket函数结束时，自动关闭WebSocket连接。

b. 客户端主动关闭

当客户端需要关闭WebSocket连接时，可以向服务器发送一个Close消息。服务器会收到Close消息，并在收到消息后主动关闭WebSocket连接。

我们可以在服务器端的websocket函数中增加一个处理Close消息的分支。代码如下：

func websocketHandler(w http.ResponseWriter, r *http.Request) {    ...        for {        // 读取消息        messageType, message, err := ws.ReadMessage()        if err != nil {            log.Println(err)            break        }                // 处理消息        switch messageType {        case websocket.CloseMessage:            // 收到关闭消息，关闭连接            return        case websocket.TextMessage:            // 收到文本消息，处理消息            ...        case websocket.BinaryMessage:            ...        }    }        // 关闭WebSocket连接    ws.Close()}

在该代码中，我们增加了一个消息类型为CloseMessage的处理分支。在收到Close消息之后，我们立即退出websocket函数，并关闭WebSocket连接。

c. 异常关闭

当WebSocket连接发生异常时，需要及时关闭连接。例如当网络断开、客户端与服务器端连接超时等情况下，都需要关闭WebSocket连接。

我们可以在websocket函数中捕捉异常，并在捕捉到异常时关闭WebSocket连接。代码如下：

func websocketHandler(w http.ResponseWriter, r *http.Request) {    defer ws.Close() // 当函数退出时关掉WebSocket连接        for {        _, message, err := ws.ReadMessage()        if err != nil {            if websocket.IsUnexpectedCloseError(err, websocket.CloseGoingAway) {                log.Printf("error: %v", err)            }            break        }                // 处理消息        ...    }}

在该代码中，我们通过defer语句在websocket函数返回之前手动关闭WebSocket连接。在ReadMessage操作中，我们增加了对异常错误的捕捉并进行日志输出。

总结

在Golang中，可以通过gorilla/websocket库来实现Websocket连接。我们可以在WebSocket通信的处理函数中，使用Upgrader结构体将HTTP协议升级为WebSocket。在WebSocket连接时，我们需要实现一些WebSocket消息的读取和发送操作。

为了确保WebSocket连接的正常关闭，我们需要注意以下几点：