Python-WebSockets中broadcast函数使用注意事项

在使用Python-WebSockets库进行WebSocket开发时，很多开发者会遇到一个常见问题：尝试使用broadcast函数向所有连接的客户端广播消息时，可能会遇到"'WebSocketServerProtocol' object has no attribute 'protocol'"的错误。这个问题通常是由于版本兼容性问题导致的，下面我们来详细分析原因和解决方案。

问题现象

当开发者按照示例代码使用broadcast功能时，可能会遇到类似以下的错误信息：

AttributeError: 'WebSocketServerProtocol' object has no attribute 'protocol'. Did you mean: 'subprotocol'?

这个错误表明代码尝试访问WebSocketServerProtocol对象的protocol属性，但该属性并不存在。

问题根源

这个问题的根本原因在于Python-WebSockets库中存在两个不同的实现版本：

1. 旧版(legacy)实现
2. 新版(asyncio)实现

当开发者混合使用这两个版本的API时，就会出现兼容性问题。具体来说：

• 如果使用from websockets import serve导入服务端，得到的是旧版实现
• 如果使用from websockets.asyncio.server import broadcast导入广播功能，得到的是新版实现

这两个版本的WebSocketServerProtocol对象内部结构不同，因此无法互相兼容。

解决方案

要解决这个问题，需要确保使用统一的API版本。推荐的做法是全部使用新版(asyncio)实现：

from websockets.asyncio.server import serve, broadcast

这样导入的serve和broadcast函数都属于同一个实现版本，可以正常配合工作。

完整示例代码

以下是使用新版API的正确实现方式：

import asyncio
from websockets.asyncio.server import serve, broadcast

CONNECTIONS = set()

async def handler(websocket):
    CONNECTIONS.add(websocket)
    try:
        await websocket.wait_closed()
    finally:
        CONNECTIONS.remove(websocket)

def message_all(message):
    broadcast(CONNECTIONS, message)

async def main():
    async with serve(handler, "localhost", 8765):
        count = 1
        while True:
            await asyncio.sleep(10)
            print(f"test {count}")
            message_all(f"test {count}")
            count += 1

if __name__ == "__main__":
    asyncio.run(main())

最佳实践建议

1. 统一API版本：始终使用同一版本的API函数，避免混合使用新旧版本
2. 明确导入路径：优先从websockets.asyncio.server导入服务端相关功能
3. 检查文档：在使用新功能前，查阅最新文档确认正确的使用方法
4. IDE提示注意：某些IDE的自动导入可能会选择旧版路径，需要手动修正

通过遵循这些实践，可以避免类似的兼容性问题，确保WebSocket服务稳定运行。