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>