# aiowebsocket **Repository Path**: mirrors_asyncins/aiowebsocket ## Basic Information - **Project Name**: aiowebsocket - **Description**: Async WebSocket Client. Advantage: Flexible Lighter and Faster - **Primary Language**: Unknown - **License**: Not specified - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2022-01-11 - **Last Updated**: 2026-01-25 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # aiowebsocket: Asynchronous websocket client AioWebSocket is an asynchronous WebSocket client that follows the WebSocket specification and is lighter and faster than other libraries. AioWebSocket是一个遵循 WebSocket 规范的 异步 WebSocket 客户端，相对于其他库它更轻、更快。 ![images](https://github.com/asyncins/aiowebsocket/blob/master/images/aiowebsocket.jpg) ``` Why is it Lighter？ Code volume just 30 KB Why is it Faster？ it is based on asyncio and asynchronous ``` # Installation ``` pip install aiowebsocket ``` # Usage The relationship between WSS and WS is just like HTTPS and HTTP. ### ws and wss Now it can automatically recognize WS and WSS ``` import asyncio import logging from datetime import datetime from aiowebsocket.converses import AioWebSocket async def startup(uri): async with AioWebSocket(uri) as aws: converse = aws.manipulator message = b'AioWebSocket - Async WebSocket Client' while True: await converse.send(message) print('{time}-Client send: {message}' .format(time=datetime.now().strftime('%Y-%m-%d %H:%M:%S'), message=message)) mes = await converse.receive() print('{time}-Client receive: {rec}' .format(time=datetime.now().strftime('%Y-%m-%d %H:%M:%S'), rec=mes)) if __name__ == '__main__': remote = 'wss://echo.websocket.org' # remote = 'ws://echo.websocket.org' try: asyncio.get_event_loop().run_until_complete(startup(remote)) except KeyboardInterrupt as exc: logging.info('Quit.') ``` ### custom header aiowebsocket just build a request header that meets the websocket standard, but some websites need to add additional information so that you can use a custom request header,like this: ``` import asyncio import logging from datetime import datetime from aiowebsocket.converses import AioWebSocket async def startup(uri, header): async with AioWebSocket(uri, headers=header) as aws: converse = aws.manipulator message = b'AioWebSocket - Async WebSocket Client' while True: await converse.send(message) print('{time}-Client send: {message}' .format(time=datetime.now().strftime('%Y-%m-%d %H:%M:%S'), message=message)) mes = await converse.receive() print('{time}-Client receive: {rec}' .format(time=datetime.now().strftime('%Y-%m-%d %H:%M:%S'), rec=mes)) if __name__ == '__main__': remote = 'ws://123.207.167.163:9010/ajaxchattest' header = [ 'GET /ajaxchattest HTTP/1.1', 'Connection: Upgrade', 'Host: 123.207.167.163:9010', 'Origin: http://coolaf.com', 'Sec-WebSocket-Key: RmDgZzaqqvC4hGlWBsEmwQ==', 'Sec-WebSocket-Version: 13', 'Upgrade: websocket', ] try: asyncio.get_event_loop().run_until_complete(startup(remote, header)) except KeyboardInterrupt as exc: logging.info('Quit.') ``` ### union header Consider: because AIO provides the basic request header, and sometimes does not need to replace all the request headers, but only need to add or replace a field in the request header. So with the union_header parameter added, you can replace or add fields in the request header, such as Origin. ``` import asyncio import logging from datetime import datetime from aiowebsocket.converses import AioWebSocket async def startup(uri, union_header): async with AioWebSocket(uri, union_header=union_header) as aws: converse = aws.manipulator message = b'AioWebSocket - Async WebSocket Client' while True: await converse.send(message) print('{time}-Client send: {message}' .format(time=datetime.now().strftime('%Y-%m-%d %H:%M:%S'), message=message)) mes = await converse.receive() print('{time}-Client receive: {rec}' .format(time=datetime.now().strftime('%Y-%m-%d %H:%M:%S'), rec=mes)) if __name__ == '__main__': remote = 'ws://123.207.167.163:9010/ajaxchattest' union_header = {'Origin': 'http://coolaf.com'} try: asyncio.get_event_loop().run_until_complete(startup(remote, union_header)) except KeyboardInterrupt as exc: logging.info('Quit.') ``` union_header must be dict. With union, the request header information becomes： `# union_header = {'Origin': 'http://coolaf.com'}` ``` # before GET /chat HTTP/1.1 Host: server.example.com Upgrade: websocket Connection: Upgrade Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ== Origin: Python/3.7 ``` ``` # after GET /chat HTTP/1.1 Host: server.example.com Upgrade: websocket Connection: Upgrade Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ== Origin: http://coolaf.com ``` # Todo list * 整体测试：虽然在开发过程中做了很多测试，但是没有使用 TestCase 进行功能性测试，后期有时间会专门编写 aiowebsocket 的 Testase。 * 动作预处理：create/close connection 以及 open 等动作的预处理暂未设定，在 websockets 源码中有预处理的思想痕迹，我认为这是非常好的，值得我学习。 * 问题修正：记录使用过程中出现的问题，并腾出时间进行调优和修正。 # 版本记录 * 2019-03-07 aiowebsocket 1.0.0 dev-2 发布，新增自动识别和处理 ssl 能力、单个请求头字段添加/替换功能，优化数据帧读取逻辑。 * 2019-03-05 aiowebsocket 1.0.0 dev-1 发布，dev-1 版本具备 ws 和 wss 协议的连接能力，并且支持自定义 header。 # 作者信息 * 掘金小册作者 [Python 实战：用 Scrapyd 打造个人化的爬虫部署管理控制台](https://juejin.im/book/5bb5d3fa6fb9a05d2a1d819a) * 华为云社区认证云享专家 [云社区](https://bbs.huaweicloud.com/community/trends/id_1543810295325819) * 微信公众号[【进击的Coder】](http://mp.weixin.qq.com/profile?src=3×tamp=1564442339&ver=1&signature=EjWFEy17QPkai42rqDiACqLAzI5-q0qE*3Qr67VK1REKi16u4jc7RyjnTYIWlCfIc73zGS3RkQGspd-t2th22g==) 管理员之一 * 微信公众号[【Rust之蝉】](http://mp.weixin.qq.com/profile?src=3×tamp=1564442465&ver=1&signature=jlN9nxFjkVHEILFMnzzALKXA92Z5zGxbef7SbbICB5fRviONJ3BNTtd23Zomt33jNkf9arKU18ZHZ2JJy4Muhw==)号主 # 参考资料 * Python 网络和进程间通信 https://docs.python.org/3/library/ipc.html * WebSocket 规范 https://tools.ietf.org/html/rfc6455#section-1.2 * websocket-client https://github.com/websocket-client/websocket-client * WebSockets https://github.com/aaugustin/websockets * Python Web学习笔记之WebSocket 通信过程与实现 https://www.cnblogs.com/JetpropelledSnake/p/9033064.html#_label1 * python---websocket的使用 https://www.cnblogs.com/ssyfj/p/9245150.html # 开发故事 在开发 aiowebsocket 库之前，我参考了 websocket-client 和 websockets 这两个库，在阅读过源码以及使用过后觉得 WebSocket 的连接不仅仅要像它们一样方便，还要更轻、更快、更灵活，在代码结构上还可以更清晰。所以我在完全不懂 WebSocket 的情况下通过阅读文章、调试源码以及翻阅文档，最终用了 `7` 天时间完成 aiowebsocket 库的设计和开发。 目前 aiowebsocket 支持 ws 和 wss 这两种协议，同时允许使用自定义请求头，这极大的方便了使用者。下图是 aiowebsocket 库文件结构以及类的设计图： ![images](https://github.com/asyncins/aiowebsocket/blob/master/images/aiowebsocket-class.png) 相比 websockets 库的结构，aiowebsocket 库的文件结构非常清晰，并且代码量很少。由于 websockets 库用的是 asyncio 旧语法，并且通过继承StreameProtocol 实现自定义协议，加上功能设计不明确（有很多不明确的预处理和 pending task 存在），所以导致它的结构比较混乱。 整个 websockets 库的源码图我没有画出，但是在调试时候有绘制改进图，WebSocketsCommonProtocol 协议（改进草图）类似下图： ![images](https://github.com/asyncins/aiowebsocket/blob/master/images/WebSocketsCommonProtocol.png) 这是仅仅协议的改进草稿，还不包括其他模块。实际上源码的逻辑更为混乱，这也是导致我费尽心力设计一个新库的原因之一。 # WebSocket 及协议相关知识 什么是 WebSocket、WebSocket的优势、Python Socket、WebSocket 协议 请求头与握手连接、数据帧、Data Frame、Control Frame、掩码 Mask、平公公与彭公公 以上列出的知识，可以阅读我在掘金社区发表的文章 [WebSocket 从入门到写出开源库](https://juejin.im/post/5c7cdaabf265da2daf79c15f) ### WebSocket status Code [tools.ietf.org](https://tools.ietf.org/html/rfc6455#section-7.4.1) 状态码 | 名称 | 含义描述 -|-|- 0~999 | | 保留使用 | 1000 | CLOSE_NORMAL | 正常关闭; 无论为何目的而创建, 该链接都已成功完成任务. | 1001 | CLOSE_GOING_AWAY | 终端离开, 可能因为服务端错误, 也可能因为浏览器正从打开连接的页面跳转离开. | 1002 | CLOSE_PROTOCOL_ERROR | 由于协议错误而中断连接. 1003 | CLOSE_UNSUPPORTED | 由于接收到不允许的数据类型而断开连接 (如仅接收文本数据的终端接收到了二进制数据). 1004 | | 保留. 其意义可能会在未来定义. 1005 | CLOSE_NO_STATUS | 保留. 表示没有收到预期的状态码. 1006 | CLOSE_ABNORMAL | 保留. 用于期望收到状态码时连接非正常关闭 (也就是说, 没有发送关闭帧). 1007 | Unsupported Data | 由于收到了格式不符的数据而断开连接 (如文本消息中包含了非 UTF-8 数据). 1008 | Policy Violation | 由于收到不符合约定的数据而断开连接. 这是一个通用状态码, 用于不适合使用 1003 和 1009 状态码的场景. 1009 | CLOSE_TOO_LARGE | 由于收到过大的数据帧而断开连接. 1010 | Missing Extension | 客户端期望服务器商定一个或多个拓展, 但服务器没有处理, 因此客户端断开连接. 1011 | Internal Error | 客户端由于遇到没有预料的情况阻止其完成请求, 因此服务端断开连接. 1012 | Service Restart | 服务器由于重启而断开连接. 1013 | Try Again Later | 服务器由于临时原因断开连接, 如服务器过载因此断开一部分客户端连接. 1014 | |由 WebSocket标准保留以便未来使用. 1015 | TLS Handshake |保留. 表示连接由于无法完成 TLS 握手而关闭 (例如无法验证服务器证书). 1000–2999 | |保留用于定义此协议，其未来的修订版和在。中指定的扩展名永久和随时可用的公共规范。 3000–3999 | |保留供使用库/框架/应用程序。这些状态代码是直接在IANA注册。这些代码的解释该协议未定义。 4000–4999 | |保留供私人使用因此无法注册。这些代码可以由先前使用WebSocket应用程序之间的协议。解释这个协议未定义这些代码。