WebSocket实时流式传输

名词解释

维基百科对websocket的解释如下：

WebSocket是一种计算机通信协议，在单个TCP连接上提供全双工通信通道。

WebSocket不同于HTTP。这两个协议都位于OSI模型的第7层，并依赖于第4层的TCP。虽然它们是不同的，但RFC 6455声明WebSocket“被设计为在HTTP端口443和80上工作，并支持HTTP代理和中介”，从而使其与HTTP兼容。为了实现兼容性，WebSocket握手使用HTTP升级头从HTTP协议更改为WebSocket协议。

与HTTP轮询等半双工替代方案相比，WebSocket协议使web浏览器(或其他客户端应用程序)与web服务器之间的交互开销更低，从而促进了与服务器之间的实时数据传输。这是通过为服务器提供一种标准化的方式来实现的，它可以在客户端不首先请求的情况下向客户端发送内容，并允许在保持连接打开的情况下来回传递消息。通过这种方式，可以在客户机和服务器之间进行双向的持续对话。

与HTTP不同，WebSocket提供全双工通信。此外，WebSocket支持TCP之上的消息流。TCP单独处理没有消息固有概念的字节流。在WebSocket之前，使用Comet通道可以实现80端口全双工通信；然而，Comet的实现并不简单，而且由于TCP握手和HTTP头开销，它对于小消息的效率很低。WebSocket协议旨在解决这些问题，而不损害web的安全假设。

WebSocket协议规范将ws （WebSocket）和wss （WebSocket Secure）定义为两种新的统一资源标识符(URI)方案，分别用于未加密和加密的连接。除了方案名称和片段（即不支持#），其余的URI组件被定义为使用URI泛型语法。

环境安装

pip install websockets
# 检查是否安装成功及版本
python -m websockets --version

Example One

服务器Server

# ws_server.py

import asyncio
import websockets
from websockets.server import serve

async def echo(websocket):
    async for message in websocket:
        await websocket.send(message)

async def main():
    async with serve(echo, "localhost", 8765):
        await asyncio.Future()  # run forever

asyncio.run(main())

详细的Server接口参数定义：

await websockets.server.serve(ws_handler, host=None, port=None, *, 
	create_protocol=None, logger=None, compression='deflate', origins=None, 
	extensions=None, subprotocols=None, extra_headers=None, 
	server_header='Python/x.y.z websockets/X.Y', process_request=None, 
	select_subprotocol=None, ping_interval=20, ping_timeout=20, 
	close_timeout=10, max_size=2**20, max_queue=2**5, read_limit=2**16, 
	write_limit=2**16, **kwds)

客户端Client

# ws_client.py

import asyncio
from websockets.sync.client import connect

def hello():
    with connect("ws://localhost:8765") as websocket:
        websocket.send("Hello world!")
        message = websocket.recv()
        print(f"Received: {message}")

hello()

详细的Client接口参数定义：

await websockets.client.connect(uri, *, create_protocol=None, logger=None, 
	compression='deflate', origin=None, extensions=None, subprotocols=None, 
	extra_headers=None, user_agent_header='Python/x.y.z websockets/X.Y', open_timeout=10, 
	ping_interval=20, ping_timeout=20, close_timeout=10, max_size=2**20, max_queue=2**5, 
	read_limit=2**16, write_limit=2**16, **kwds)

Example Two

Server

基本流程是：Server端接收Client端发送的数据请求、解析并处理，处理完成后，将结果返回给Client端。

# ws_server.py

import asyncio
import websockets
from websockets.server import serve
import base64
import numpy as np

async def ASR(websocket):
	# async for message in websocket:
	# 	await websocket.send(message)

	# 接收来自Client的请求
	server_recv_data_json = websocket.recv()

	# 字符串转为字典 格式
	server_recv_data_dict = json.loads(server_recv_data_json)

	# base64 解码为 字节
	audio_bytes = base64.b64decode(server_recv_data_dict["audio_base64"])

	# bytes to numpy
	audio_np = np.array(audio_bytes)

	# ASR model
	text = ASR_Model(audio_np)

	server_send_data_dict = {
		"text": text,
		"state": "success",
		"xxx": base64.b64encode("xxx").decode("utf-8") # 取决你的接口参数定义
	}

	# Server返回请求结果
	server_send_data_json = json.dumps(server_send_data_dict)
	await websocket.send(server_send_data_json)


async def main():
    async with serve(ASR, "0.0.0.0", 8765): # 函数名根据实际任务命名，端口号根据容器端口或实际端口设置
	await asyncio.Future()  # run forever

asyncio.run(main())

Client

基本流程是：Client端请求并发送数据，Server端响应、处理、并返回结果，Client端接收Server端返回的结果。

# ws_client.py

import asyncio
from websockets.sync.client import connect
import base64
import json

def ASR_Client():
    with connect("ws://0.0.0.0:8765") as websocket:
	# 读取音频文件
	with open("./audio.wav", "rb") as file:
		audio_bytes = file.read()

	client_send_data_dict = {
		"audio_base64": base64.b64encode(audio_bytes).decode("utf-8")
	}
	# 将字典转为字符串
	client_send_data_json = json.dumps(client_send_data_dict)

	# Client以json格式发送数据
	await websocket.send(client_send_data_json)

	# 等待，直到Server返回结果数据
	client_recv_data = websocket.recv()
	print(f"<<< Client Received: {client_recv_data}")
        print("<<< 完成一次请求。")

ASR_Client()

代码调试

在两个终端页面，分别运行python ws_server.py 和 python ws_client.py 进行代码调试。

参考资料

【1】https://websockets.readthedocs.io/en/stable/

致读者

本人才疏学浅，未免有理解不到位之处；为方便总结与回顾，特以此方式记录学习过程。