Golang 如何使用 Websocket

本文将介绍如何使用 Golang 实现 WebSocket 通信,包括连接建立、消息发送等内容。

用 Apifox,节省研发团队的每一分钟

Golang 如何使用 Websocket

免费使用 Apifox

相关推荐

最新文章

API

一体化协作平台

API 设计

API 文档

API 调试

自动化测试

API Mock

API Hub

立即体验 Apifox
目录

Golang 中使用 Websocket

引 WebSocket 包

在 Go 中创建 WebSocket 服务需要使用 net/http 包和 golang.org/x/net/websocket 包。

建议使用 go get 命令安装 golang.org/x/net/websocket 包。

import (
    "net/http"
    "golang.org/x/net/websocket"
    "fmt"
    "time"
)

创建 WebSocket 处理程序

可以实现 WebSocket 服务的基本步骤是创建处理程序函数,该函数确定如何处理 WebSocket 连接并发送数据。

func websocketHandler(ws *websocket.Conn) {
    for {
        // 获取时间戳
        timestamp := time.Now().Unix()

        // 将时间戳转换为字符串并发送到前端
        websocket.Message.Send(ws, fmt.Sprintf("%d", timestamp))

        // 等待一秒钟再继续执行循环
        time.Sleep(time.Second)
    }
}

以上定义的 websocketHandler 函数将在每个 WebSocket 连接上执行,并且将发送当前时间戳值到客户端,使用函数 time.Now() 获取时间戳。这个 for 循环每秒钟执行一次,以持续向前端通过 WebSocket 发送时间戳。

设置 WebSocket 连接

下一步是将上一节的函数与一个 WebSocket 端点连接在一起,以此创建 Connection。

func main() {
    // 将websocket处理程序与相应的路由链接
    http.Handle("/websocket", websocket.Handler(websocketHandler))
    
    // 将HTTP服务器监听在端口8000上,准备接收WebSocket连接
    err := http.ListenAndServe(":3001", nil)
    
    if err != nil {
        panic("fail" + err.Error())
    }
}

在这里,http.Handle() 函数将映射到 /ws 路由并将其指定为 WebSocket 端点。这个 http.ListenAndServe() 函数将启动一个 HTTP 服务器并等待 Incoming WebSocket 连接来对它们进行处理。

启动 go 服务

最后需要启动一下 go 服务:

go run main.go

前端页面连接 WebSocket

页面编写

我们需要创建一个 index.html,并写入以下代码。

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>Document</title>
  <script>
    window.onload = () => {
        if ('WebSocket' in window) {
            // 创建websocket连接
            let ws = new WebSocket('ws://127.0.0.1:3001/websocket');
            // 成功连接的时候推送一条消息,此时服务端就可以开始推送数据了
            ws.onopen = () => {
                console.log('websocket success---');
                ws.send('success');
            }
            ws.onmessage = (message) => {
                let data = message.data;
                console.log('get websocket message---', data);
            }
            ws.onerror = () => {
                console.error('websocket fail');
            }
        } else {
            console.error('dont support websocket');
        };
    };
</script>

</head>
<body>
  
</body>
</html>

启动页面

在 index.html 右键,并打开此文件。

启动页面

查看效果

可以看到后端先接收到前端的信息,open 建立成功。

然后建立连接后,后端一直在为前端输出信息。

查看效果

Apifox 调试 WebSocket 服务

如果你正在编写 WebSocket 服务并需要进行调试,我建议你使用 Apifox,这款工具可以完美调试 WebSocket 服务~

谷歌插件

Apifox 有 Web端 和 客户端,如果你使用的是 Web端,想要调试本地服务,需要安装 Apifox 的 谷歌插件。

下载地址:Apifox 谷歌浏览器插件

Apifox 谷歌浏览器插件

新建 WebSocket 请求

WebSocket 是客户端和服务端之间的长链接,因此你需要在 Apifox 中创建一个 WebSocket 请求,以便跳转到 Apifox 界面并填写相应的请求信息。

  • 点击创建按钮
  • 填入 WebSocket 服务的地址
  • 可以选择填写 Message 和 Params
新建 WebSocket 请求

Message 和 Params

我们可以使用 Apifox 点击发送按钮向服务端进行发送 Message、Params。

Message 和 Params

与 WebSocket 服务通信

发送之后,服务端也可以向客户端发送信息,例如我这里,我设置服务端每秒向客户端发送当时的时间戳~

这就是 Apifox 的 WebSocket 功能,非常方便。

与 WebSocket 服务通信

与 WebSocket 断开连接

如何不想连接了,可以点击断开按钮。

点击断开

即可断开连接

与 WebSocket 断开连接

关于 Apifox

  • 集成了 API 文档、API 调试、API Mock、API 自动化测试 API 一体化协作平台
  • 拥有更先进的 API 设计/开发/测试工具
  • Apifox = Postman + Swagger + Mock + JMeter

欢迎体验一下,完全免费的哦:在线使用 Apifox