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 是一个比 Postman 更强大的接口测试工具,Apifox = Postman + Swagger + Mock + JMeter。它支持调试 http(s)、WebSocket、Socket、gRPC、Dubbo 、SSE 等多种协议的接口,这使得它成为了一个非常全面的接口测试工具,所以强烈推荐去下载体验!
在 Apifox 中,你需要创建一个 WebSocket 请求以便进入相应的界面进行必要的信息填写。以下是步骤:
- 新建一个 HTTP 项目后,在项目中点击“+”按钮。
- 输入 WebSocket 服务的地址,例如
http://localhost:3000
。 - 选择性地填写要传输的消息(Message)和参数(Params)。
- 填写完必要信息后,点击“保存”按钮以保留本次请求信息,方便下次调用。
要与服务器进行通信,你首先需要建立一个 WebSocket 连接。只需点击“连接”按钮即可。连接成功后,Apifox 会给出提示,同时服务器也会对此作出响应。
成功连接后,你可以使用 Apifox 提供的“发送”按钮,来发送消息和参数给服务器。
发送消息后,服务器同样可以向客户端回传信息,这一功能展示了 Apifox 的 WebSocket 功能的简便性,快去试试吧!