【www.5929.com】WebSocket长连接心跳与短连接,Tornado简单聊天室

python
websocket

在项目中用到socket.io抓牢时推送,遂花了点时间看了socket.io实现,做个简单解析,如有错漏,欢迎指正。

译者说

Tornado 4.3于20一伍年一月七日透露,该版本正式协理Python3.5async/await要害字,并且用旧版本CPython编写翻译Tornado同样可以采纳这多个重点字,那确实是1种提高。其次,那是最终2个支撑Python2.6Python3.2的本子了,在此起彼伏的版本了会移除对它们的相配。今后互联网上还从未Tornado4.3的汉语文档,所以为了让越来越多的意中人能接触并学习到它,作者起来了这一个翻译项目,希望感兴趣的伴儿能够1起加入翻译,项目地址是【www.5929.com】WebSocket长连接心跳与短连接,Tornado简单聊天室。tornado-zh
on
Github,翻译好的文档在Read
the
Docs上直白能够看看。欢迎Issues
or P哈弗。本节感谢@thisisx7翻译

python3知识点

jquery.min.js

www.5929.com 1

安装

1 概述

socket.io是贰个基于WebSocket的CS的实时通信库,它底层基于engine.io。engine.io使用WebSocket和xhr-polling(或jsonp)封装了1套自个儿的商议,在不帮衬WebSocket的低版本浏览器中(援救websocket的浏览器版本见这里)使用了长轮询(long
polling)来替代。socket.io在engine.io的基本功上加码了namespace,room,自动重连等风味。

正文接下去会先不难介绍websocket协议,然后在此基础上教学下engine.io和socket.io协议以及源码分析,后续再经过例子表明socket.io的工作流程。

PS:本节最棒直接在https://tornado-zh.readthedocs.org或者http://tornado.moelove.info/开卷,以赢得越来越好的翻阅体验(格式协理)。原谅本身没排好版QAQ

web服务器代码:

#coding=utf-8

importtornado.websocket

importtornado.web

importtornado.ioloop

importdatetime

classIndexHandler(tornado.web.RequestHandler):

defget(self, *args, **kwargs):

self.render(‘templates/index.html’)

classWebHandler(tornado.websocket.WebSocketHandler):

users =set()#寄存在线用户

defopen(self, *args, **kwargs):

self.users.add(self)#把树立连接后的用户增进到用户容器中

foruserinself.users:#向在线的用户发送进入消息

user.write_message(“[%s]-[%s]-进入聊天室”%
(self.request.remote_ip,

datetime.datetime.now().strftime(“%Y-%m-%d %H:%M:%S”)))

defon_close(self):

self.users.remove(self)# 用户关闭连接后从容器中移除用户

foruserinself.users:

user.write_message(“[%s]-[%s]-离开聊天室”%
(self.request.remote_ip,

datetime.datetime.now().strftime(“%Y-%m-%d %H:%M:%S”)))

defon_message(self, message):

foruserinself.users:#向在线用户发送聊天音讯

user.write_message(“[%s]-[%s]-说:%s”% (self.request.remote_ip,

datetime.datetime.now().strftime(“%Y-%m-%d %H:%M:%S”), message))

defcheck_origin(self, origin):

return True# 允许WebSocket的跨域请求

importos

BASE_DIR = os.path.dirname(__file__)

settings = {

‘static_path’:os.path.join(BASE_DIR,’static’),

“websocket_ping_interval”:1,

“websocket_ping_timeout”:10

}

app = tornado.web.Application([(r’/’,IndexHandler),

(r’/chat’,WebHandler)],

**settings)

app.listen(8009)

tornado.ioloop.IOLoop.instance().start()


pip install websocket-client

2 WebSocket协议

咱俩掌握,在HTTP 协议开发的时候,并不是为着双向通讯程序准备的,早先的
web 应用程序只供给 “请求-响应”
就够了。由于历史原因,在创立拥有双向通讯机制的 web
应用程序时,就只可以接纳 HTTP 轮询的方法,因而发生了 “短轮询” 和
“长轮询”(注意区分短连接和长连接)。

短轮询通过客户端定期轮询来驾驭服务端是还是不是有新的音信发出,缺点也是由此可见,轮询间隔大了则信息不够实时,轮询间隔过小又会损耗过多的流量,增添服务器的担当。长轮询是对短轮询的优化,须要服务端做相应的修改来援助。客户端向服务端发送请求时,若是那时候服务端未有新的新闻发出,并不立刻回去,而是Hang住1段时间等有新的音讯照旧逾期再回到,客户端收到服务器的回答后继续轮询。能够看来长轮询比短轮询能够减去大气失效的央浼,并且客户端接收取新新闻也会实时不少。

固然如此长轮询比短轮询优化了好多,然则每一遍请求照旧都要带上HTTP请求底部,而且在长轮询的连天实现之后,服务器端积累的新音信要等到下次客户端连接时才能传递。越来越好的点子是只用2个TCP连接来兑现客户端和服务端的双向通讯,WebSocket共商就是为此而生。WebSocket是依据TCP的一个单身的协商,它与HTTP协议的绝无仅有涉嫌便是它的抓手请求能够当做二个Upgrade request经由HTTP服务器解析,且与HTTP使用同一的端口。WebSocket暗中认可对日常请求使用80端口,协议为ws://,对TLS加密请求使用4四三端口,协议为wss://

握手是通过2个HTTP Upgrade request始于的,一个伸手和响应底部示例如下(去掉了毫无干系的头顶)。WebSocket握手请求底部与HTTP请求尾部是同盟的(见奥德赛FC261陆)。

## Request Headers ##
Connection: Upgrade
Host: socket.io.demo.com
Origin: http://socket.io.demo.com
Sec-WebSocket-Extensions: permessage-deflate; client_max_window_bits
Sec-WebSocket-Key: mupA9l2rXciZKoMNQ9LphA==
Sec-WebSocket-Version: 13
Upgrade: websocket

## Response Headers ##
101 Web Socket Protocol Handshake
Connection: upgrade
Sec-WebSocket-Accept: s4VAqh7eedG0a11ziQlwTzJUY3s=
Sec-WebSocket-Origin: http://socket.io.demo.com
Server: nginx/1.6.2
Upgrade: WebSocket
  • Upgrade
    是HTTP/一.第11中学规定的用于转移当前连年的应用层协议的底部,表示客户端希望用现有的总是转换成新的应用层协议WebSocket协议。

  • Origin
    用于幸免跨站攻击,浏览器一般会选取那个来标识原始域,对于非浏览器的客户端应用能够依照必要选拔。

  • 请求头中的 Sec-WebSocket-Version
    是WebSocket版本号,Sec-WebSocket-Key
    是用来握手的密钥。Sec-WebSocket-Extensions 和 Sec-WebSocket-Protocol
    是可挑选,暂不研讨。

  • 壹呼百应头中的 Sec-WebSocket-Accept 是将请求头中的 Sec-WebSocket-Key
    的值加上叁个定点魔数258EAFA5-E914-47DA-95CA-C5AB0DC85B11经SHA一+base64编码后收获。总结进程的python代码示例(uwsgi中的完结见
    core/websockets.c的 uwsgi_websocket_handshake函数):

    magic_number = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
    key = 'mupA9l2rXciZKoMNQ9LphA=='
    accept = base64.b64encode(hashlib.sha1(key + magic_number).digest())
    assert(accept == 's4VAqh7eedG0a11ziQlwTzJUY3s=')
    
  • 客户端会检查响应头中的status code 和 Sec-WebSocket-Accept
    值是或不是是期待的值,假诺发现Accept的值不得法只怕状态码不是十一,则不会确立WebSocket连接,也不会发送WebSocket数据帧。

WebSocket研商使用帧(Frame)收发数据,帧格式如下。基于【www.5929.com】WebSocket长连接心跳与短连接,Tornado简单聊天室。安全考量,客户端发送给服务端的帧必须经过4字节的掩码(Masking-key)加密,服务端收到信息后,用掩码对数据帧的Payload
Data举行异或运算解码获得数码(详见uwsgi的 core/websockets.c
中的uwsgi_websockets_parse函数),如若服务端收到未经掩码加密的数据帧,则应当及时关闭该WebSocket。而服务端发给客户端的数额则不须求掩码加密,客户端借使接到了服务端的掩码加密的数码,则也务必关闭它。

 0                   1                   2                   3
      0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
     +-+-+-+-+-------+-+-------------+-------------------------------+
     |F|R|R|R| opcode|M| Payload len |    Extended payload length    |
     |I|S|S|S|  (4)  |A|     (7)     |             (16/64)           |
     |N|V|V|V|       |S|             |   (if payload len==126/127)   |
     | |1|2|3|       |K|             |                               |
     +-+-+-+-+-------+-+-------------+ - - - - - - - - - - - - - - - +
     |     Extended payload length continued, if payload len == 127  |
     + - - - - - - - - - - - - - - - +-------------------------------+
     |                               |Masking-key, if MASK set to 1  |
     +-------------------------------+-------------------------------+
     | Masking-key (continued)       |          Payload Data         |
     +-------------------------------- - - - - - - - - - - - - - - - +
     :                     Payload Data continued ...                :
     +---------------------------------------------------------------+

帧分为控制帧和数据帧,控制帧不可能分片,数据帧能够分片。重要字段表达如下:

  • FIN:
    没有分片的帧的FIN为1,分片帧的第二个分片的FIN为0,倒数分片FIN为一。
  • opcode: 帧类型编号,当中央控制制帧:0x八 (Close), 0x九 (Ping), and 0xA
    (Pong),数据帧首要有:0x1 (Text), 0x二 (Binary)。
  • MASK:客户端发给服务端的帧MASK为1,Masking-key为加密掩码。服务端发往客户端的MASK为0,Masking-key为空。
  • Payload len和Payload Data分别是帧的数据长度和数码内容。

tornado.websocket — 浏览器与服务器双向通讯

WebSocket 协议的贯彻

WebSockets 允许浏览器和服务器之间进行 双向通信

享有主流浏览器的现世版本都援助WebSockets(扶助情状详见:http://caniuse.com/websockets)

该模块遵照最新 WebSocket 协议 大切诺基FC 645五 实现.

在 4.0 版更改: Removed support for the draft 76 protocol version.

HTML代码:python3知识点

微信QQ

#chatcontent{

/*显示内容使用的*/

width:500px;

height:200px;

background-color:pink;

overflow-y:scroll;

overflow-x:scroll;

}

发送

ws=newWebSocket(‘ws://192.168.1.27:8009/chat’)

//服务器给浏览器推送消息的时候回调

ws.onmessage=function(p1) {

$(‘#chatcontent’).append(‘

‘+p1.data+’

‘)

}

functionsend() {

varcontent=$(‘#msg_container’).val()

ws.send(content)

$(‘#msg_container’).val(”)

}

 

3 engine.io和socket.io

眼下提到socket.io是基于engine.io的卷入,engine.io(协议版本三)有一套本人的磋商,任何engine.io服务器都无法不扶助polling(包涵jsonp和xhr)和websocket二种传输格局。engine.io使用websocket时有一套本人的ping/pong机制,使用的是opcode为0x1(Text)类型的数据帧,不是websocket商谈鲜明的ping/pong类型的帧,标准的
ping/pong 帧被uwsgi使用

engine.io的数据编码分为Packet和Payload,当中 Packet是数据包,有陆体系型:

  • 0 open:从服务端发出,标识2个新的传输方式已经打开。
  • 壹 close:请求关闭那条传输连接,可是它自身并不关门那一个一而再。
  • 2ping:客户端周期性发送ping,服务端响应pong。注意那个与uwsgi自带的ping/pong不均等,uwsgi里面发送ping,而浏览器再次回到pong。
  • 三 pong:服务端发送。
  • 四 message:实际发送的音讯。
  • 5upgrade:在转移transport前,engine.io会发送探测包测试新的transport(如websocket)是还是不是可用,假若OK,则客户端会发送1个upgrade音讯给服务端,服务端关闭老的transport然后切换来新的transport。
  • 6noop:空操作数据包,客户端收到noop消息会将事先等待暂停的轮询暂停,用于在接受到2个新的websocket强制多少个新的轮询周期。

而Payload是指一种类绑定到1起的编码后的Packet,它只用在poll中,websocket里面使用websocket帧里面包车型大巴Payload字段来传输数据。要是客户端不补助XH奥迪Q3二,则payload格式如下,当中length是数额包Packet的长度,而packet则是编码后的数据包内容。

<length1>:<packet1>[<length2>:<packet2>[...]]

若帮助XHQashqai二,则payload中内容总体以二进制编码,当中第一位0表示字符串,一意味二进制数据,而前边跟着的数字则是象征packet长度,然后以\xff结尾。借使一个长短为10九的字符类型的数据包,则前面长度编码是
\x00\x01\x00\x09\xff,然后前边接packet内容。

<0 for string data, 1 for binary data><Any number of numbers between 0 and 9><The number 255><packet1 (first type,
then data)>[...]

engine.io服务器维护了三个socket的字典结构用于管理总是到该机的客户端,而客户端的标识正是sid。即便有四个worker,则必要确认保证同二个客户端的总是落在同壹台worker上(能够布置nginx依据sid分发)。因为各样worker只珍爱了壹局地客户端连接,若是要帮衬广播,room等特征,则后端供给利用
redis 或许 RabbitMQ
新闻队列,使用redis的话则是透过redis的订阅发表机制完成多机多worker之间的音讯推送。

socket.io是engine.io的包裹,在其基础上加码了全自动重连,多路复用,namespace,room等特点。socket.io自身也有壹套协议,它Packet类型分为(CONNECT 0, DISCONNECT 1, EVENT 2, ACK 3, ERROR 4, BINARY_EVENT 5, BINARY_ACK 6)。注意与engine.io的Packet类型有所不一致,不过socket.io的packet实际是凭借的engine.io的Message类型发送的,在末端实例中能够看出Packet的编码方式。当连接出错的时候,socket.io会通过机关心器重连机制再一次连接。

class tornado.websocket.WebSocketHandler(application, request, **kwargs)

经过持续该类来创制1个主干的 WebSocket handler.

重写 on_message 来处理收到的音讯, 使用 write_message
来发送音信到客户端. 你也能够重写 open 和 on_close
来处理连接打开和倒闭那八个动作.

至于JavaScript 接口的详细音讯:
http://dev.w3.org/html5/websockets/
具体的商业事务:
http://tools.ietf.org/html/rfc6455

二个简易的 WebSocket handler 的实例:
服务端直接再次回到全数接收的音信给客户端

class EchoWebSocket(tornado.websocket.WebSocketHandler):
    def open(self):
        print("WebSocket opened")

    def on_message(self, message):
        self.write_message(u"You said: " + message)

    def on_close(self):
        print("WebSocket closed")

WebSockets 并不是明媒正娶的 HTTP 连接. “握手”动作符合 HTTP
标准,然则在”握手”动作之后, 协议是依据新闻的. 因而,Tornado 里多数的
HTTP 工具对于那类 handler 都是不可用的. 用来报道的方法只有write_message() , ping() , 和 close() . 同样的,你的 request handler
类里应该利用 open() 而不是 get() 只怕 post()

只要你在利用中校那个 handler 分配到 /websocket, 你能够由此如下代码完成:

var ws = new WebSocket("ws://localhost:8888/websocket");
ws.onopen = function() {
   ws.send("Hello, world");
};
ws.onmessage = function (evt) {
   alert(evt.data);
};

本条本子将会弹出一个提醒框 :”You said: Hello, world”

浏览器并从未依照同源策略(same-origin policy),相应的允许了随便站点使用
javascript 发起任意 WebSocket
连接来控制其余网络.那令人惊叹,并且是两个神秘的安全漏洞,所以 从 Tornado
四.0 起头 WebSocketHandler 供给对梦想接受跨域请求的采纳通过重写.

check_origin (详细消息请查看文书档案中有关该办法的有个别)来进行设置.
未有正确配置那一个天性,在创建 WebSocket 连接时候很或然会导致 40三 错误.

当使用安全的 websocket 连接(wss://) 时, 来自浏览器的连日或许会失利,因为
websocket 未有地点输出 “认证成功” 的对话. 你在 websocket
连接建立成功在此以前,必须 使用同样的声明访问3个正规的 HTML 页面.

 

肆 源码分析

在确立连接后,种种socket会被活动进入到3个暗中认可的命名空间/。在各类命名空间中,socket会被暗中同意加入多个名叫Nonesid的房间。None的房间用于广播,而sid是当前客户端的session
id,用于单播。除暗中认可的房间外,大家能够遵照须要将对应socket插手自定义房间,roomid唯一即可。socket.io基于engine.io,支持websocket和long
polling。假如是long polling,会定时发送GET,
POST请求,当未有多少时,GET请求在拉取队列新闻时会hang住(超时时间为pingTimeout),借使hang住中间服务器从来未曾数据发生,则供给等到客户端发送下四个POST请求时,此时服务器会往队列中贮存POST请求中的新闻,那样上2个GET请求才会回去。借使upgrade到了websocket连接,则会定期ping/pong来保活连接。

为方便描述,上面提到的engine.io服务器对应源文件是engineio/server.py,engine.io套接字对应源文件engineio/socket.py,而socket.io服务器则附和socketio/server.py。下边分析下socket.io连接建立、新闻接收和出殡和埋葬、连接关闭进度。socket.io版本为壹.玖.0,engine.io版本为二.0.4。

Event handlers

先来看一下,长连接调用方式:

接连建立

先是,客户端会发送叁个polling请求来确立连接。此时的请求参数未有sid,表示要创立连接。
engine.io服务器通过handle_get_request()handle_post_request()办法来分别处理起头化连接以及长轮询中的
GET 和 POST 请求。

socket.io在起首化时便登记了二个事件到engine.io的handlers中,分别是connect(处理函数_handle_eio_connect),message(_handle_eio_message),disconnect(_handle_eio_disconnect),在engine.io套接字接收到了上述多个门类的音信后,在自家做了对应处理后都会触发socket.io中的对应的处理函数做尤其处理。

当接过到GET请求且未有sid参数时,则engine.io服务器会调用
_handle_connect()办法来树立连接。那个办法重要办事是为当下客户端生成sid,创立Socket对象并保存到engine.io服务器的sockets集合中。做了这几个开头化工作后,engine.io服务器会发送贰个OPEN类型的数据包给客户端,接着会触发socket.io服务器的connect事件。

客户端第三遍一连的时候,socket.io也要做一些早先化的做事,那是在socket.io服务器的_handle_eio_connect()处理的。那里做的事务要害有几点:

  • 开头化manager,比如用的是redis做后端队列的话,则需求初步化redis_manager,包罗安装redis连接配置,订阅频道,暗许频道是”socket.io”,借使利用flask_socketio则频道是”flask_socketio”,假设用到gevent,则还要对redis模块的socket库打monkey-patch等。

  • 将该客户端参与到暗中同意房间None,sid中。

  • 调用代码中对connect事件注册的函数。如上面那一个,注意下,socket.io中也有个用于事件处理的handlers,它保存的是在后端代码中对socket.io事件注册的函数(开发者定义的),而engine.io的handlers中保留的函数是socket.io注册的那多个针对connect,message和disconnect事件的定势的处理函数。

    socketio.on("connect")
    def test_connect():
        print "client connected"
    
  • 发送三个sockeio的connect数据包给客户端。

末尾在响应中engine.io会为客户端设置四个名叫io值为sid的cookie,响应内容payload包蕴多少个数据包,1个是engine.io的OPEN数据包,内容为sid,pingTimeout等安顿和参数;另叁个是socket.io的connect数据包,内容为40。当中四意味着的是engine.io的message音信,0则意味socket.io的connect新闻,以字节流回到。那里的pingTimeout客户端和服务端共享这么些布局,用于检验对端是还是不是过期。

跟着会发送贰个轮询请求和websocket握手请求,如果websocket握手成功后客户端会发送2 probe探测帧,服务端回应3 probe,然后客户端会发送内容为5的Upgrade帧,服务端回应内容为6的noop帧。探测帧检查通过后,客户端停止轮询请求,将传输通道转到websocket连接,转到websocket后,接下去就起来定期(暗许是二五秒)的
ping/pong(那是socket.io自定义的ping/pong,除了这一个之外,uwsgi也会定期(暗中认可30秒)对客户端ping,客户端回应pong,那一个在chrome的Frames里面是看不到的,必要重视wireshark大概用别样浏览器插件来调查)。

WebSocketHandler.open(*args, **kwargs)

当打开3个新的 WebSocket 时调用

open 的参数是从 tornado.web.UHavalLSpec 通过正则表明式获取的, 就好像获取
tornado.web.RequestHandler.get 的参数1样

    ws = websocket.WebSocketApp("ws://echo.websocket.org/",
                              on_message = on_message,
                              on_error = on_error,
                              on_close = on_close)
    ws.on_open = on_open
    ws.run_forever()

服务端新闻接收流程

对收到音信的则统壹通过engine.io套接字的receive()函数处理:

  • 对于轮询,壹旦接收了polling的POST请求,则会调用receive往该socket的新闻队列之中发送音信,从而释放在此之前hang住的GET请求。
  • 对于websocket:
    • 吸收接纳了ping,则会即时响应2个pong。
    • 收下到了upgrade消息,则立刻发送2个noop音信。
    • 接过到了message,则调用socket.io注册到engine.io的_handle_eio_message情势来处理socket.io自个儿定义的各样新闻。

WebSocketHandler.on_message(message)

拍卖在 WebSocket 中接到的音讯

其一法子必须被重写

 

服务端音讯发送流程

而服务端要给客户端发送新闻,则需求经过socket.io服务器的emit方法,注意emit方法是针对性room来发送音信的,假使是context-aware的,则emit默许是对namespace为/且room名称叫sid的房间发送,固然是context-free的,则暗中认可是广播即对全部连接的客户端发送音信(当然在context-free的情景上面,你也得以钦命room来只给钦定room推送音讯)。

socket.io要促成多进程以及广播,房间等作用,势必需求衔接1个redis之类的音信队列,进而socket.io的emit会调用对应队列管理器pubsub_manager的emit方法,比如用redis做音信队列则最后调用
redis_manager中的_publish()
方法通过redis的订阅宣布作用将消息推送到flask_socketio频道。另1方面,全部的socket在再三再四时都订阅了
flask_socketio频道,而且都有1个体协会程(或线程)在监听频道中是还是不是有消息,壹旦有音讯,就会调用pubsub_manager._handle_emit()方法对本机对应的socket发送对应的新闻,最终是经过socket.io服务器的_emit_internal()方式完毕对本机中room为sid的具备socket发送新闻的,倘若room为None,则便是广播,即对负有连接到本机的有所客户端推送音讯。

socket.io服务器发送音讯要基于engine.io新闻包装,所以归纳到底依然调用的engine.io套接字中的send()艺术。engine.io为每个客户端都会体贴贰个音信队列,发送数据都以先存到行列之中待拉取,websocket除了探测帧之外的其他数据帧也都是通过该信息队列发送。

WebSocketHandler.on_close()

当关闭该 WebSocket 时调用

当连接被彻底关闭并且帮衬 status code 或 reason phtase 的时候, 能够通过
self.close_code 和 self.close_reason 这两日性子来收获它们

在 4.0 版更改: Added close_code and close_reason attributes. 添加
close_code 和 close_reason 那多个属性

 长连接,参数介绍:

关闭连接(只分析websocket)

websocket或许尤其关闭的情事多多。比如客户端发了ping后伺机pong超时关闭,服务端接收到ping跟上一个ping之间当先了pingTimeout;用的uwsgi的话,uwsgi发送ping,若是在websockets-pong-tolerance(暗中同意3秒)内收取不到pong回应,也会关闭连接;还有假设nginx的proxy_read_timeout配置的比pingInterval小等。

倘若不是客户端主动关闭连接,socket.io就会在连年出错后不停重试以创立连接。重试间隔和重试次数由reconnectionDelayMax(默认5秒)reconnectionAttempts(暗许向来重连)设定。下边研究客户端符合规律关闭的气象,种种非凡关闭状态请具体景况具体分析。

客户端主动关闭

倘使客户端调用socket.close()继续努力关闭websocket连接,则会首发送3个消息41(四:engine.io的message,一:socket.io的disconnect)再关闭连接。如前方提到,engine.io套接字接收到新闻后会交给socket.io服务器注册的
_handle_eio_message()拍卖。最后是调用的socket.io的_handle_disconnect(),该函数工作包罗调用socketio.on("disconnect")登记的函数,将该客户端从进入的屋子中移除,清理环境变量等。

uwsgi而接受到客户端关闭websocket连接音信后会关闭服务端到客户端的连天。engine.io服务器的websocket数据接收例程ws.wait()因为接二连三关闭报IOError,触发服务端循环收发数据经过结束,并从保卫安全的sockets集合中移除那几个闭馆的sid。然后调用engine.io套接字的close(wait=True, abort=True)情势,由于是客户端主动关闭,那里就不会再给客户端发送2个CLOSE音讯。而
engine.io服务器的close方法一致会触发socket.io从前注册的disconnect事件处理函数,由于后边已经调用_handle_disconnect()处理了关门连接事件,所以这里_handle_eio_disconnect()不供给再做别的操作(这些操作不是多余的,其功效见后一节)。

浏览器关闭

直接关门浏览器发送的是websocket的标准CLOSE音信,opcode为八。socket.io服务端处理方式基本1致,由于那种状态下并从未发送socket.io的闭馆音信41,socket.io的关门操作必要等到engine.io触发的_handle_eio_disconnect()中处理,那便是前1节中为啥engine.io服务器后边还要多调用3次
_handle_eio_disconnect()的由来所在。

WebSocketHandler.select_subprotocol(subprotocols)

当三个新的 WebSocket 请求特定子协议(subprotocols)时调用

subprotocols 是一个由1密密麻麻能够被客户端正确识别出相应的子协议
(subprotocols)的字符串构成的 list . 这些方法可能会被重载,用来回到 list
中某 个相配字符串, 未有相称到则赶回 None.
假诺未有找到相应的子协议,固然服务端并 不会自行关闭 WebSocket
连接,可是客户端能够选拔关闭连接.

(1)url:
websocket的地址。

5 实例

合计表明简单令人有个别头晕,websocket,engine.io,socket.io,各自行车运动组织议是什么行事的,看看实例可能会比较清晰,为了方便测试,小编写了个Dockerfile,安装了docker的童鞋能够拉取代码执行
bin/start.sh 即可运维拥有完整的
nginx+uwsgi+gevent+flask_socketio测试环境的器皿开头测试,浏览器打开http://127.0.0.1即可测试。async_mode用的是gevent_uwsgi,完整代码见
这里。

对此不帮助websocket的低版本浏览器,socket.io会退化为长轮询的主意,通过为期的出殡GET,
POST请求来拉取数据。未有多少时,会将请求数据的GET请求hang住,直到服务端有数据产生可能客户端的POST请求将GET请求释放,释放之后会随之再度发送3个GET请求,除了这么些之外,协议分析和拍卖流程与websocket方式基本壹致。实例只针对利用websocket的展开剖析

为了调查socket.io客户端的调用流程,能够设置localStorage.debug = '*';,测试的前段代码片段如下(完整代码见仓库):

 <script type="text/javascript" charset="utf-8">
    var socket = io.connect('/', {
        "reconnectionDelayMax": 10000,
        "reconnectionAttempts": 10
    });
    socket.on('connect', function() {
        $('#log').append('<br>' + $('<div/>').text('connected').html());
    })

    $(document).ready(function() {

        socket.on('server_response', function(msg) {
            $('#log').append('<br>' + $('<div/>').text('Received from server: ' + ': ' + msg.data).html());
        });

        $('form#emit').submit(function(event) {
            socket.emit('client_event', {data: $('#emit_data').val()});
            return false;
        });
    });

 </script>

测试代码相比不难,引进socket.io的js库文件,然后在一而再成功后在页面显示“connected”,在输入框输入文字,能够经过连日发送至服务器,然后服务器将浏览器发送的字符串加上server标识回显回来。

Output

(2)header:
客户发送websocket握手请求的央求头,{‘head1:value一’,’head二:value贰’}。

树立连接

在chrome中打开页面能够看看发了1个请求,分别是:

1 http://127.0.0.1/socket.io/?EIO=3&transport=polling&t=MAkXxBR
2 http://127.0.0.1/socket.io/? EIO=3&transport=polling&t=MAkXxEz&sid=9c54f9c1759c4dbab8f3ce20c1fe43a4
3 ws://127.0.0.1/socket.io/?EIO=3&transport=websocket&sid=9c54f9c1759c4dbab8f3ce20c1fe43a4

伸手暗中同意路径是/socket.io,注意命名空间并不会在路子中,而是在参数中传递。第二个请求是polling,EIO是engine.io协议的版本号,t是七个随意字符串,第3个请求时还还尚未生成sid。服务端接收到消息后会调用engine.io/server.py_handle_connect()树立连接。

归来的结果是

## Response Headers: Content-Type: application/octet-stream ##
�ÿ0{"pingInterval":25000,"pingTimeout":60000,"upgrades":["websocket"],"sid":"9c54f9c1759c4dbab8f3ce20c1fe43a4"}�ÿ40

能够看到,这里重临的是字节流的payload,content-type为”application/octet-stream”。那么些payload其实包蕴三个packet,第3个packet是engine.io的OPEN音信,类型为0,它的内容为pingInterval,pingTimeout,sid等;第一个packet类型是四(message),而它的数目内容是0,表示socket.io的CONNECT。而其间的看起来乱码的1部分其实是前方提到的payload编码中的长度的编码\x00\x01\x00\x09\xff\x00\x02\xff

  • 第二个请求是轮询请求,假如websocket建立并测试成功(使用内容为probe的ping/pong帧)后,会停顿轮询请求。能够看看轮询请求一向hang住到websocket建立并测试成功后才重返,响应结果是�ÿ6,前面乱码部分是payload长度编码\x00\x01\xff,后边的数字陆是engine.io的noop音信。

  • 首个请求是websocket握手请求,握手成功后,能够在chrome的Frames中间看到websocket的数码帧交互流程,能够看出如前方分析,确实是头阵的探测帧,然后是Upgrade帧,接着便是定期的ping/pong帧了。

    2probe
    3probe
    5
    2
    3
    ...
    

WebSocketHandler.write_message(message, binary=False)

将付出的 message 发送到客户端

message 能够是 string 恐怕 dict(将会被编码成 json ) 假诺 binary 为
false, message 将会以 utf8 的编码发送; 在 binary 情势下 message 能够是
任何 byte string.

假如老是已经关门, 则会触发 WebSocketClosedError

在 三.二 版更改: 添加了 WebSocketClosedError (在头里版本会触发
AttributeError)

在 4.三 版更改: 重临能够被用来 flow control 的 Future.

(3)on_open:在创制Websocket握手时调用的可调用对象,这一个主意只有多少个参数,便是此类本人。

客户端发送消息给服务端

设若要发送信息给服务器,在浏览器输入框输入test,点击echo按钮,能够见见websocket发送的帧的始末如下,个中肆是engine.io的message类型标识,2是socket.io的EVENT类型标识,而前面则是事件名称和数目,数据足以是字符串,字典,列表等门类。

42["client_event",{"data":"test"}]

WebSocketHandler.close(code=None, reason=None)

闭馆当前 WebSocket

倘诺挥手动作成功,socket将会被关闭.

code 大概是2个数字组成的状态码, 选择 昂CoraFC 6455 section 柒.四.壹. 概念的值.

reason 大概是描述连接关闭的文书信息. 那几个值被提给客户端,可是不会被
WebSocket 协议单独解释.

在 4.0 版更改: Added the code and reason arguments.

(4)on_message:这一个指标在接到到服务器再次回到的新闻时调用。有五个参数,两个是此类本人,1个是大家从服务器获取的字符串(utf-八格式)。

服务端接收消息流程

而服务端接收音信并赶回一个新的event为”server_response”,数据为”TEST”,代码如下,在那之中socketio是flask_socketio模块的SocketIO对象,它提供了装饰器方法
on将自定义的client_event和拍卖函数test_client_event注册到sockerio服务器的handlers中。

当接到到 client_event 消息时,会通过sockerio/server.py中的
_handle_eio_message()主意处理音信,对于socket.io的EVENT类型的新闻最后会透过_trigger_event()方法处理,该办法约等于从handlers中获得client_event对应的处理函数并调用之。

from flask_socketio import SocketIO, emit
socketio = SocketIO(...)

@socketio.on("client_event")
def test_client_event(msg):
    emit("server_response", {"data": msg["data"].upper()})

Configuration

(5)on_error:这几个指标在遇见错误时调用,有五个参数,第三个是此类本人,第一个是充足对象。

服务端发送新闻到客户端

服务端发送音信通过
flask_socketio提供的emit方法达成,如前一节分析的,最后如故经过的engine.io包装成engine.io的消息格式后发出。

42["server_response",{"data":"TEST"}]

WebSocketHandler.check_origin(origin)

透过重写这几个点子来达成域的切换

参数 origin 的值来自 HTTP header 中的Origin,url 负责伊始化这么些请求.
那几个办法并不是须要客户端不发送那样的
heder;那样的央浼平素被允许(因为具有的浏览器 完毕的 websockets
都辅助这一个 header ,并且非浏览器客户端从未一样的跨域安全问题.

回到 True 代表接受,相应的归来 False 代表拒绝.暗中同意拒绝除 host
外别的域的请求.

本条是2个浏览器防止 XSS 攻击的安全策略,因为 WebSocket
允许绕过普通的同源策略 以及不选用 CORAV四S 头.

要允许具备跨域通讯的话(那在 Tornado 四.0
从前是私下认可的),只要不难的重写那个格局 让它一贯重临 true 就足以了:

def check_origin(self, origin):
    return True

要允许全部全部子域下的延续,能够这么达成:

def check_origin(self, origin):
    parsed_origin = urllib.parse.urlparse(origin)
    return parsed_origin.netloc.endswith(".mydomain.com")

4.0 新版作用.

(6)on_close:在遇到再而三关闭的景况时调用,参数只有2个,正是此类本人。

关门连接

客户端要前仆后继关闭连接,在JS中调用 socket.close()
即可,此时发送的数码包为
41,其中四代表的是engine.io的新闻类型message,而数据1则是指的socket.io的新闻类型disconnect,关闭流程见上1章的认证。

WebSocketHandler.get_compression_options()

重写该措施重返当前连接的 compression 选项

借使那么些格局再次回到 None (默许), compression 将会被禁止使用. 借使它回到 dict
(固然 是空的),compression 都会被开启. dict 的始末将会被用来控制
compression 所 使用的内部存款和储蓄器和CPU.可是那类的安装以往还尚未被实现.

肆.① 新版作用.

(7)on_cont_message:这么些目的在收受到连年帧数据时被调用,有八个参数,分别是:类本人,从服务器接受的字符串(utf-8),三番五次标志。

6 总结

正文示例中,为了便于分析,只用了暗许的namespace和room,而在实际项目中得以依照业务供给选择namespace,room等高等天性。

nginx+uwsgi使用socket.io时,当用到websocket时,注意nginx的逾期配置proxy_read_timeout和uwsgi的websocket超时配置websocket-ping-freq和websockets-pong-tolerance,配置不当会招致socke.io因为websocket的ping/pong超时而不断重连。

WebSocketHandler.set_nodelay(value)

为当前 stream 设置 no-delay

在私下认可意况下, 小块数据会被推移和/或联合以减弱发送包的数量.
那在稍微时候会因为 Nagle’s 算法和 TCP ACKs 相互作用会招致 200-500ms
的延迟.在 WebSocket 连接 已经济建设立的景况下,能够因此设置
self.set_nodelay(True) 来降低延迟(那或然 会占用更加多带宽)

越多详细信息: BaseIOStream.set_nodelay.

在 BaseIOStream.set_nodelay 查看详细新闻.

三.一 新版功能.

(8)on_data:当从服务器收到到新闻时被调用,有八个参数,分别是:该类本人,接收到的字符串(utf-八),数据类型,两次三番标志。

参考资料

  • https://tools.ietf.org/html/rfc6455
  • https://www.nginx.com/blog/websocket-nginx/
  • https://security.stackexchange.com/questions/36930/how-does-websocket-frame-masking-protect-against-cache-poisoning
  • https://github.com/suexcxine/blog/blob/master/source/\_posts/websocket.md
  • https://github.com/abbshr/abbshr.github.io/issues/47
  • https://socket.io/docs/logging-and-debugging/
  • http://uwsgi-docs.readthedocs.io/en/latest/WebSockets.html
  • https://flask-socketio.readthedocs.io/en/latest/

Other

(9)keep_running:1个2进制的标志位,若是为True,这些app的主循环将四处运维,暗许值为True。

WebSocketHandler.ping(data)

发送 ping 包到远端.

(10)get_mask_key:用于爆发2个掩码。

WebSocketHandler.on_pong(data)

当收到ping 包的响应时执行.

www.5929.com,(11)subprotocols:1组可用的子协议,暗中认可为空。

exception tornado.websocket.WebSocketClosedError

并发关闭连接错误触发.

3.二 新版效率.

 

Client-side support

长连接主要办法:ws.run_forever(ping_interval=60,ping_timeout=5)

tornado.websocket.websocket_connect(url, io_loop=None, callback=None, connect_timeout=None, on_message_callback=None, compression_options=None)

客户端 WebSocket 匡助 必要钦定 url, 再次来到一个结出为
WebSocketClientConnection 的 Future 对象

compression_options 作为 WebSocketHandler.get_compression_options 的
再次回到值, 将会以同一的主意执行.

以此延续协理两体系型的操作.在协程风格下,应用程序平时在贰个循环里调用~.WebSocket ClientConnection.read_message:

conn = yield websocket_connect(url)
while True:
    msg = yield conn.read_message()
    if msg is None: break
    # Do something with msg

在回调风格下,供给传递 on_message_callback 到 websocket_connect 里.
在那三种风格里,四个剧情是 None 的 message 都标志着 WebSocket 连接已经.

在 三.2 版更改: 允许选择 HTTPRequest 对象来取代 urls.

在 4.1 版更改: 添加 compression_options 和 on_message_callback .

不扶助采纳 compression_options .

 假如持续开关闭websocket连接,会向来不通下去。其余那个函数带五个参数,假如传的话,运转心跳包发送。

class tornado.websocket.WebSocketClientConnection(io_loop, request, on_message_callback=None, compression_options=None)

WebSocket 客户端连接

以此类不应该直接被实例化, 请使用 websocket_connect

 

close(code=None, reason=None)

关闭 websocket 连接

code 和 reason 的文书档案在 WebSocketHandler.close 下已给出.

三.二 新版作用.

在 四.0 版更改: 添加 code 和 reason 那三个参数

ping_interval:自动发送“ping”命令,每一种钦命的日子(秒),借使设置为0,则不会自行发送。

write_message(message, binary=False)

出殡新闻到 websocket 服务器.

ping_timeout:假如未有收取pong音信,则为超时(秒)。

read_message(callback=None)

读取来自 WebSocket 服务器的音信.

若果在 WebSocket 起初化时钦点了 on_message_callback
,那么这一个法子永远不会回去消息

如若一连已经关门,重返结果会是二个结果是 message 的 future 对象大概是
None. 假诺 future 给出了回调参数, 这几个参数将会在 future 实现时调用.


能够因而上边二维码订阅笔者的文章公众号【MoeLove】

www.5929.com 2

ws.run_forever(ping_interval=60,ping_timeout=5)

#ping_interval心跳发送间隔时间

#ping_timeout 设置,发送ping到收到pong的超时时间

 

我们看源代码,会发觉这么一断代码:

ping的逾期时间,要当先ping间隔时间

 

        if not ping_timeout or ping_timeout <= 0:
            ping_timeout = None
        if ping_timeout and ping_interval and ping_interval <= ping_timeout:
            raise WebSocketException("Ensure ping_interval > ping_timeout")

 

 

 

 

长连接:

示例1:

 

import websocket
try:
    import thread
except ImportError:
    import _thread as thread
import time

def on_message(ws, message):
    print(message)

def on_error(ws, error):
    print(error)

def on_close(ws):
    print("### closed ###")


def on_open(ws):
    def run(*args):
        ws.send("hello1")
        time.sleep(1)
        ws.close()
    thread.start_new_thread(run,())

if __name__ == "__main__":
    websocket.enableTrace(True)
    ws = websocket.WebSocketApp("ws://echo.websocket.org/",
                              on_message = on_message,
                              on_error = on_error,
                              on_close = on_close)
    ws.on_open = on_open
    ws.run_forever(ping_interval=60,ping_timeout=5)

 

示例2:

import websocket
from threading import Thread
import time
import sys


class MyApp(websocket.WebSocketApp):
    def on_message(self, message):
        print(message)

    def on_error(self, error):
        print(error)

    def on_close(self):
        print("### closed ###")

    def on_open(self):
        def run(*args):
            for i in range(3):
                # send the message, then wait
                # so thread doesn't exit and socket
                # isn't closed
                self.send("Hello %d" % i)
                time.sleep(1)

            time.sleep(1)
            self.close()
            print("Thread terminating...")

        Thread(target=run).start()


if __name__ == "__main__":
    websocket.enableTrace(True)
    if len(sys.argv) < 2:
        host = "ws://echo.websocket.org/"
    else:
        host = sys.argv[1]
    ws = MyApp(host)
    ws.run_forever()

 

 

短连接:

from websocket import create_connection
ws = create_connection("ws://echo.websocket.org/")
print("Sending 'Hello, World'...")
ws.send("Hello, World")
print("Sent")
print("Receiving...")
result =  ws.recv()
print("Received '%s'" % result)
ws.close()

 

——

Leave a Comment.