Websockets库中广播功能的使用注意事项

在使用Python的websockets库进行WebSocket服务器开发时，广播功能是一个常见的需求。然而，在实际应用中，开发者可能会遇到一些兼容性问题，特别是在混合使用新旧版本API时。

问题现象

当尝试使用broadcast函数向所有连接的客户端发送消息时，可能会遇到类似"WebSocketServerProtocol对象没有protocol属性"的错误。这种错误通常表现为：

AttributeError: 'WebSocketServerProtocol' object has no attribute 'protocol'

问题根源

这个问题的根本原因在于websockets库中不同版本API的混用。websockets库提供了两种实现方式：

1. 旧版实现：通过from websockets import serve导入
2. 新版实现：通过from websockets.asyncio.server import serve导入

当开发者混合使用这两种实现时，就会出现兼容性问题。具体来说，如果使用旧版的serve创建服务器，却尝试使用新版设计的broadcast函数，就会导致上述错误。

解决方案

要解决这个问题，需要确保使用统一的API版本。正确的做法是：

from websockets.asyncio.server import serve, broadcast

而不是：

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

最佳实践

1. 统一导入路径：始终从websockets.asyncio.server导入所有需要的组件
2. 版本一致性：检查项目中所有websockets相关的导入语句，确保它们都来自同一路径
3. 代码审查：在团队开发中，特别注意审查websockets相关的导入语句

示例代码

以下是正确使用广播功能的示例代码：

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())

通过遵循这些实践，可以避免因API版本不一致导致的各种兼容性问题，确保WebSocket服务器的稳定运行。