Tornado - HTML5 WebSocket 概念运用实例

最新推荐文章于 2024-03-16 10:46:17 发布

Saggitarxm

最新推荐文章于 2024-03-16 10:46:17 发布

阅读量308

点赞数

分类专栏： Tornado 文章标签： Tornado WebSocket

本文链接：https://blog.csdn.net/xuezhangjun0121/article/details/104006477

版权

Tornado 专栏收录该内容

1 篇文章 0 订阅

订阅专栏

tornado_websocket.py：

# coding=utf-8
"""
@author: zhangjun.xue
@time: 2020/1/16 11:31
@file: tornado_websocket.py
@desc: 服务端持续为客户端推送时间消息的Tornado WebSocket 程序 - 服务端编程
1,服务端编程
Tornado定义了tornado.websocket.WebSocketHandler类用处理WebSocket链接的请求，应用开发者因该继承该类并实现其中的open()/on_message()/on_close()函数。
    ·  WebSocketHandler.open()函数：在一个新的WebSocket链接建立时，Tornado框架会调用此函数。在本函数中，开发者可以和在get()/post()等函数中一样用get_argumnet()
       函数获取客户端提交的参数，以及用get_secure_cookie/set_secure_cookie操作Cookie等。
    ·  WebSocketHandler.on_message(message)函数：建立WebSocket编程的核心函数，通过解析接受到的消息做出相应的处理。
    ·  WebSocketHandler.on_close()函数：当WebSocket链接被关闭时，Tornado框架会调用本函数。在本函数中，可以通过访问self.close_code和self.close_reason查询失败的原因。
    除了这3个Tornado框架自动调用的入口函数，WebSockerHandler还提供了两个开发者主动操作的WebSocket的函数。
    ·   WebSocketHandler.write_message(message, binary=False)函数：用于向与本链接相对应的客户端写消息。
    ·   WebSocketHandler.close(code=None, reason=None)函数：主动关闭WebSocket链接。其中的code和reason用于告诉客户端链接被关闭的原因。参数code必须是一个数值，
    而reason是一个字符串。

2，客户端编程
"""
import tornado.ioloop
import tornado.web
import tornado.websocket

from tornado.options import define, options, parse_command_line

define("port", default=8888, help="run on the given port", type=int)

"""
定义了全局变量字典clients，用于保存所有与服务器建立WebSocket链接的客户端信息。字典的键时客户端id，值是一个由id与相应的WebSocketHandler实例构成的元组（Tuple）。
"""
clients = dict()  # 客户端Session字典

"""
IndexHandler 是一个普通的页面处理器，用于向客户端渲染主页index.html。本页面中包含了WebSocket的客户端程序。
"""
class IndexHandler(tornado.web.RequestHandler):
    @tornado.web.asynchronous
    def get(self):
        self.render("index.html")
        # self.write("index_html")


"""
MyWebSocketHandler 是本例的核心处理器，继承自tornado.websocket.WebSocketHandler。其中的open()函数将所有客户端链接保存到clients字典中；
on_message()用于显示客户端发来的消息；on_close()用于将已经关闭的WebSocket链接从clients字典中移除。
"""
class MyWebSocketHandler(tornado.websocket.WebSocketHandler):
    def open(self, *args):  # 有新链接时被调用
        self.id = self.get_argument("Id")
        print('------ id = {}'.format(id))
        self.stream.set_nodelay(True)
        clients[self.id] = {"id": self.id, "object": self}  # 保存Session到clients字典中

    def on_message(self, message):  # 收到消息时被调用
        print("Client {} received a message : {}".format(self.id, message))

    def on_close(self):  # 关闭链接时被调用
        if  self.id in clients:
            del clients[self.id]
            print("Client [] is closed".format(self.id))

    def check_origin(self, origin):
        return True

"""
本例的tornado.web.Application实例中配置了两个路由，分别指向IndexHandler和MyWebSocketHandler，仍然由Tornado IOLoop启动并运行。
"""
app = tornado.web.Application(
    [
        (r'/', IndexHandler),
        (r'/websocket', MyWebSocketHandler),
    ],
    debug=True
)


import threading
import time

# 启动单独的线程运行此函数，每隔1秒向所有的客户端推送当前时间
"""
函数sendTime()运行在单独的线程中，每个1秒轮询clients中的所有客户端并通过MyWebSocketHandler.write_message()函数向客户端推送时间消息。
"""
def sendTime():
    import datetime
    while True:
        for key in clients.keys():
            msg = str(datetime.datetime.now().strftime('%Y-%m-%d %H:%M:%S'))
            clients[key]["object"].write_message(msg)
            print("write to client {}: {}".format(key, msg))
        time.sleep(3)


if __name__ == "__main__":
    print('---------1')
    threading.Thread(target=sendTime).start()  # 启动推送时间线程
    print('---------2')
    parse_command_line()
    print('---------3 options.port = {}'.format(options.port))
    app.listen(options.port)
    print('---------4')
    tornado.ioloop.IOLoop.instance().start()  # 挂起运行
    print('---------5')

index.html：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<a href="javascript:WebSocketTest()">Run WebSocket</a>
<div id="messages" style="height: 800px;background: black;color: white;"></div>
</body>

<script type="text/javascript">
    var messageContainer = document.getElementById("messages");
    function WebSocketTest() {
        console.log('------- into WebSocketTest ------')
        if ("WebSocket"in window) {
            messageContainer.innerHML = "WebSocket is supported by your Browser!";
            var ws = new WebSocket("ws://192.168.200.110:8888/websocket?Id=12345");
            {# WebSocket.onopen : 此事件发生在WebSocket 链接建立时。#}
            ws.onopen  = function() {
                ws.send("Message to send");
            };
            {# WebSocket.onmessage : 此事件发生在收到了来自服务器的消息时。#}
            ws.onmessage = function (evt) {
                var received_msg = evt.data;
                messageContainer.innerHTML= messageContainer.innerHTML + "<br/>Message 3s received: " + received_msg;
            };
            {# WebSocket.onclose : 此事件发生在与服务器的链接关闭时。#}
            ws.onclose = function() {
                messageContainer.innerHML = messageContainer.innerHrML + "<br/>Connection is Closed ...";
            };
        }
        else {
            messageContainer.innerHrML = "webSocket NOT supported by your Brower！";
        }
    }
</script>
</html>

Saggitarxm

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Tornado - HTML5 WebSocket 概念运用实例

tornado_websocket.py：# coding=utf-8"""@author: zhangjun.xue@time: 2020/1/16 11:31@file: tornado_websocket.py@desc: 服务端持续为客户端推送时间消息的Tornado WebSocket 程序 - 服务端编程1,服务端编程Tornado定义了tornado.webso...
复制链接

扫一扫