使用goframe框架进行websocket开发相当简单。我们以下通过实现一个简单的echo服务器来演示goframe框架的websocket的使用（客户端使用HTML5实现）。

HTML5客户端

先上H5客户端的代码

  1. <!DOCTYPE html>
  2. <html lang="zh">
  3. <head>
  4.     <title>gf websocket echo server</title>
  5.      <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
  6.     <link rel="stylesheet" href="//cdn.bootcss.com/bootstrap/3.3.5/css/bootstrap.min.css">
  7.     <script src="//cdn.bootcss.com/jquery/1.11.3/jquery.min.js"></script>
  8. </head>
  9. <body>
  10. <div class="container">
  11.     <div class="list-group" id="divShow"></div>
  12.     <div>
  13.         <div><input class="form-control" id="txtContent" autofocus placeholder="请输入发送内容"></div>
  14.         <div><button class="btn btn-default" id="btnSend" style="margin-top:15px">发 送</button></div>
  15.     </div>
  16. </div>
  17. </body>
  18. </html>
  20. <script type="application/javascript">
  21.     // 显示提示信息
  22.     function showInfo(content) {
  23.         $("<div class=\"list-group-item list-group-item-info\">" + content + "</div>").appendTo("#divShow")
  24.     }
  25.     // 显示警告信息
  26.     function showWaring(content) {
  27.         $("<div class=\"list-group-item list-group-item-warning\">" + content + "</div>").appendTo("#divShow")
  28.     }
  29.     // 显示成功信息
  30.     function showSuccess(content) {
  31.         $("<div class=\"list-group-item list-group-item-success\">" + content + "</div>").appendTo("#divShow")
  32.     }
  33.     // 显示错误信息
  34.     function showError(content) {
  35.         $("<div class=\"list-group-item list-group-item-danger\">" + content + "</div>").appendTo("#divShow")
  36.     }
  38.     $(function () {
  39.         const url = "ws://127.0.0.1:8199/ws";
  40.         let ws  = new WebSocket(url);
  41.         try {
  42.             // ws连接成功
  43.             ws.onopen = function () {
  44.                 showInfo("WebSocket Server [" + url +"] 连接成功！");
  45.             };
  46.             // ws连接关闭
  47.             ws.onclose = function () {
  48.                 if (ws) {
  49.                     ws.close();
  50.                     ws = null;
  51.                 }
  52.                 showError("WebSocket Server [" + url +"] 连接关闭！");
  53.             };
  54.             // ws连接错误
  55.             ws.onerror = function () {
  56.                 if (ws) {
  57.                     ws.close();
  58.                     ws = null;
  59.                 }
  60.                 showError("WebSocket Server [" + url +"] 连接关闭！");
  61.             };
  62.             // ws数据返回处理
  63.             ws.onmessage = function (result) {
  64.                 showWaring(" > " + result.data);
  65.             };
  66.         } catch (e) {
  67.             alert(e.message);
  68.         }
  70.         // 按钮点击发送数据
  71.         $("#btnSend").on("click", function () {
  72.             if (ws == null) {
  73.                 showError("WebSocket Server [" + url +"] 连接失败，请F5刷新页面!");
  74.                 return;
  75.             }
  76.             const content = $.trim($("#txtContent").val()).replace("/[\n]/g", "");
  77.             if (content.length <= 0) {
  78.                 alert("请输入发送内容!");
  79.                 return;
  80.             }
  81.             $("#txtContent").val("")
  82.             showSuccess(content);
  83.             ws.send(content);
  84.         });
  86.         // 回车按钮触发发送点击事件
  87.         $("#txtContent").on("keydown", function (event) {
  88.             if (event.keyCode === 13) {
  89.                 $("#btnSend").trigger("click");
  90.             }
  91.         });
  92.     })
  94. </script>

注意我们这里的服务端连接地址为：ws://127.0.0.1:8199/ws。

客户端的功能很简单，主要实现了这几个功能：

  • 与服务端websocket连接状态保持及信息展示；
  • 界面输入内容并发送信息到websocket服务端；
  • 接收到websocket的返回信息后回显在界面上；

WebSocket服务端

  1. package main
  3. import (
  4.     "github.com/gogf/gf/v2/frame/g"
  5.     "github.com/gogf/gf/v2/net/ghttp"
  6.     "github.com/gogf/gf/v2/os/gctx"
  7.     "github.com/gogf/gf/v2/os/gfile"
  8.     "github.com/gogf/gf/v2/os/glog"
  9. )
  11. var ctx = gctx.New()
  13. func main() {
  14.     s := g.Server()
  15.     s.BindHandler("/ws", func(r *ghttp.Request) {
  16.         ws, err := r.WebSocket()
  17.         if err != nil {
  18.             glog.Error(ctx, err)
  19.             r.Exit()
  20.         }
  21.         for {
  22.             msgType, msg, err := ws.ReadMessage()
  23.             if err != nil {
  24.                 return
  25.             }
  26.             if err = ws.WriteMessage(msgType, msg); err != nil {
  27.                 return
  28.             }
  29.         }
  30.     })
  31.     s.SetServerRoot(gfile.MainPkgPath())
  32.     s.SetPort(8199)
  33.     s.Run()
  34. }

可以看到，服务端的代码相当简单，这里需要着重说明的是这几个地方：

  1. WebSocket方法

websocket服务端的路由注册方式和普通的http回调函数注册方式一样，但是在接口处理中我们需要通过ghttp.Request.WebSocket方法（这里直接使用指针对象r.WebSocket()）将请求转换为websocket操作，并返回一个WebSocket对象，该对象用于后续的websocket通信操作。当然，如果客户端请求并非为websocket操作时，转换将会失败，该方法会返回错误信息，使用时请注意判断方法的error返回值。

  1. ReadMessage & WriteMessage

读取消息以及写入消息对应的是websocket的数据读取以及写入操作(ReadMessage & WriteMessage)，需要注意的是这两个方法都有一个msgType的变量，表示请求读取及写入数据的类型，常见的两种数据类型为：字符串数据或者二进制数据。在使用过程中，由于接口双方都会约定统一的数据格式，因此读取和写入的msgType几乎都是一致的，所以在本示例中的返回消息时，数据类型参数直接使用的是读取到的msgType。

HTTPS的WebSocket

如果需要支持HTTPS的WebSocket服务，只需要依赖的WebServer支持HTTPS即可，访问的WebSocket地址需要使用 wss:// 协议访问。以上客户端HTML5页面中的WebSocket访问地址需要修改为：wss://127.0.0.1:8199/wss。服务端示例代码：

  1. package main
  3. import (
  4.     "github.com/gogf/gf/v2/frame/g"
  5.     "github.com/gogf/gf/v2/net/ghttp"
  6.     "github.com/gogf/gf/v2/os/gctx"
  7.     "github.com/gogf/gf/v2/os/gfile"
  8.     "github.com/gogf/gf/v2/os/glog"
  9. )
  11. var ctx = gctx.New()
  13. func main() {
  14.     s := g.Server()
  15.     s.BindHandler("/wss", func(r *ghttp.Request) {
  16.         ws, err := r.WebSocket()
  17.         if err != nil {
  18.             glog.Error(ctx, err)
  19.             r.Exit()
  20.         }
  21.         for {
  22.             msgType, msg, err := ws.ReadMessage()
  23.             if err != nil {
  24.                 return
  25.             }
  26.             if err = ws.WriteMessage(msgType, msg); err != nil {
  27.                 return
  28.             }
  29.         }
  30.     })
  31.     s.SetServerRoot(gfile.MainPkgPath())
  32.     s.EnableHTTPS("../../https/server.crt", "../../https/server.key")
  33.     s.SetPort(8199)
  34.     s.Run()
  35. }

示例结果展示

我们首先执行示例代码main.go，随后访问页面 http://127.0.0.1:8199/，随意输入请求内容并提交，随后在服务端关闭程序。可以看到，页面会回显提交的内容信息，并且即时展示websocket的连接状态的改变，当服务端关闭时，客户端也会即时地打印出关闭信息。

WebSocket服务 - 图1

Websocket安全校验

GoFrame框架的websocket模块并不会做同源检查(origin)，也就是说，这种条件下的websocket允许完全跨域。

安全的校验需要由业务层来处理，安全校验主要包含以下几个方面：

  1. origin的校验: 业务层在执行r.WebSocket()之前需要进行origin同源请求的校验；或者按照自定义的处理对请求进行校验(如果请求提交参数)；如果未通过校验，那么调用r.Exit()终止请求。
  2. websocket通信数据校验: 数据通信往往都有一些自定义的数据结构，在这些通信数据中加上鉴权处理逻辑；

WebSocket Client 客户端

  1.  package main
  3. import (
  4.     "crypto/tls"
  5.     "fmt"
  6.     "net/http"
  7.     "time"
  9.     "github.com/gogf/gf/v2/net/gclient"
  10.     "github.com/gorilla/websocket"
  11. )
  13. func main() {
  14.     client := gclient.NewWebSocket()
  15.     client.HandshakeTimeout = time.Second    // 设置超时时间
  16.     client.Proxy = http.ProxyFromEnvironment // 设置代理
  17.     client.TLSClientConfig = &tls.Config{}   // 设置 tls 配置
  19.     conn, _, err := client.Dial("ws://127.0.0.1:8199/ws", nil)
  20.     if err != nil {
  21.         panic(err)
  22.     }
  23.     defer conn.Close()
  25.     err = conn.WriteMessage(websocket.TextMessage, []byte("hello word"))
  26.     if err != nil {
  27.         panic(err)
  28.     }
  30.     mt, data, err := conn.ReadMessage()
  31.     if err != nil {
  32.         panic(err)
  33.     }
  34.     fmt.Println(mt, string(data))
  35. }