python socketserver 文档 python socket web

转载

技术领航员 2023-11-13 13:48:53

文章标签 python 客户端服务端数据 文章分类 Python 后端开发

初识WebSocket及Python实现

WebSocket

WebSocket与HTTP的关系
WebSocket与Socket的关系
Python实现
参考文档

WebSocket

WebSocket 一种在单个 TCP 连接上实现浏览器与服务器全双工通信（同时双向信号传输）的协议。

目的：即时通讯，替代轮询
Web 基于 B/S 架构，通常使用 HTTP 协议进行通信，HTTP 本质是一个单向请求，若需要持续的获取服务端的数据变化，必须轮询（polling）进行数据请求【每隔一段时间发送request，服务器将新数据返回】。

使用HTTP协议处理服务端数据监控的弊端：轮询效率低，浪费资源。因为必须不停建立连接，或保持HTTP始终连接。

为了解决上述的需求问题，并提高数据传输效率，WebSocket 协议就出现了。

场景：需要服务端向客户端实时推送最新数据的场景，例如：社交聊天、弹幕、股票基金报价等。

优势：相对于传统 HTTP 每次请求-应答都需要客户端与服务端建立连接的模式，WebSocket 是类似 Socket 的 TCP 长连接的通讯模式，一旦 WebSocket 连接建立后，后续数据都以帧序列的形式传输。在客户端断开 WebSocket 连接或 Server 端断掉连接前，不需要客户端和服务端重新发起连接请求。在海量并发及客户端与服务器交互负载流量大的情况下，极大的节省了网络带宽资源的消耗，有明显的性能优势，且客户端发送和接受消息是在同一个持久连接上发起，实时性优势明显。

WebSocket与HTTP的关系

相同点

都是一样基于TCP的，都是可靠性传输协议。
都是应用层协议。

不同点

WebSocket是双向通信协议，可以双向发送或接受信息。HTTP是单向的。
WebSocket是需要握手进行建立连接的。

联系
WebSocket在建立握手时，数据是通过HTTP传输的。但是建立之后，在真正传输时候是不需要HTTP协议的。

WebSocket与Socket的关系

Socket其实并不是一个协议，而是为了方便使用TCP或UDP而抽象出来的一层，是位于应用层和传输控制层之间的一组接口。当两台主机通信时，必须通过Socket连接，Socket则利用TCP/IP协议建立TCP连接。

区别
Socket是传输控制层协议，WebSocket是应用层协议。

联系
WebSocket 类似于 Socket 的 TCP 长连接，一旦连接建立（握手成功）后，可以持续双向传输数据。在客户端断开连接或服务端断掉连接前，不需要重新发起连接请求。

Python实现

基于Python socket实现的WebSocket服务端：

import socket
import base64
import hashlib

HOST = '127.0.0.1'
PORT = 8003
BUF_SIZE = 8096

def run():
    # 创建服务端的socket对象socketserver
    # socket(family,type[,protocal]) 使用给定的地址族、套接字类型、协议编号（默认为0）来创建套接字。
    # socket.AF_INET: IPv4（默认）
    # socket.SOCK_STREAM: 流式socket , for TCP （默认）
    socketserver = socket.socket(socket.AF_INET, socket.SOCK_STREAM)

    # 绑定本地ip和端口
    # socket.bind(address)：将套接字绑定到地址, 在AF_INET下,以元组（host,port）的形式表示地址.
    socketserver.bind((HOST, PORT))

    # 启动监听
    # socket.listen(backlog)：开始监听TCP传入连接。
    # backlog指定在拒绝连接之前，操作系统可以挂起的最大连接数量。该值至少为1，大部分应用程序设为5就可以了。
    socketserver.listen(5)
    print('listening')

    # socket.accept()：接受客户端连接请求，返回值（conn, address）, 其中conn是新的套接字对象（即代表客户端的socket对象），可以用来接收和发送数据。address是连接客户端的地址。
    conn, address = socketserver.accept()
    print('handshaking:', address)

    # 获取客户端的【握手】信息
    # socket.recv(bufsize[,flag]) ：接受TCP套接字的数据。数据以字符串形式返回，bufsize指定要接收的最大数据量。flag提供有关消息的其他信息，通常可以忽略。
    data = conn.recv(1024)

    # 根据Websocket协议：请求和响应的【握手】信息需要遵循规则：
    # 从请求【握手】信息中提取 Sec-WebSocket-Key
    # 利用magic_string 和 Sec-WebSocket-Key 进行hmac1加密，再进行base64加密
    # 将加密结果响应给客户端
    headers = get_headers(data)
    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://%s%s\r\n\r\n"

    magic_string = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
    value = headers['Sec-WebSocket-Key'] + magic_string

    ac = base64.b64encode(hashlib.sha1(value.encode('utf-8')).digest())
    response_str = response_tpl % (ac.decode('utf-8'), headers['Host'], headers['url'])

    # 响应【握手】信息
    # socket.send(string[,flag])发送TCP数据。
    # 将string中的数据发送到连接的套接字。返回值是要发送的字节数量，该数量可能小于string的字节大小。
    send_ret = conn.send(bytes(response_str, encoding='utf-8'))
    print(send_ret, len(response_str), 'finished handshake')

    # 持续接收和客户端传来的数据，发生异常时服务端主动关闭TCP连接，未发生异常时由客户端主动关闭TCP连接
    while True:
        try:
            info = conn.recv(BUF_SIZE)
            print('recv data:',len(info))
        except Exception as e:
            info = None
            print(e)
        if not info:
            break

        # 客户端和服务端传输数据时，需要对数据进行【封包】和【解包】。
        # 客户端的JavaScript类库已经封装【封包】和【解包】过程，但Socket服务端需要手动实现。
        # 获取客户端发送的数据【解包】
        body = parse_msg(info)
        print(body)

        # 向客户端发送数据【封包】
        send_msg(conn, body.encode('utf-8'))

    socketserver.close()


def get_headers(data):
    """
    将请求头格式化成字典
    :param data: 服务端接收到的数据，即conn.recv(8096)的返回值
    :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 parse_msg(info):
    """
    【解包】客户端发送的数据
    :param data: 服务端接收到的数据，即conn.recv(8096)的返回值
    :return: 字典格式的请求头
    """
    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)
    body = str(bytes_list, encoding='utf-8')
    return body

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


if __name__ == '__main__':
    run()

利用JavaScript类库实现客户端

<!DOCTYPE html>
<html>
<head lang="en">
    <meta charset="UTF-8">
    <title></title>
</head>
<body>
    <div>
        <input type="text" id="txt"/>
        <input type="button" id="btn" value="提交" onclick="sendMsg();"/>
        <input type="button" id="close" value="关闭连接" onclick="closeConn();"/>
    </div>
    <div id="content"></div>

<script type="text/javascript">
    var socket = new WebSocket("ws://127.0.0.1:8003");

    socket.onopen = function () {
        /* 与服务器端连接成功后，自动执行 */

        var newTag = document.createElement('div');
        newTag.innerHTML = "【连接成功】";
        document.getElementById('content').appendChild(newTag);
    };

    socket.onmessage = function (event) {
        /* 服务器端向客户端发送数据时，自动执行 */
        var response = event.data;
        var newTag = document.createElement('div');
        newTag.innerHTML = response;
        document.getElementById('content').appendChild(newTag);
    };

    socket.onclose = function (event) {
        /* 服务器端主动断开连接时，自动执行 */
        var newTag = document.createElement('div');
        newTag.innerHTML = "【关闭连接】";
        document.getElementById('content').appendChild(newTag);
    };

    function sendMsg() {
        var txt = document.getElementById('txt');
        socket.send(txt.value);
        txt.value = "";
    }
    function closeConn() {
        socket.close();
        var newTag = document.createElement('div');
        newTag.innerHTML = "【关闭连接】";
        document.getElementById('content').appendChild(newTag);
    }

</script>
</body>
</html>

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。