Lua Web快速开发指南(8) - 提供Websocket服务

Websocket的技术背景

WebSocket是一种在单个TCP连接上进行全双工通信的协议, WebSocket通信协议于2011年被IETF定为标准RFC 6455并由RFC7936补充规范.

WebSocket使得客户端和服务器之间的数据交换变得更加简单, 使用WebSocket的API只需要完成一次握手就直接可以创建持久性的连接并进行双向数据传输.

WebSocket支持的客户端不仅限于浏览器(Web应用), 在现今应用市场内的众多App客户端的长连接推送服务都有一大部分是基于WebSocket协议来实现交互的.

Websocket由于使用HTTP协议升级而来, 在协议交互初期需要根据正常HTTP协议交互流程. 因此, Websocket也很容易建立在SSL数据加密技术的基础上进行通信.

协议

WebSocket与HTTP协议实现类似但也略有不同. 前面提到: WebSocket协议在进行交互之前需要进行握手, 握手协议的交互就是利用HTTP协议升级而来.

众所周知, HTTP协议是一种无状态的协议. 对于这种建立在请求->回应模式之上的连接, 即使在HTTP/1.1的规范上实现了Keep-alive也避免不了这个问题.

所以, Websocket通过HTTP/1.1协议的101状态码进行协议升级协商, 在服务器支持协议升级的条件下将回应升级请求来完成HTTP->TCP的协议升级.

原理

客户端将在经过TCP3次握手之后发送一次HTTP升级连接请求, 请求中不仅包含HTTP交互所需要的头部信息, 同时也会包含Websocket交互所独有的加密信息.

当服务端在接受到客户端的协议升级请求的时候, 各类Web服务实现的实际情况, 对其中的请求版本、加密信息、协议升级详情进行判断. 错误(无效)的信息将会被拒绝.

在两端确认完成交互之后, 双方交互的协议将会从抛弃原有的HTTP协议转而使用Websocket特有协议交互方式. 协议规范可以参考RFC文档.

优势

在需要消息推送、连接保持、交互效率等要求下, 两种协议的转变将会带来交互方式的不同.

首先, Websocket协议使用头部压缩技术将头部压缩成2-10字节大小并且包含数据载荷长度, 这显著减少了网络交互的开销并且确保信息数据完整性.

如果假设在一个稳定(可能)的网络环境下将尽可能的减少连接建立开销、身份验证等带来的网络开销, 同时还能拥有比HTTP协议更方便的数据包解析方式.

其次, 由于基于Websocket的协议的在请求->回应上是双向的, 所以不会出现多个请求的阻塞连接的情况. 这也极大程度上减少了正常请求延迟的问题.

最后, Websocket还能给予开发者更多的连接管控能力: 连接超时、心跳判断等. 在合理的连接管理规划下, 这可提供使用者更优质的开发方案.

API

cf框架中的httpd库内置了Websocket路由, 提供了上述Websocket连接管理能力.

Websocket路由需要开发者提供一个lua版的class对象来抽象路由处理的过程, 这样的抽象能简化代码编写难度.

lua class

class 意译为'类'. 是对'对象'的一种抽象描述, 多用于各种面相对象编程语言中. lua没有原生的class类型, 但是提供了基本构建的元方法.

cf为了方便描述内置对象与内置库封装, 使用lua table的相关元方法建立了最基本的class模型. 几乎大部分内置库都依赖cf的class库.

同时为了简化class的学习成本, 去除了class原本拥有的'多重继承'概念. 将其仅作为类定义, 用于完成从class->object的初始化工作.

更多关于class的详情, 请参考Wiki中关于class库的文档.

Websocket 相关的API

现在我们开始学习Websocket与之相关的API

WebSocket:ctor(opt)

初始化Websocket对象, Websocket客户端连接建立完成之前被调用.

此方法在on_open方法之前被调用, 一般用于告诉httpd应该如何怎么进行数据包交互.

  1.   function websocket:ctor (opt)
  2.     self.ws = opt.ws             -- websocket对象
  3.     self.send_masked = false     -- 掩码(默认为false, 不建议修改或者使用)
  4.     self.max_payload_len = 65535 -- 最大有效载荷长度(默认为65535, 不建议修改或者使用)
  5.   end

WebSocket:on_open()

当有连接初始化完成之后此方法会被调用. 此方法虽然与Websocket:ctor类似, 但一般在仅用于内部服务初始化的时候使用.

  1.   function websocket:on_open()
  2.     local cf = require "cf"
  3.     self.timer = cf.at(0.01, function ( ... ) -- 启动一个循环定时器
  4.       self.count = self.count + 1
  5.       self.ws:send(tostring(self.count))
  6.     end)
  7.   end

WebSocket:on_message(data, type)

此方法将在用户主动发送text/binary数据的时候被回调.

参数data是一个字符串类型的playload; type是一个boolean类型变量, true为binary类型, 否则为text类型.

  1.   function websocket:on_message(data, typ)
  2.     print('on_message', self.ws, data, typ)
  3.     self.ws:send('welcome')
  4.     -- self.ws:close(data)
  5.   end

WebSocket:on_error(error)

此方法在发生协议错误与未知错误的时候会被回调, 参数error是字符串类型的错误信息.

通常情况下我们不会用到这个方法.

  1.   function websocket:on_error(error)
  2.     print('on_error:', error)
  3.   end

WebSocket:on_close(data)

此方法在连接关闭时回调. data为关闭连接时发送过来到数据, 所以data可能为nil.

无论什么情况, 在连接被关闭的时候都将会调用此方法, 而此方法通常的作用是清理数据.

  1.   function websocket:on_close(data)
  2.     if self.timer then -- 清理定时器
  3.       print("清理定时器")
  4.       self.timer:stop()
  5.       self.timer = nil
  6.     end
  7.   end

更多API

更多关于Websocket的API请参考Wiki的文档.

开始实践

建立路由

首先! 让我们在script目录下新建2个文件: main.lua与ws.lua, 然后分别填入下列内容:

  1.   -- app/script/ws.lua
  2.   local class = require "class"
  4.   local ws = class("websocket")
  6.   function ws:ctor(opt)
  7.     self.ws = opt.ws
  8.     self.send_masked = false
  9.     self.max_payload_len = 65535
  10.   end
  12.   function ws:on_open()
  14.   end
  16.   function ws:on_message(data, typ)
  18.   end
  20.   function ws:on_error(error)
  22.   end
  24.   function ws:on_close(data)
  26.   end
  28.   return ws
  1.   -- main.lua
  2.   local httpd = require "httpd"
  3.   local app = httpd:new("httpd")
  5.   app:ws('/ws', require "ws")
  7.   app:listen("", 8080)
  9.   app:run()

我们使用httpd库启动了一个Web Server, 同时将ws.lua内的class对象注册为Websocket处理对象.

同时, 我们在Websocket:ctor方法内部, 为Websocket路由的连接初始化了一些连接信息. 以上为最精简的Websocket路由处理.

开始编写一个简单的Demo

首先, 我们在ws:on_open方法内部添加一段定时器代码, 这个定时器用于在连接建立完成之后持续向开发者推送递增消息.

  1.   function ws:on_open()
  2.     local cf = require "cf"
  3.     local count = 1
  4.     self.timer = cf.at(3, function(...)
  5.       self.ws:send(tostring(count))
  6.       count = count + 1
  7.     end)
  8.     print(self.ws, "客户端连接成功.")
  9.   end

然后, 我们为ws:on_close方法添加一段定时器销毁代码用于防止内存泄露.

  1.   function ws:on_close(data)
  2.     if self.timer then
  3.       self.timer:stop()
  4.       self.timer = nil
  5.     end
  6.     print(self.ws, "客户端关闭了连接.")
  7.   end

最后, 为每次客户端发送过来的消息执行一次echo回应.

  1.   function ws:on_message(data, type)
  2.     self.ws:send(data, type)
  3.     print(self.ws, "接受到客户端发送的消息.", data)
  4.   end

运行cfadmin,

让我们使用chrome浏览器点击这里, 使用提取码cgwr下载Websocket客户端插件并且安装.

然后打开刚刚下载的websocket client插件并在其Websocket Address处输入我们的连接地址进行连接并且查看服务端的推送消息.

WebSocket

开发者可以在运行cfadmin的终端查看连接建立的消息打印.

  1.   [candy@MacBookPro:~/Documents/core_framework] $ ./cfadmin
  2.   [2019/06/18 21:48:36] [INFO] httpd正在监听: 0.0.0.0:8080
  3.   [2019/06/18 21:48:36] [INFO] httpd正在运行Web Server服务...
  4.   [2019/06/18 21:48:39] - ::1 - ::1 - /ws - GET - 101 - req_time: 0.000080/Sec
  5.   websocket-server: 0x7f9495e01200    客户端连接成功.
  6.   websocket-server: 0x7f9495e01200    接受到客户端发送的消息.    hello world
  7.   websocket-server: 0x7f9495e01200    客户端关闭了连接.

完整的代码

  1.   -- main.lua
  2.   local httpd = require "httpd"
  3.   local app = httpd:new("httpd")
  5.   app:ws('/ws', require "ws")
  7.   app:listen("", 8080)
  9.   app:run()
  1.   -- app/script/ws.lua
  2.   local class = require "class"
  4.   local ws = class("websocket")
  6.   function ws:ctor(opt)
  7.     self.ws = opt.ws
  8.     self.send_masked = false
  9.     self.max_payload_len = 65535
  10.   end
  12.   function ws:on_open()
  13.     local cf = require "cf"
  14.     local count = 1
  15.     self.timer = cf.at(3, function(...)
  16.       self.ws:send(tostring(count))
  17.       count = count + 1
  18.     end)
  19.     print(self.ws, "客户端连接成功.")
  20.   end
  22.   function ws:on_message(data, type)
  23.     self.ws:send(data, type)
  24.     print(self.ws, "接受到客户端发送的消息.", data)
  25.   end
  27.   function ws:on_error(error)
  29.   end
  31.   function ws:on_close(data)
  32.     if self.timer then
  33.       self.timer:stop()
  34.       self.timer = nil
  35.     end
  36.     print(self.ws, "客户端关闭了连接.")
  37.   end
  39.   return ws

继续学习

下一章我们将学习cf框架内置的异步库