使用gf框架进行websocket开发相当简单！我们以下通过实现一个简单的echo服务器来演示gf框架的websocket的使用（客户端使用HTML5实现）。示例代码：geg/net/ghttp/websocket/echo

HTML5客户端

先上H5客户端的代码

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

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

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

WebSocket服务端

  1. package main
  3. import (
  4.     "gitee.com/johng/gf/g"
  5.     "gitee.com/johng/gf/g/net/ghttp"
  6. )
  8. func main() {
  9.     s := g.Server()
  10.     s.BindHandler("/ws", func(r *ghttp.Request) {
  11.         ws, _ := r.WebSocket()
  12.         for {
  13.             msgType, msg, err := ws.ReadMessage()
  14.             if err != nil {
  15.                 return
  16.             }
  17.             if err = ws.WriteMessage(msgType, msg); err != nil {
  18.                 return
  19.             }
  20.         }
  21.     })
  22.     s.SetPort(8199)
  23.     s.Run()
  24. }

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

  1. WebSocket方法
    websocket服务端的路由注册方式和普通的http回调函数注册方式一样，但是在接口处理中我们需要通过ghttp.Request.WebSocket方法（这里直接使用指针对象r.WebSocket()）将请求转换为websocket操作，并返回一个WebSocket对象，该对象用于后续的websocket通信操作。当然，如果客户端请求并非为websocket操作时，转换将会失败，该方法会返回错误信息，使用时请注意判断方法的error返回值。
  2. ReadMessage & WriteMessage
    读取消息以及写入消息对应的是websocket的数据读取以及写入操作(ReadMessage & WriteMessage)，需要注意的是这两个方法都有一个msgType的变量，表示请求读取及写入数据的类型，常见的两种数据类型为：字符串数据或者二进制数据。在使用过程中，由于接口双方都会约定统一的数据格式，因此读取和写入的msgType几乎都是一致的，所以在本示例中的返回消息时，数据类型参数直接使用的是读取到的msgType。

示例结果展示

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

WebSocket服务 - 图1