Python 的异步 IO：Asyncio 简介

糖豆贴心提醒，本文阅读时间7分钟

定义协程

协程的定义，需要使用 async def 语句。

do_some_work 便是一个协程。

准确来说，do_some_work 是一个协程函数，可以通过 asyncio.iscoroutinefunction 来验证：

这个协程什么都没做，我们让它睡眠几秒，以模拟实际的工作量 ：

在解释 await 之前，有必要说明一下协程可以做哪些事。协程可以：

asyncio.sleep 也是一个协程，所以 await asyncio.sleep(x) 就是等待另一个协程。可参见 asyncio.sleep 的文档：

运行协程

调用协程函数，协程并不会开始运行，只是返回一个协程对象，可以通过 asyncio.iscoroutine 来验证：

此处还会引发一条警告：

要让这个协程对象运行的话，有两种方式：

简单来说，只有 loop 运行了，协程才可能运行。

下面先拿到当前线程缺省的 loop ，然后把协程对象交给 loop.run_until_complete，协程对象随后会在 loop 里得到运行。

run_until_complete 是一个阻塞（blocking）调用，直到协程运行结束，它才返回。这一点从函数名不难看出。

run_until_complete 的参数是一个 future，但是我们这里传给它的却是协程对象，之所以能这样，是因为它在内部做了检查，通过 ensure_future 函数把协程对象包装（wrap）成了 future。所以，我们可以写得更明显一些：

完整代码：

运行结果：

回调

假如协程是一个 IO 的读操作，等它读完数据后，我们希望得到通知，以便下一步数据的处理。这一需求可以通过往 future 添加回调来实现。

多个协程

实际项目中，往往有多个协程，同时在一个 loop 里运行。为了把多个协程交给 loop，需要借助 asyncio.gather 函数。

或者先把协程存在列表里：

运行结果：

这两个协程是并发运行的，所以等待的时间不是 1 + 3 = 4 秒，而是以耗时较长的那个协程为准。

参考函数 gather 的文档：

发现也可以传 futures 给它：

gather 起聚合的作用，把多个 futures 包装成单个 future，因为 loop.run_until_complete 只接受单个 future。

run_until_complete 和 run_forever

我们一直通过 run_until_complete 来运行 loop ，等到 future 完成，run_until_complete 也就返回了。

输出：

现在改用 run_forever：

输出：

三秒钟过后，future 结束，但是程序并不会退出。run_forever 会一直运行，直到 stop 被调用，但是你不能像下面这样调 stop：

run_forever 不返回，stop 永远也不会被调用。所以，只能在协程中调 stop：

这样并非没有问题，假如有多个协程在 loop 里运行：

第二个协程没结束，loop 就停止了——被先结束的那个协程给停掉的。

要解决这个问题，可以用 gather 把多个协程合并成一个 future，并添加回调，然后在回调里再去停止 loop。

其实这基本上就是 run_until_complete 的实现了，run_until_complete 在内部也是调用 run_forever。

Close Loop?

以上示例都没有调用 loop.close，好像也没有什么问题。所以到底要不要调 loop.close 呢？

简单来说，loop 只要不关闭，就还可以再运行。：

但是如果关闭了，就不能再运行了：

建议调用 loop.close，以彻底清理 loop 对象防止误用。

gather vs. wait

asyncio.gather 和 asyncio.wait 功能相似。

具体差别可请参见 StackOverflow 的讨论：Asyncio.gather vs asyncio.wait。

Timer

C++ Boost.Asio 提供了 IO 对象 timer，但是 Python 并没有原生支持 timer，不过可以用 asyncio.sleep 模拟。