在 asyncio 中正确调用 await 函数

本文旨在解决在 asyncio 环境中正确调用 await 函数的问题，特别是在处理异步 I/O 操作时。我们将通过一个实际的例子，展示如何创建一个简单的 socket 服务器，并正确地处理读取和写入操作。本文将提供可运行的代码示例，并解释关键步骤，帮助读者理解 asyncio 的核心概念，从而避免常见的错误。

asyncio 是 Python 中用于编写并发代码的库，它基于事件循环，允许程序在等待 I/O 操作完成时执行其他任务，从而提高程序的效率。正确地使用 await 关键字是 asyncio 编程的关键，因为它能让程序在等待异步操作完成时暂停执行，并将控制权交还给事件循环。

创建一个简单的 asyncio 服务器

下面是一个使用 asyncio 创建 socket 服务器的例子：

import asyncio


class MyAsyncioHandler:
    def __call__(self, reader, writer):
        async def _inner():
            await self.handle_read(reader)
            data_to_send = b"Response data"
            await self.handle_write(writer, data_to_send)

        return _inner()

    async def handle_read(self, reader):
        data = await reader.read(8192)
        if data:
            print(f"Received data: {data.decode()}")

    async def handle_write(self, writer, data):
        print("Write", data)
        writer.write(data)
        await writer.drain()
        writer.close()
        await writer.wait_closed()


async def main():
    server = await asyncio.start_server(MyAsyncioHandler(), "127.0.0.1", 5000)
    addr = server.sockets[0].getsockname()
    print(f"Serving on {addr}")
    async with server:
        await server.serve_forever()


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

代码解释：

1. MyAsyncioHandler 类： 这个类负责处理客户端的连接。
   • __call__ 方法：这个方法使得类的实例可以像函数一样被调用。它创建了一个内部的异步函数 _inner，该函数依次调用 handle_read 和 handle_write 方法。
   • handle_read 方法：从 reader 对象读取数据，并打印出来。await reader.read(8192) 语句会暂停函数的执行，直到有数据可读。
   • handle_write 方法：向 writer 对象写入数据。await writer.drain() 语句会等待缓冲区的数据被发送完毕。writer.close() 关闭连接，await writer.wait_closed() 等待连接完全关闭。
2. main 函数： 这个函数是程序的入口点。
   • asyncio.start_server 函数：创建一个服务器，监听指定的地址和端口。它接受一个回调函数（这里是 MyAsyncioHandler()），该函数会在有新的客户端连接时被调用。
   • async with server: 语句：确保服务器在退出时被正确关闭。
   • await server.serve_forever() 语句：让服务器一直运行，直到手动停止。
3. if __name__ == "__main__": 代码块： 这个代码块确保 main 函数只在脚本直接运行时被调用，而不是在被导入为模块时。

运行示例

将上面的代码保存为 server.py，然后在终端中运行它：

python server.py

服务器将会在 127.0.0.1:5000 上启动并监听连接。

测试服务器

你可以使用 curl 命令来向服务器发送数据：

echo "Hello World" | curl telnet://127.0.0.1:5000

你将会看到服务器打印出接收到的数据，并向客户端发送 "Response data"。

关键点总结

• await 关键字： await 关键字只能在 async 函数中使用。它会暂停函数的执行，直到 await 后面的异步操作完成。
• 事件循环： asyncio 程序的核心是事件循环。事件循环负责调度任务，并在异步操作完成时恢复任务的执行。
• async with 语句： async with 语句可以确保异步资源在退出时被正确释放，例如关闭连接。
• 正确关闭连接： 在完成写入操作后，应该调用 writer.close() 关闭连接，并使用 await writer.wait_closed() 等待连接完全关闭。

注意事项

• 避免阻塞事件循环： 在 asyncio 程序中，应该避免执行耗时的同步操作，因为这会阻塞事件循环，导致程序无法响应其他事件。如果需要执行耗时的操作，应该将其放在单独的线程或进程中执行。
• 错误处理： 在 asyncio 程序中，应该使用 try...except 语句来捕获和处理异常。特别是，应该捕获 asyncio.CancelledError 异常，该异常会在任务被取消时抛出。

通过本文的讲解和示例，你应该能够理解如何在 asyncio 中正确地调用 await 函数，并创建一个简单的 socket 服务器。希望这些知识能帮助你更好地使用 asyncio 编写高效的并发程序。