Python / 系统课时

用 Stream API 接收客户端

用 Stream API 接收客户端

asyncio 的 Stream API 把监听 Socket、接受连接和非阻塞收发封装成 StreamReader 与 StreamWriter。本节用一个可直接运行的 TCP 示例串起连接进入、读取、回复和关闭流程,建立可用于后续协议处理的最小服务骨架。

学习目标

  • 使用 asyncio.start_server() 创建异步 TCP 监听服务。
  • 理解每个客户端连接对应的 StreamReader 与 StreamWriter 职责。
  • 正确完成读取、回写、背压等待和连接关闭,并验证完整连接流程。

start_server 把哪些工作交给事件循环

asyncio.start_server(client_connected_cb, host, port) 会创建监听 Socket,并把接受连接的工作注册到当前事件循环。新客户端到达时,事件循环接受连接,为它准备一对流对象,再调用 client_connected_cb(reader, writer)。

如果连接处理函数是 async def,它返回的协程会被安排为任务继续运行。这样每个连接都可以在等待网络数据时挂起,让事件循环去处理其他连接,而不是为每个客户端占住一个线程。

start_server() 返回的 Server 对象代表监听端。使用 async with server: 可以把监听生命周期限制在明确作用域内;退出作用域时停止继续接收新连接。

Stream API 接收客户端流程

每个连接拿到的两个对象

StreamReader 负责异步读取。调用 await reader.readline() 时,如果一整行还没到达,当前连接处理任务会挂起,不会阻塞事件循环;收到换行符或 EOF 后才恢复。它适合文本行协议,二进制协议通常需要按长度读取,例如 readexactly()。

StreamWriter 负责写入与连接控制。writer.write() 先把数据交给传输缓冲区,await writer.drain() 在缓冲区压力较大时提供背压,避免应用无限制地堆积待发送数据。处理结束后应调用 writer.close(),并用 await writer.wait_closed() 等待关闭完成。

通过 writer.get_extra_info("peername") 可以取得对端地址等连接信息。对端端口通常是临时值,日志和测试不应假定它固定不变。

最小可运行服务

下面的程序监听 127.0.0.1,让操作系统自动分配端口,然后在同一个事件循环里启动一个测试客户端。这样不需要额外终端,也能验证服务端确实经历了接受连接、读取一行、回复和关闭的完整流程。

python
import asyncio

HOST = "127.0.0.1"

async def handle_client(reader, writer):
    peer = writer.get_extra_info("peername")

    # readline 会在数据不足时挂起当前连接任务,而不是阻塞线程。
    data = await reader.readline()
    message = data.decode().rstrip()
    print(f"server: received {message!r} from {peer[0]}")

    writer.write(f"echo:{message}\n".encode())
    # drain 用于在写缓冲区产生压力时等待可继续发送。
    await writer.drain()

    writer.close()
    await writer.wait_closed()

async def run_client(port):
    reader, writer = await asyncio.open_connection(HOST, port)
    writer.write(b"hello\n")
    await writer.drain()

    reply = await reader.readline()
    print("client:", reply.decode().rstrip())

    writer.close()
    await writer.wait_closed()

async def main():
    # 端口传 0,让系统选择当前可用端口,避免示例与本机服务冲突。
    server = await asyncio.start_server(handle_client, HOST, 0)
    port = server.sockets[0].getsockname()[1]
    print(f"server: listening on {HOST}:{port}")

    async with server:
        await run_client(port)

    print("server: closed")

asyncio.run(main())

预期输出

text
server: listening on 127.0.0.1:<PORT>
server: received 'hello' from 127.0.0.1
client: echo:hello
server: closed

<PORT> 是操作系统动态分配的实际监听端口,每次运行都可能不同。服务端收到 hello\n 后,readline() 返回这一行;回复写入并完成 drain() 后,客户端读到 echo:hello。

连接处理的边界

一次连接不一定只对应一次消息。真实服务需要先定义消息边界:文本协议可以按行读取,固定头部协议可以先读长度字段再调用 readexactly()。如果没有边界,单纯使用 read() 很容易把“TCP 字节流”误当成“一次发送对应一次接收”。

客户端可能在读取或写入期间断开,因此生产代码通常会在连接处理函数中捕获协议相关异常,并在 finally 中关闭 StreamWriter。同时不要在处理协程里执行长时间 CPU 计算或阻塞式 I/O;这些操作会占住事件循环线程,让其他客户端即使已经就绪也无法及时运行。

start_server() 解决的是异步接受连接和流式收发,不会自动定义应用协议、超时、并发上限或异常策略。先把每个连接的读取边界、回复时机和关闭条件定义清楚,Stream API 才能稳定地支撑更高层的 TCP 服务。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

用 Stream API 接收客户端

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通