使用 Python 实现 WebSocket 服务器与客户端通信

简介

WebSocket 是一种基于 TCP 协议的通信协议，可以或许在客户端与服务器之间举行全双工（双向）通信。相比传统的 HTTP 协议，WebSocket 可以实现及时数据的传输，尤其适合需要及时交互的应用场景，如在线游戏、及时谈天、金融生意业务等。
我通过 Python 实现一个简朴的 WebSocket 服务器，并使其与客户端举行通信。我们将创建两个 Python 文件：websocket.py 和 main.py，websocket.py 负责实现 WebSocket 服务器的功能，main.py 负责启动和管理服务器，以及定时向客户端发送消息。
安装 WebSocket 库

在开始之前，需要安装 websockets 库，它是 Python 中非常盛行的 WebSocket 实现。

1. pip install websockets

复制代码

websocket.py — WebSocket 服务器实现

在 websocket.py 文件中，我界说了一个 WebSocketServer 类，包罗了 WebSocket 服务器的主要逻辑。
代码解析

1. import asyncio
2. import websockets
4. class WebSocketServer:
5.     def __init__(self, host="localhost", port=8765):
6.         self.host = host
7.         self.port = port
8.         self.clients = set()  # 存储所有连接的客户端

复制代码

首先，我创建了一个 WebSocketServer 类，它的构造方法初始化了服务器的主机地点 host 和端标语 port，同时维护了一个客户端集合 clients 来存储当前连接的 WebSocket 客户端。

1.     async def handle_client(self, websocket):
2.         # 新的客户端连接
3.         self.clients.add(websocket)
4.         try:
5.             async for message in websocket:
6.                 print(f"收到消息: {message}")
7.                 # 回显消息给客户端
8.                 await websocket.send(f"服务器已收到: {message}")
9.         except websockets.ConnectionClosed as e:
10.             print(f"客户端断开连接: {e}")
11.         finally:
12.             # 移除断开的客户端
13.             self.clients.remove(websocket)

复制代码

handle_client 是一个异步方法，用来处理处罚与客户端的连接。在客户端发送消息时，服务器会接收到该消息，并通过 websocket.send() 方法将回显消息发送给客户端。假如客户端断开连接，捕捉到 ConnectionClosed 非常，并从 clients 集合中移除该客户端。

1.     async def send(self, message):
2.         """向所有连接的客户端发送消息"""
3.         if not self.clients:
4.             print("没有客户端连接，无法发送消息")
5.             return
6.         disconnected_clients = set()
7.         for client in self.clients:
8.             try:
9.                 await client.send(message)
10.             except websockets.ConnectionClosed:
11.                 disconnected_clients.add(client)
12.         # 清理已断开的客户端
13.         self.clients -= disconnected_clients

复制代码

send 方法允许服务器向全部连接的客户端发送消息。假如有客户端断开连接，服务器会将其从 clients 集合中移除。

1.     async def start(self):
2.         print(f"启动 WebSocket 服务器: ws://{self.host}:{self.port}")
3.         async with websockets.serve(self.handle_client, self.host, self.port):
4.             await asyncio.Future()  # 持续运行直到手动停止

复制代码

start 方法启动 WebSocket 服务器，通过 websockets.serve() 启动一个 WebSocket 服务，该服务会监听来自客户端的连接请求，并调用 handle_client 方法处理处罚这些请求。await asyncio.Future() 会让服务器一连运行，直到手动停止。
main.py — 启动 WebSocket 服务器并定时发送消息

在 main.py 文件中，创建了一个 WebSocket 服务器的实例，并启动了一个定时任务，定期向连接的客户端发送消息。
代码解析

1. import asyncio
2. from websocket import WebSocketServer
4. async def main():
5.     # 创建 WebSocket 服务器实例
6.     websocket_server = WebSocketServer()
7.     websocket_task = asyncio.create_task(websocket_server.start())  # 启动 WebSocket 服务器

复制代码

在 main() 函数中，首先创建了 WebSocketServer 的实例，并启动了 WebSocket 服务器。

1.     # 定时向 WebSocket 客户端发送数据
2.     async def send_data_periodically():
3.         while True:
4.             await asyncio.sleep(5)  # 每 5 秒发送一次数据
5.             await websocket_server.send("服务器定时发送消息：ping")

复制代码

send_data_periodically 是一个定时任务，每隔 5 秒就向全部连接的客户端发送一次 "服务器定时发送消息：ping"。

1.     periodic_task = asyncio.create_task(send_data_periodically())
2.     # 并发运行所有任务
3.     await asyncio.gather(websocket_task, periodic_task)

复制代码

通过 asyncio.create_task() 启动了定时任务，并通过 asyncio.gather() 并发运行 WebSocket 服务器和定时发送消息的任务。

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

复制代码

末了，我们 asyncio.run(main()) 启动了整个步伐。
总结

通过这两个文件，实现了一个简朴的 WebSocket 服务器，该服务器可以或许接收客户端消息并举行回显。同时，服务器也可以或许定时向全部连接的客户端发送消息。
完整代码

websocket.py

1. import asyncio
2. import websockets
4. class WebSocketServer:
5.     def __init__(self, host="localhost", port=8765):
6.         self.host = host
7.         self.port = port
8.         self.clients = set()  # 存储所有连接的客户端
10.     async def handle_client(self, websocket):
11.         # 新的客户端连接
12.         self.clients.add(websocket)
13.         try:
14.             async for message in websocket:
15.                 print(f"收到消息: {message}")
16.                 # 回显消息给客户端
17.                 await websocket.send(f"服务器已收到: {message}")
18.         except websockets.ConnectionClosed as e:
19.             print(f"客户端断开连接: {e}")
20.         finally:
21.             # 移除断开的客户端
22.             self.clients.remove(websocket)
24.     async def send(self, message):
25.         """向所有连接的客户端发送消息"""
26.         if not self.clients:
27.             print("没有客户端连接，无法发送消息")
28.             return
29.         disconnected_clients = set()
30.         for client in self.clients:
31.             try:
32.                 await client.send(message)
33.             except websockets.ConnectionClosed:
34.                 disconnected_clients.add(client)
35.         # 清理已断开的客户端
36.         self.clients -= disconnected_clients
38.     async def start(self):
39.         print(f"启动 WebSocket 服务器: ws://{self.host}:{self.port}")
40.         async with websockets.serve(self.handle_client, self.host, self.port):
41.             await asyncio.Future()  # 持续运行直到手动停止

复制代码

main.py

1. import asyncio
2. from websocket import WebSocketServer
4. async def main():
5.     # 创建 WebSocket 服务器实例
6.     websocket_server = WebSocketServer()
7.     websocket_task = asyncio.create_task(websocket_server.start())  # 启动 WebSocket 服务器
9.     # 定时向 WebSocket 客户端发送数据
10.     async def send_data_periodically():
11.         while True:
12.             await asyncio.sleep(5)  # 每 5 秒发送一次数据
13.             await websocket_server.send("服务器定时发送消息：ping")
15.     periodic_task = asyncio.create_task(send_data_periodically())
16.     # 并发运行所有任务
17.     await asyncio.gather(websocket_task, periodic_task)
18. if __name__ == "__main__":
19.     asyncio.run(main())

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。