臭小子のBlog

Go 语言 WebSocket 库

2025 年 03 月 29 日

47 次浏览

4203字数

github.com/gorilla/websocket 是一个非常流行的 Go 语言 WebSocket 库，它允许开发者通过 WebSocket 协议实现双向通信。WebSocket 协议广泛应用于实时应用，如聊天应用、在线游戏等。下面我将通过详细解释 gorilla/websocket 包的主要方法，逐行给你讲解代码，并结合原文档进行解释，帮助你理解每个方法、参数和返回值。

1. 安装 Gorilla WebSocket

首先，如果你还没有安装 gorilla/websocket，可以通过下面的命令进行安装：

go get github.com/gorilla/websocket

2. Gorilla WebSocket 常用方法

在 github.com/gorilla/websocket 包中，最常用的方法是创建 WebSocket 连接、读取消息、写入消息和关闭连接。以下是一些主要的方法。

2.1 `Dial`

func Dial(url string, protocol []string) (*Conn, *http.Response, error)

url: 要连接的 WebSocket 服务器地址，通常是 ws:// 或 wss:// 开头的 URL（例如，ws://example.com/socket）。
protocol: 一个字符串切片，表示请求中要使用的子协议（这个参数可以为 nil）。
返回值:
- Conn: 返回一个 Conn 类型的实例，代表 WebSocket 连接。你可以通过它来读取和写入消息。
- http.Response: 返回 HTTP 响应。
- error: 如果连接失败，返回错误信息。

解释: Dial 方法用于发起 WebSocket 连接。当你需要连接 WebSocket 服务器时，可以调用这个方法。

示例：

package main

import (
    "fmt"
    "log"
    "github.com/gorilla/websocket"
)

func main() {
    url := "ws://example.com/socket"
    conn, _, err := websocket.DefaultDialer.Dial(url, nil)
    if err != nil {
        log.Fatal("Dial error:", err)
    }
    defer conn.Close()
    fmt.Println("Successfully connected!")
}

2.2 `ReadMessage`

func (c *Conn) ReadMessage() (messageType int, p []byte, err error)

返回值:
- messageType: 消息类型，通常是 websocket.TextMessage 或 websocket.BinaryMessage。
- p: 接收到的消息数据，类型是 []byte。
- err: 错误信息，如果没有错误则为 nil。

解释: ReadMessage 用于从 WebSocket 连接中读取消息。当连接中有消息时，它会被读取并返回。消息类型通常是文本消息或二进制消息。

示例：

package main

import (
    "fmt"
    "log"
    "github.com/gorilla/websocket"
)

func main() {
    url := "ws://example.com/socket"
    conn, _, err := websocket.Dial(url, nil)
    if err != nil {
        log.Fatal("Dial error:", err)
    }
    defer conn.Close()

    messageType, message, err := conn.ReadMessage()
    if err != nil {
        log.Fatal("ReadMessage error:", err)
    }
    fmt.Printf("Received message of type %d: %s\n", messageType, message)
}

2.3 `WriteMessage`

func (c *Conn) WriteMessage(messageType int, p []byte) error

messageType: 消息类型，通常是 websocket.TextMessage 或 websocket.BinaryMessage。
p: 要发送的消息内容，类型为 []byte，可以是文本或二进制数据。
返回值:
- error: 如果写入过程中发生错误，会返回一个错误；如果没有错误，则返回 nil。

解释: WriteMessage 用于向 WebSocket 连接写入消息。你可以将文本消息或二进制消息发送到服务器。

示例：

package main

import (
    "fmt"
    "log"
    "github.com/gorilla/websocket"
)

func main() {
    url := "ws://example.com/socket"
    conn, _, err := websocket.Dial(url, nil)
    if err != nil {
        log.Fatal("Dial error:", err)
    }
    defer conn.Close()

    message := []byte("Hello, WebSocket!")
    err = conn.WriteMessage(websocket.TextMessage, message)
    if err != nil {
        log.Fatal("WriteMessage error:", err)
    }
    fmt.Println("Message sent!")
}

2.4 `Close`

func (c *Conn) Close() error

返回值:
- error: 如果关闭连接时发生错误，返回一个错误；否则返回 nil。

解释: Close 用于关闭 WebSocket 连接。当你不再需要连接时，应该调用这个方法来关闭连接，释放资源。

示例：

package main

import (
    "fmt"
    "log"
    "github.com/gorilla/websocket"
)

func main() {
    url := "ws://example.com/socket"
    conn, _, err := websocket.Dial(url, nil)
    if err != nil {
        log.Fatal("Dial error:", err)
    }
    defer func() {
        err := conn.Close()
        if err != nil {
            log.Fatal("Close error:", err)
        }
        fmt.Println("Connection closed!")
    }()

    // 这里可以执行读写操作
}