Python通過websocket與js客戶端通信示例分析

2019-11-25 18:21:56

字體：大中小

來源：轉載

供稿：網友

具體的 websocket 介紹可見 http://zh.wikipedia.org/wiki/WebSocket

這里，介紹如何使用 Python 與前端 js 進行通信。

websocket 使用 HTTP 協議完成握手之后，不通過 HTTP 直接進行 websocket 通信。

于是，使用 websocket 大致兩個步驟：使用 HTTP 握手，通信。

js 處理 websocket 要使用 ws 模塊； Python 處理則使用 socket 模塊建立 TCP 連接即可，比一般的 socket ，只多一個握手以及數據處理的步驟。

握手

過程

包格式

js 客戶端先向服務器端 python 發送握手包，格式如下：

GET /chat HTTP/1.1Host: server.example.comUpgrade: websocketConnection: UpgradeSec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==Origin: http://example.comSec-WebSocket-Protocol: chat, superchatSec-WebSocket-Version: 13

服務器回應包格式：

HTTP/1.1 101 Switching ProtocolsUpgrade: websocketConnection: UpgradeSec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=Sec-WebSocket-Protocol: chat

其中， Sec-WebSocket-Key 是隨機的，服務器用這些數據構造一個 SHA-1 信息摘要。

方法為： key+migic ， SHA-1 加密， base-64 加密，如下：

Python 中的處理代碼

MAGIC_STRING = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'res_key = base64.b64encode(hashlib.sha1(sec_key + MAGIC_STRING).digest())

握手完整代碼

js 端

js 中有處理 websocket 的類，初始化后自動發送握手包，如下：

var socket = new WebSocket('ws://localhost:3368');

Python 端

Python 用 socket 接受得到握手字符串，處理后發送

HOST = 'localhost'PORT = 3368MAGIC_STRING = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'HANDSHAKE_STRING = "HTTP/1.1 101 Switching Protocols/r/n" /      "Upgrade:websocket/r/n" /      "Connection: Upgrade/r/n" /      "Sec-WebSocket-Accept: {1}/r/n" /      "WebSocket-Location: ws://{2}/chat/r/n" /      "WebSocket-Protocol:chat/r/n/r/n" def handshake(con):#con為用socket，accept()得到的socket#這里省略監聽，accept的代碼,具體可見blog：http://blog.csdn.net/ice110956/article/details/29830627 headers = {} shake = con.recv(1024)  if not len(shake):  return False  header, data = shake.split('/r/n/r/n', 1) for line in header.split('/r/n')[1:]:  key, val = line.split(': ', 1)  headers[key] = val  if 'Sec-WebSocket-Key' not in headers:  print ('This socket is not websocket, client close.')  con.close()  return False  sec_key = headers['Sec-WebSocket-Key'] res_key = base64.b64encode(hashlib.sha1(sec_key + MAGIC_STRING).digest())  str_handshake = HANDSHAKE_STRING.replace('{1}', res_key).replace('{2}', HOST + ':' + str(PORT)) print str_handshake con.send(str_handshake)return True

通信

不同版本的瀏覽器定義的數據幀格式不同， Python 發送和接收時都要處理得到符合格式的數據包，才能通信。

Python 接收

Python 接收到瀏覽器發來的數據，要解析后才能得到其中的有用數據。

瀏覽器包格式

固定字節：

（ 1000 0001 或是 1000 0002 ）這里沒用，忽略

包長度字節：

第一位肯定是 1 ，忽略。剩下 7 個位可以得到一個整數 (0 ~ 127) ，其中

（ 1-125 ）表此字節為長度字節，大小即為長度；

（126）表接下來的兩個字節才是長度；

（127）表接下來的八個字節才是長度；

用這種變長的方式表示數據長度，節省數據位。

mark 掩碼：

mark 掩碼為包長之后的 4 個字節，之后的兄弟數據要與 mark 掩碼做運算才能得到真實的數據。

兄弟數據：

得到真實數據的方法：將兄弟數據的每一位 x ，和掩碼的第 i%4 位做 xor 運算，其中 i 是 x 在兄弟數據中的索引。

完整代碼

def recv_data(self, num): try:  all_data = self.con.recv(num)  if not len(all_data):   return False except:  return False else:  code_len = ord(all_data[1]) & 127  if code_len == 126:   masks = all_data[4:8]   data = all_data[8:]  elif code_len == 127:   masks = all_data[10:14]   data = all_data[14:]  else:   masks = all_data[2:6]   data = all_data[6:]  raw_str = ""  i = 0  for d in data:   raw_str += chr(ord(d) ^ ord(masks[i % 4]))   i += 1  return raw_str

js 端的 ws 對象，通過 ws.send(str) 即可發送

ws.send(str)

Python 發送

Python 要包數據發送，也需要處理，發送包格式如下

固定字節：固定的 1000 0001( ‘ /x81 ′ )

包長：根據發送數據長度是否超過 125 ， 0xFFFF(65535) 來生成 1 個或 3 個或 9 個字節，來代表數據長度。

def send_data(self, data): if data:  data = str(data) else:  return False token = "/x81" length = len(data) if length < 126:  token += struct.pack("B", length) elif length <= 0xFFFF:  token += struct.pack("!BH", 126, length) else:  token += struct.pack("!BQ", 127, length) #struct為Python中處理二進制數的模塊，二進制流為C，或網絡流的形式。 data = '%s%s' % (token, data) self.con.send(data) return True

js 端通過回調函數 ws.onmessage() 接受數據

ws.onmessage = function(result,nTime){alert("從服務端收到的數據:");alert("最近一次發送數據到現在接收一共使用時間:" + nTime);console.log(result);}

最終代碼

Python服務端

# _*_ coding:utf-8 _*___author__ = 'Patrick'import socketimport threadingimport sysimport osimport MySQLdbimport base64import hashlibimport struct # ====== config ======HOST = 'localhost'PORT = 3368MAGIC_STRING = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'HANDSHAKE_STRING = "HTTP/1.1 101 Switching Protocols/r/n" /      "Upgrade:websocket/r/n" /      "Connection: Upgrade/r/n" /      "Sec-WebSocket-Accept: {1}/r/n" /      "WebSocket-Location: ws://{2}/chat/r/n" /      "WebSocket-Protocol:chat/r/n/r/n" class Th(threading.Thread): def __init__(self, connection,):  threading.Thread.__init__(self)  self.con = connection  def run(self):  while True:   try:     pass  self.con.close()  def recv_data(self, num):  try:   all_data = self.con.recv(num)   if not len(all_data):    return False  except:   return False  else:   code_len = ord(all_data[1]) & 127   if code_len == 126:    masks = all_data[4:8]    data = all_data[8:]   elif code_len == 127:    masks = all_data[10:14]    data = all_data[14:]   else:    masks = all_data[2:6]    data = all_data[6:]   raw_str = ""   i = 0   for d in data:    raw_str += chr(ord(d) ^ ord(masks[i % 4]))    i += 1   return raw_str  # send data def send_data(self, data):  if data:   data = str(data)  else:   return False  token = "/x81"  length = len(data)  if length < 126:   token += struct.pack("B", length)  elif length <= 0xFFFF:   token += struct.pack("!BH", 126, length)  else:   token += struct.pack("!BQ", 127, length)  #struct為Python中處理二進制數的模塊，二進制流為C，或網絡流的形式。  data = '%s%s' % (token, data)  self.con.send(data)  return True   # handshake def handshake(con):  headers = {}  shake = con.recv(1024)   if not len(shake):   return False   header, data = shake.split('/r/n/r/n', 1)  for line in header.split('/r/n')[1:]:   key, val = line.split(': ', 1)   headers[key] = val   if 'Sec-WebSocket-Key' not in headers:   print ('This socket is not websocket, client close.')   con.close()   return False   sec_key = headers['Sec-WebSocket-Key']  res_key = base64.b64encode(hashlib.sha1(sec_key + MAGIC_STRING).digest())   str_handshake = HANDSHAKE_STRING.replace('{1}', res_key).replace('{2}', HOST + ':' + str(PORT))  print str_handshake  con.send(str_handshake)  return True def new_service(): """start a service socket and listen when coms a connection, start a new thread to handle it"""  sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) try:  sock.bind(('localhost', 3368))  sock.listen(1000)  #鏈接隊列大小  print "bind 3368,ready to use" except:  print("Server is already running,quit")  sys.exit()  while True:  connection, address = sock.accept()  #返回元組（socket,add），accept調用時會進入waite狀態  print "Got connection from ", address  if handshake(connection):   print "handshake success"   try:    t = Th(connection, layout)    t.start()    print 'new thread for client ...'   except:    print 'start new thread error'    connection.close()  if __name__ == '__main__': new_service()

js客戶端

<script>var socket = new WebSocket('ws://localhost:3368');ws.onmessage = function(result,nTime){alert("從服務端收到的數據:");alert("最近一次發送數據到現在接收一共使用時間:" + nTime);console.log(result);}</script>

上一篇：python正則表達式re模塊詳解

下一篇：Flask框架學習筆記（一）安裝篇（windows安裝與centos安裝）