Python WebSocket服务器端详解|极客教程

Python WebSocket服务器端详解

1. 引言

WebSocket是一种在单个TCP连接上进行全双工通信的协议，它实现了服务器与客户端之间的实时双向数据传输。在Python中，我们可以使用第三方库websockets来创建WebSocket服务器端。本文将详细介绍如何使用Python来实现一个WebSocket服务器端。

2. 安装`websockets`库

在开始之前，我们首先需要安装websockets库。可以使用以下命令来安装：

pip install websockets

3. 创建WebSocket服务器端

接下来我们将创建一个简单的WebSocket服务器端。首先，导入websockets库，并创建一个async函数作为服务器的主体。

import asyncio
import websockets

async def server(websocket, path):
    # 在这里写入WebSocket服务器的处理逻辑
    pass

在上述代码中，我们定义了一个名为server的异步函数，并接收两个参数：websocket和path。其中websocket表示一个WebSocket连接对象，path表示客户端请求的路径。

在这个函数的主体部分，我们可以编写WebSocket服务器的处理逻辑。例如在收到客户端的消息后，服务器可以向客户端发送一条回复消息。

4. WebSocket服务器的事件循环

接下来，我们需要创建一个事件循环并在其中绑定WebSocket服务器。

start_server = websockets.serve(server, 'localhost', 8765)

asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()

在上述代码中，我们使用websockets.serve函数创建一个WebSocket服务器对象，并将之前定义的server函数作为参数传入。其中，localhost表示绑定到本地主机，8765表示监听的端口号。

之后，我们使用asyncio.get_event_loop().run_until_complete方法将WebSocket服务器绑定到事件循环，并使用asyncio.get_event_loop().run_forever方法启动事件循环。

至此，我们已经创建了一个简单的WebSocket服务器端。下面我们将给出几个示例来说明如何使用WebSocket服务器端进行实时通信。

5. 示例1：简单的回复服务

下面我们将给出一个简单的示例，展示如何在收到客户端消息时回复一个简单的固定消息。

import asyncio
import websockets

async def server(websocket, path):
    message = await websocket.recv()
    print(f"Received message from client: {message}")

    response = "Hello from server!"
    await websocket.send(response)
    print(f"Sent response to client: {response}")

start_server = websockets.serve(server, 'localhost', 8765)

asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()

在这个示例中，当客户端连接到服务器时，服务器会收到一个消息。然后，服务器将该消息打印出来，并发送一条固定的回复消息。客户端在收到服务器的回复消息后，将其打印出来。

6. 示例2：广播消息

下面我们将给出一个示例，展示如何实现广播功能。即，当一个客户端发送消息时，服务器将此消息广播给所有其他客户端。

import asyncio
import websockets

# 记录所有连接的客户端
clients = set()

async def server(websocket, path):
    # 添加新的客户端到集合中
    clients.add(websocket)

    try:
        while True:
            message = await websocket.recv()
            print(f"Received message from client: {message}")

            # 广播消息给所有客户端
            for client in clients:
                await client.send(message)
                print(f"Sent message to client: {message}")
    finally:
        # 移除断开连接的客户端
        clients.remove(websocket)

start_server = websockets.serve(server, 'localhost', 8765)

asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()

在这个示例中，服务器创建了一个集合用于保存所有连接的客户端。当客户端连接到服务器时，服务器将客户端添加到集合中。当一个客户端发送消息时，服务器将此消息广播给所有其他客户端。当一个客户端断开连接时，服务器将该客户端从集合中移除。

7. 示例3：实时聊天室

下面我们将给出一个示例，展示如何实现一个简单的实时聊天室。

import asyncio
import websockets

# 记录所有连接的客户端
clients = set()

async def server(websocket, path):
    # 添加新的客户端到集合中
    clients.add(websocket)

    try:
        while True:
            message = await websocket.recv()
            print(f"Received message from client: {message}")

            # 广播消息给所有客户端
            for client in clients:
                await client.send(message)
                print(f"Sent message to client: {message}")
    finally:
        # 移除断开连接的客户端
        clients.remove(websocket)

start_server = websockets.serve(server, 'localhost', 8765)

asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()

8. 示例4：使用WebSocket协议的子协议

在上述示例中，我们使用了默认的子协议来创建WebSocket服务器。如果需要使用特定的子协议，可以在websockets.serve函数中传入subprotocols参数。下面给出一个示例，演示如何使用chat子协议来创建WebSocket服务器。

import asyncio
import websockets

async def server(websocket, path):
    # 在这里写入WebSocket服务器的处理逻辑
    pass

start_server = websockets.serve(server, 'localhost', 8765, subprotocols=['chat'])

asyncio.get_event_loop().run_until_complete(start_server)
asyncio.get_event_loop().run_forever()

在这个示例中，我们在websockets.serve函数中传入了subprotocols=['chat']参数，表示使用chat子协议进行通信。