ZetCode

Go Gorilla WebSocket

最后修改时间 2024 年 4 月 11 日

在本文中,我们将介绍如何使用 Gorilla WebSocket 包处理 websockets。

WebSocket 是一种计算机通信协议,它通过单个 TCP 连接提供全双工通信通道。WebSockets 用于高度交互的应用,如游戏、聊天或股票市场。

Gorilla WebSocket 包提供了 WebSocket 协议的完整且经过测试的实现。

$ go get github.com/gorilla/websocket

此命令安装该软件包。

Gorilla WebSocket 示例

在此示例中,我们创建了一个简单的 websocket 服务器。客户端将是一个使用 JS 代码连接到服务器的浏览器。

main.go
package main

import (
    "fmt"
    "log"
    "net/http"

    "github.com/gorilla/websocket"
)

var upgrader = websocket.Upgrader{
    ReadBufferSize:  1024,
    WriteBufferSize: 1024,
}

func main() {

    http.HandleFunc("/echo", func(w http.ResponseWriter, r *http.Request) {
        conn, err := upgrader.Upgrade(w, r, nil)

        if err != nil {
            log.Fatal(err)
        }

        for {

            msgType, msg, err := conn.ReadMessage()
            if err != nil {
                return
            }

            fmt.Printf("%s sent: %s\n", conn.RemoteAddr(), string(msg))

            if err = conn.WriteMessage(msgType, msg); err != nil {
                return
            }
        }
    })

    http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        http.ServeFile(w, r, "index.html")
    })

    log.Println("Listening...")
    log.Fatal(http.ListenAndServe(":8080", nil))
}

该程序设置了 websocket 端点和一个静态 index.html 页面。

var upgrader = websocket.Upgrader{
    ReadBufferSize:  1024,
    WriteBufferSize: 1024,
}

我们为 upgrader 定义了缓冲区。它为将 HTTP 连接升级到 WebSocket 连接指定参数。

http.HandleFunc("/echo", func(w http.ResponseWriter, r *http.Request) {

我们为 /echo 端点注册了一个处理函数。

conn, err := upgrader.Upgrade(w, r, nil)

我们将 HTTP 服务器连接升级到 WebSocket 协议。

for {

    msgType, msg, err := conn.ReadMessage()
    if err != nil {
        return
    }

    fmt.Printf("%s sent: %s\n", conn.RemoteAddr(), string(msg))

    if err = conn.WriteMessage(msgType, msg); err != nil {
        return
    }
}

我们持续监听通过该 WebSocket 连接发送的任何传入消息。我们使用 ReadMessage 从客户端读取消息。WriteMessage 将消息写回客户端。

http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
    http.ServeFile(w, r, "index.html")
})

我们设置了静态 HTML 主页,我们从中连接到服务器。

到 websocket 端点的连接是从浏览器建立的。

index.html
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
</head>

<body>

    <input id="input" type="text">
    <button onclick="send()">Send</button>
    <pre id="output"></pre>

    <script>
        var input = document.getElementById("input");
        var output = document.getElementById("output");
        var socket = new WebSocket("ws://:8080/echo");

        socket.onopen = () => {
            output.innerHTML += "connected\n";
        };

        socket.onmessage = (e) => {
            output.innerHTML += `{e.data}\n`;
        };

        function send() {
            socket.send(input.value);
            input.value = "";
        }
    </script>
</body>

</html>

在 JS 中,我们使用 WebSocket 类,该类提供了创建和管理到服务器的 WebSocket 连接的 API,以及在连接上发送和接收数据的 API。

来源

Gorilla Websocket - Github 页面

在本文中,我们使用 Gorilla WebSocket 包处理了 websockets。

作者

我叫 Jan Bodnar,是一位充满热情的程序员,拥有丰富的编程经验。自 2007 年以来,我一直在撰写编程文章。至今,我已撰写了 1,400 多篇文章和 8 本电子书。我在编程教学方面拥有十多年的经验。

列出所有 Go 教程