WebSocket长连接心跳与短连接,Tornado简单聊天室

python
websocket

在项目中用到socket.io坚实时推送,遂花了点时间看了socket.io完成,做个大约分析,如有错漏,欢迎指正。

译者说

Tornado 4.3于二〇一五年十月6日发布,该版本正式辅助Python3.5async/await首要字,并且用旧版本CPython编译Tornado同样可以行使那八个重大字,那如实是一种发展。其次,那是终极一个扶助Python2.6Python3.2的本子了,在此起彼伏的版本了会移除对它们的合作。将来网络上还一贯不Tornado4.3的华语文档,所以为了让越来越多的情侣能接触并就学到它,小编开首了那一个翻译项目,希望感兴趣的小伙伴可以协同参预翻译,项目地址是tornado-zh
on
Github,翻译好的文档在Read
the
Docs上直接可以见见。欢迎Issues
or PR。本节谢谢@thisisx7翻译

python3知识点

jquery.min.js

澳门葡京备用网址 1

安装

1 概述

socket.io是一个依据WebSocket的CS的实时通讯库,它底层基于engine.io。engine.io使用WebSocket和xhr-polling(或jsonp)封装了一套本身的合计,在不接济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]WebSocket长连接心跳与短连接,Tornado简单聊天室。-[%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住一段时间等有新的消息仍然逾期再回去,客户端收到服务器的作答后持续轮询。可以看到长轮询比短轮询可以减小大气没用的请求,并且客户端接收取新音讯也会实时不少。

即使长轮询比短轮询优化了广大,然则每一趟请求如故都要带上HTTP请求底部,而且在长轮询的连接达成之后,服务器端积累的新新闻要等到下次客户端连接时才能传递。更好的方式是只用一个TCP连接来促成客户端和服务端的双向通讯,WebSocket探讨正是为此而生。WebSocket是根据TCP的一个独自的商事,它与HTTP协议的唯一涉及就是它的握手请求可以看做一个Upgrade request经由HTTP服务器解析,且与HTTP使用同一的端口。WebSocket暗许对平日请求使用80端口,协议为ws://,对TLS加密请求使用443端口,协议为wss://

拉手是通过一个HTTP Upgrade request开头的,一个伸手和响应尾部示例如下(去掉了毫无干系的头顶)。WebSocket握手请求尾部与HTTP请求尾部是协作的(见RFC2616)。

## 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/1.1中确定的用来转移当前接连的应用层协议的头顶,表示客户端希望用现有的连接转换来新的应用层协议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经SHA1+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的值不科学只怕状态码不是101,则不会建立WebSocket连接,也不会发送WebSocket数据帧。

WebSocket商事使用帧(Frame)收发数据,帧格式如下。基于平安考量,客户端发送给服务端的帧必须通过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为1。
  • opcode: 帧类型编号,其中控制帧:0x8 (Close), 0x9 (Ping), and 0xA
    (Pong),数据帧紧要有:0x1 (Text), 0x2 (Binary)。
  • MASK:客户端发给服务端的帧MASK为1,Masking-key为加密掩码。服务端发往客户端的MASK为0,Masking-key为空。
  • Payload len和Payload Data分别是帧的多寡长度和数码内容。

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

WebSocket 协议的落到实处

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

富有主流浏览器的现世版本都支持WebSockets(帮忙景况详见:http://caniuse.com/websockets)

该模块依据最新 WebSocket 协议 RFC 6455 完毕.

在 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(协议版本3)有一套自身的情商,任何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是数据包,有6种类型:

  • 0 open:从服务端发出,标识一个新的传输方式已经打开。
  • 1 close:请求关闭那条传输连接,不过它本身并不停歇那些一而再。
  • 2
    ping:客户端周期性发送ping,服务端响应pong。注意这几个与uwsgi自带的ping/pong不雷同,uwsgi里面发送ping,而浏览器重临pong。
  • 3 pong:服务端发送。
  • 4 message:实际发送的消息。
  • 5
    upgrade:在更换transport前,engine.io会发送探测包测试新的transport(如websocket)是或不是可用,如若OK,则客户端会发送一个upgrade消息给服务端,服务端关闭老的transport然后切换来新的transport。
  • 6
    noop:空操作数据包,客户端收到noop音信会将从前等待暂停的轮询暂停,用于在收受到一个新的websocket强制一个新的轮询周期。

而Payload是指一星罗棋布绑定到一道的编码后的Packet,它只用在poll中,websocket里面使用websocket帧里面的Payload字段来传输数据。即使客户端不匡助XHR2,则payload格式如下,其中length是数量包Packet的长短,而packet则是编码后的多寡包内容。

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

若扶助XHR2,则payload中内容总体以二进制编码,其中第1位0表示字符串,1象征二进制数据,而后边跟着的数字则是代表packet长度,然后以\xff结尾。若是一个尺寸为109的字符类型的数据包,则前面长度编码是
\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)

经过持续该类来创造一个着力的 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
4.0 伊始 WebSocketHandler 须求对希望接受跨域请求的使用通过重写.

check_origin (详细音信请查看文档中有关该办法的一部分)来拓展设置.
没有正确配置那几个天性,在建立 WebSocket 连接时候很大概会造成 403 错误.

当使用安全的 websocket 连接(wss://) 时, 来自浏览器的连年可能会战败,因为
websocket 没有地点输出 “认证成功” 的对话. 你在 websocket
连接建立成功在此以前,必须 使用相同的讲明访问一个正规的 HTML 页面.

 

4 源码分析

在建立连接后,每种socket会被机关进入到一个暗中同意的命名空间/。在各种命名空间中,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请求中的信息,那样上一个GET请求才会重返。若是upgrade到了websocket连接,则会定期ping/pong来保活连接。

为方便描述,上边提到的engine.io服务器对应源文件是engineio/server.py,engine.io套接字对应源文件engineio/socket.py,而socket.io服务器则对应socketio/server.py。上面分析下socket.io连接建立、音讯接收和发送、连接关闭进程。socket.io版本为1.9.0,engine.io版本为2.0.4。

Event handlers

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

屡次三番建立

首先,客户端会发送一个polling请求来树立连接。此时的呼吁参数没有sid,表示要赤手空拳连接。
engine.io服务器通过handle_get_request()handle_post_request()格局来分别处理开首化连接以及长轮询中的
GET 和 POST 请求。

socket.io在开头化时便登记了3个事件到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蕴含八个数据包,一个是engine.io的OPEN数据包,内容为sid,pingTimeout等配备和参数;另一个是socket.io的connect数据包,内容为40。其中4代表的是engine.io的message消息,0则意味着socket.io的connect新闻,以字节流回到。这里的pingTimeout客户端和服务端共享这么些布局,用于检测对端是或不是过期。

随即会发送一个轮询请求和websocket握手请求,倘若websocket握手成功后客户端会发送2 probe探测帧,服务端回应3 probe,然后客户端会发送内容为5的Upgrade帧,服务端回应内容为6的noop帧。探测帧检查通过后,客户端为止轮询请求,将传输通道转到websocket连接,转到websocket后,接下去就起初定期(默许是25秒)的
ping/pong(那是socket.io自定义的ping/pong,除此之外,uwsgi也会定期(默许30秒)对客户端ping,客户端回应pong,那些在chrome的Frames里面是看不到的,须求倚重wireshark或然用此外浏览器插件来考察)。

WebSocketHandler.open(*args, **kwargs)

当打开一个新的 WebSocket 时调用

open 的参数是从 tornado.web.URLSpec 通过正则表明式获取的, 就如获取
tornado.web.RequestHandler.get 的参数一样

    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,则会应声响应一个pong。
    • 收纳到了upgrade新闻,则马上发送一个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要促成多进度以及广播,房间等作用,势必必要连接一个redis之类的音讯队列,进而socket.io的emit会调用对应队列管理器pubsub_manager的emit方法,比如用redis做音信队列则最终调用
redis_manager中的_publish()
方法通过redis的订阅发表功效将消息推送到flask_socketio频道。另一方面,所有的socket在接连时都订阅了
flask_socketio频道,而且都有一个协程(或线程)在监听频道中是还是不是有音信,一旦有音讯,就会调用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连接,则会头阵送一个消息41(4:engine.io的message,1: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)办法,由于是客户端主动关闭,那里就不会再给客户端发送一个CLOSE音讯。而
engine.io服务器的close方法同样会触发socket.io在此以前注册的disconnect事件处理函数,由于后边早已调用_handle_disconnect()拍卖了关门连接事件,所以那里_handle_eio_disconnect()不必要再做任何操作(这么些操作不是剩下的,其成效见后一节)。

浏览器关闭

一贯关门浏览器发送的是websocket的标准CLOSE新闻,opcode为8。socket.io服务端处理格局基本一致,由于那种气象下并没有发送socket.io的闭馆新闻41,socket.io的关闭操作需求等到engine.io触发的_handle_eio_disconnect()中拍卖,那就是前一节中为啥engine.io服务器前面还要多调用五次
_handle_eio_disconnect()的因由所在。

WebSocketHandler.select_subprotocol(subprotocols)

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

subprotocols 是一个由一名目繁多可以被客户端正确识别出相应的子协议
(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请求释放,释放之后会随着再度发送一个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:value1′,’head2:value2’}。

树立连接

在chrome中开辟页面可以见见发了3个请求,分别是:

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,注意命名空间并不会在路子中,而是在参数中传送。第1个请求是polling,EIO是engine.io协议的版本号,t是一个无限制字符串,第三个请求时还还尚无生成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,首个packet是engine.io的OPEN音讯,类型为0,它的情节为pingInterval,pingTimeout,sid等;首个packet类型是4(message),而它的数量内容是0,表示socket.io的CONNECT。而内部的看起来乱码的片段其实是前方提到的payload编码中的长度的编码\x00\x01\x00\x09\xff\x00\x02\xff

  • 第2个请求是轮询请求,若是websocket建立并测试成功(使用内容为probe的ping/pong帧)后,会搁浅轮询请求。可以看出轮询请求一向hang住到websocket建立并测试成功后才回去,响应结果是�ÿ6,前边乱码部分是payload长度编码\x00\x01\xff,后边的数字6是engine.io的noop音讯。

  • 第3个请求是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

在 3.2 版更改: 添加了 WebSocketClosedError (在此前版本会触发
AttributeError)

在 4.3 版更改: 再次回到可以被用于 flow control 的 Future.

(3)on_open:在建立Websocket握手时调用的可调用对象,那个格局只有一个参数,就是此类本身。

客户端发送音讯给服务端

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

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

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

关门当前 WebSocket

假如挥手动作成功,socket将会被关闭.

code 恐怕是一个数字组合的状态码, 采纳 RFC 6455 section 7.4.1. 定义的值.

reason 大概是讲述连接关闭的公文音讯. 那一个值被提给客户端,可是不会被
WebSocket 协议单独解释.

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

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

服务端接收音讯流程

而服务端接收消息并重回一个新的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
外其余域的请求.

那一个是一个浏览器制止 XSS 攻击的安全策略,因为 WebSocket
允许绕过普通的同源策略 以及不行使 CORS 头.

要允许持有跨域通讯的话(那在 Tornado 4.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:在遇见一而再关闭的景色时调用,参数唯有一个,就是此类本身。

闭馆连接

客户端要积极关闭连接,在JS中调用 socket.close()
即可,此时殡葬的多寡包为
41,其中4代表的是engine.io的信息类型message,而数据1则是指的socket.io的新闻类型disconnect,关闭流程见上一章的验证。

WebSocketHandler.get_compression_options()

重写该格局再次回到当前总是的 compression 选项

借使那几个格局再次回到 None (暗许), compression 将会被禁用. 如若它回到 dict
(即便 是空的),compression 都会被开启. dict 的故事情节将会被用来控制
compression 所 使用的内存和CPU.可是那类的装置以后还一直不被完成.

4.1 新版作用.

(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 查看详细新闻.

3.1 新版功效.

(8)on_data:当从服务器收到到音讯时被调用,有七个参数,分别是:该类自己,接收到的字符串(utf-8),数据类型,延续标志。

参考资料

  • 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:一个二进制的标志位,要是为True,那个app的主循环将持续运行,默许值为True。

WebSocketHandler.ping(data)

出殡 ping 包到远端.

(10)get_mask_key:用于暴发一个掩码。

WebSocketHandler.on_pong(data)

当接受ping 包的响应时执行.

(11)subprotocols:一组可用的子协议,暗中同意为空。

exception tornado.websocket.WebSocketClosedError

出现关闭连接错误触发.

3.2 新版作用.

 

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 连接已经.

在 3.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 下已给出.

3.2 新版效能.

在 4.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】

澳门葡京备用网址 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()

 

——

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

*
*
Website