Python之WebSocket协议_python websocket onopen

功勋Web工程师

于 2024-04-29 05:03:15 发布

阅读量581

点赞数 16

分类专栏：程序员文章标签： python websocket 网络

本文链接：https://blog.csdn.net/m0_61549781/article/details/138298692

版权

程序员专栏收录该内容

171 篇文章 0 订阅

订阅专栏

'''
function encry($req)
{
    $key = $this->getKey($req);
    $mask = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"; 
    # 将 SHA-1 加密后的字符串再进行一次 base64 加密
    return base64_encode(sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true));
}

```
 如果加密算法错误，客户端在进行校检的时候会直接报错。如果握手成功，则客户端侧会出发onopen事件。
+ Sec-WebSocket-Protocol  
 表示客户端请求提供的可供选择的子协议，及服务器端选中的支持的子协议，“Origin”服务器端用于区分未授权的websocket浏览器
+ Sec-WebSocket-Version: 13  
 客户端在握手时的请求中携带，这样的版本标识，表示这个是一个升级版本，现在的浏览器都是使用的这个版本。
+ HTTP/1.1 101 Switching Protocols  
 101为服务器返回的状态码，所有非101的状态码都表示handshake并未完成。

Data Framing

Websocket协议通过序列化的数据帧传输数据。数据封包协议中定义了opcode、payload length、Payload data等字段。其中要求：

客户端向服务器传输的数据帧必须进行掩码处理：服务器若接收到未经过掩码处理的数据帧，则必须主动关闭连接。
服务器向客户端传输的数据帧一定不能进行掩码处理。客户端若接收到经过掩码处理的数据帧，则必须主动关闭连接。

针对上情况，发现错误的一方可向对方发送close帧（状态码是1002，表示协议错误），以关闭连接。
具体数据帧格式如下图所示：

FIN
标识是否为此消息的最后一个数据包，占 1 bit
RSV1, RSV2, RSV3: 用于扩展协议，一般为0，各占1bit
Opcode
数据包类型（frame type），占4bits
0x0：标识一个中间数据包
0x1：标识一个text类型数据包
0x2：标识一个binary类型数据包
0x3-7：保留
0x8：标识一个断开连接类型数据包
0x9：标识一个ping类型数据包
0xA：表示一个pong类型数据包
0xB-F：保留
MASK：占1bits
用于标识PayloadData是否经过掩码处理。如果是1，Masking-key域的数据即是掩码密钥，用于解码PayloadData。客户端发出的数据帧需要进行掩码处理，所以此位是1。
Payload length

Payload data的长度，占7bits，7+16bits，7+64bits：

+ 如果其值在0-125，则是payload的真实长度。
+ 如果值是126，则后面2个字节形成的16bits无符号整型数的值是payload的真实长度。注意，网络字节序，需要转换。
+ 如果值是127，则后面8个字节形成的64bits无符号整型数的值是payload的真实长度。注意，网络字节序，需要转换。

这里的长度表示遵循一个原则，用最少的字节表示长度（尽量减少不必要的传输）。举例说，payload真实长度是124，在0-125之间，必须用前7位表示；不允许长度1是126或127，然后长度2是124，这样违反原则。

- - Payload data
    应用层数据
  server解析client端的数据
  
  接收到客户端数据后的解析规则如下：
  - 1byte
    - 1bit: frame-fin，x0表示该message后续还有frame；x1表示是message的最后一个frame
    - 3bit: 分别是frame-rsv1、frame-rsv2和frame-rsv3，通常都是x0
    - 4bit: frame-opcode，x0表示是延续frame；x1表示文本frame；x2表示二进制frame；x3-7保留给非控制frame；x8表示关闭连接；x9表示ping；xA表示pong；xB-F保留给控制frame
  - 2byte
    - 1bit: Mask，1表示该frame包含掩码；0表示无掩码
    - 7bit、7bit+2byte、7bit+8byte: 7bit取整数值，若在0-125之间，则是负载数据长度；若是126表示，后两个byte取无符号16位整数值，是负载长度；127表示后8个 byte，取64位无符号整数值，是负载长度
    - 3-6byte: 这里假定负载长度在0-125之间，并且Mask为1，则这4个byte是掩码
    - 7-end byte: 长度是上面取出的负载长度，包括扩展数据和应用数据两部分，通常没有扩展数据；若Mask为1，则此数据需要解码，解码规则为- 1-4byte掩码循环和数据byte做异或操作。

示例代码：

    '''
    遇到问题没人解答？小编创建一个Python学习交流qq群：857662006 
    寻找有志同道合的小伙伴，互帮互助,群里还有不错的视频学习教程和PDF电子书！
    '''
while True:
    # 对数据进行解密
    # send_msg(conn, bytes('alex', encoding='utf-8'))
    # send_msg(conn, bytes('SB', encoding='utf-8'))
    # info = conn.recv(8096)
    # print(info)

    info = conn.recv(8096)
    payload_len = info[1] & 127
    if payload_len == 126:
        extend_payload_len = info[2:4]
        mask = info[4:8]
        decoded = info[8:]
    elif payload_len == 127:
        extend_payload_len = info[2:10]
        mask = info[10:14]
        decoded = info[14:]
    else:
        extend_payload_len = None
        mask = info[2:6]
        decoded = info[6:]

    bytes_list = bytearray()
    for i in range(len(decoded)):
        chunk = decoded[i] ^ mask[i % 4]
        bytes_list.append(chunk)
    msg = str(bytes_list, encoding='utf-8')

    rep = msg + 'sb'
    send_msg(conn,bytes(rep,encoding='utf-8'))

5、原理代码：

    '''
   遇到问题没人解答？小编创建一个Python学习交流qq群：857662006 
   寻找有志同道合的小伙伴，互帮互助,群里还有不错的视频学习教程和PDF电子书！
   '''
import socket
import hashlib
import base64


def get_headers(data):
   """
   将请求头格式化成字典
   :param data:
   :return:
   """
   header_dict = {}
   data = str(data, encoding='utf-8')

   header, body = data.split('\r\n\r\n', 1)
   header_list = header.split('\r\n')
   for i in range(0, len(header_list)):
       if i == 0:
           if len(header_list[i].split(' ')) == 3:
               header_dict['method'], header_dict['url'], header_dict['protocol'] = header_list[i].split(' ')
       else:
           k, v = header_list[i].split(':', 1)
           header_dict[k] = v.strip()
   return header_dict

def send_msg(conn, msg_bytes):
   """
   WebSocket服务端向客户端发送消息
   :param conn: 客户端连接到服务器端的socket对象,即： conn,address = socket.accept()
   :param msg_bytes: 向客户端发送的字节
   :return:
   """
   import struct

   token = b"\x81"
   length = len(msg_bytes)
   if length < 126:
       token += struct.pack("B", length)
   elif length <= 0xFFFF:
       token += struct.pack("!BH", 126, length)
   else:
       token += struct.pack("!BQ", 127, length)

   msg = token + msg_bytes
   conn.send(msg)
   return True

sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
sock.bind(('127.0.0.1', 8002))
sock.listen(5)

# 等待用户连接
conn, address = sock.accept()

# WebSocket发来的连接
# 1. 获取握手数据
data = conn.recv(1024)
headers = get_headers(data)

# 2. 对握手信息进行加密：
magic_string = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
value = headers['Sec-WebSocket-Key'] + magic_string
ac = base64.b64encode(hashlib.sha1(value.encode('utf-8')).digest())

# 3. 返回握手信息
response_tpl = "HTTP/1.1 101 Switching Protocols\r\n" \
     "Upgrade:websocket\r\n" \
     "Connection: Upgrade\r\n" \
     "Sec-WebSocket-Accept: %s\r\n" \
     "WebSocket-Location: ws://127.0.0.1:8002\r\n\r\n"

response_str = response_tpl % (ac.decode('utf-8'),)

conn.sendall(bytes(response_str, encoding='utf-8'))

# 之后，才能进行首发数据。

while True:
   # 对数据进行解密
   # send_msg(conn, bytes('alex', encoding='utf-8'))
   # send_msg(conn, bytes('SB', encoding='utf-8'))
   # info = conn.recv(8096)
   # print(info)

   info = conn.recv(8096)
   payload_len = info[1] & 127
   if payload_len == 126:
       extend_payload_len = info[2:4]
       mask = info[4:8]
       decoded = info[8:]
   elif payload_len == 127:
       extend_payload_len = info[2:10]
       mask = info[10:14]
       decoded = info[14:]
   else:
       extend_payload_len = None
       mask = info[2:6]
       decoded = info[6:]

   bytes_list = bytearray()
   for i in range(len(decoded)):
       chunk = decoded[i] ^ mask[i % 4]
       bytes_list.append(chunk)
   msg = str(bytes_list, encoding='utf-8')

   rep = msg + 'sb'
   send_msg(conn,bytes(rep,encoding='utf-8'))

<!DOCTYPE html>
<html lang="en">
<head>
   <meta charset="UTF-8">
   <title>Title</title>
</head>
<body>
   <h1>WebSocket协议学习</h1>

   <script type="text/javascript">
       // 向 127.0.0.1:8002 发送一个WebSocket请求
       var socket = new WebSocket("ws://127.0.0.1:8002");
       socket.onmessage = function (event) {
       /* 服务器端向客户端发送数据时，自动执行 */
       var response = event.data;
       console.log(response);
   };
   </script>
</body>
</html>

二、应用：

1、Flask中应用： pip3 install gevent-websocket

    '''
    遇到问题没人解答？小编创建一个Python学习交流qq群：857662006 
    寻找有志同道合的小伙伴，互帮互助,群里还有不错的视频学习教程和PDF电子书！
    '''
from flask import Flask,request,render_template,session,redirect
import uuid
import json
from geventwebsocket.handler import WebSocketHandler
from gevent.pywsgi import WSGIServer


app = Flask(__name__)
app.secret_key = 'asdfasdf'

GENTIEMAN = {
    '1':{'name':'钢弹','count':0},
    '2':{'name':'铁锤','count':0},
    '3':{'name':'闫帅','count':0},
}

WEBSOCKET_DICT = {

}

@app.before_request
def before_request():
    if request.path == '/login':
        return None
    user_info = session.get('user_info')
    if user_info:
        return None
    return redirect('/login')

@app.route('/login',methods=['GET','POST'])
def login():
    if request.method == "GET":
        return render_template('login.html')
    else:
        uid = str(uuid.uuid4())
        session['user_info'] = {'id':uid,'name':request.form.get('user')}
        return redirect('/index')

@app.route('/index')
def index():
    return render_template('index.html',users=GENTIEMAN)

@app.route('/message')
def message():
    # 1. 判断到底是否是websocket请求？
    ws = request.environ.get('wsgi.websocket')
    if not ws:
        return "请使用WebSocket协议"
    # ----- ws连接成功 -------
    current_user_id = session['user_info']['id']
    WEBSOCKET_DICT[current_user_id] = ws
    while True:
        # 2. 等待用户发送消息，并接受
        message = ws.receive() # 帅哥ID
        # 关闭：message=None
        if not message:
            del WEBSOCKET_DICT[current_user_id]
            break

        # 3. 获取用户要投票的帅哥ID,并+1
        old = GENTIEMAN[message]['count']
        new = old + 1
        GENTIEMAN[message]['count'] = new

        data = {'user_id': message, 'count': new,'type':'vote'}
        # 4. 给所有客户端推送消息
        for conn in WEBSOCKET_DICT.values():
            conn.send(json.dumps(data))
    return 'close'

@app.route('/notify')
def notify():
    data = {'data': "你的订单已经生成，请及时处理；", 'type': 'alert'}
    print(WEBSOCKET_DICT)
    for conn in WEBSOCKET_DICT.values():
        conn.send(json.dumps(data))
    return '发送成功'



![在这里插入图片描述](https://img-blog.csdnimg.cn/20210511152217670.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3poaWd1aWd1,size_16,color_FFFFFF,t_70)

**感谢每一个认真阅读我文章的人，看着粉丝一路的上涨和关注，礼尚往来总是要有的：**



①　2000多本Python电子书（主流和经典的书籍应该都有了）

②　Python标准库资料（最全中文版）

③　项目源码（四五十个有趣且经典的练手项目及源码）

④　Python基础入门、爬虫、web开发、大数据分析方面的视频（适合小白学习）

⑤ Python学习路线图（告别不入流的学习）




**网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。**

**[需要这份系统化学习资料的朋友，可以戳这里无偿获取](https://bbs.csdn.net/topics/618317507)**

**一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！**

功勋Web工程师

关注

16
点赞
踩
15

收藏

觉得还不错? 一键收藏
2
评论
Python之WebSocket协议_python websocket onopen

Websocket协议通过序列化的数据帧传输数据。数据封包协议中定义了opcode、payload length、Payload data等字段。针对上情况，发现错误的一方可向对方发送close帧（状态码是1002，表示协议错误），以关闭连接。这里的长度表示遵循一个原则，用最少的字节表示长度（尽量减少不必要的传输）。举例说，payload真实长度是124，在0-125之间，必须用前7位表示；不允许长度1是126或127，然后长度2是124，这样违反原则。
复制链接

扫一扫