优雅地终止异步任务：asyncio.Event的实践应用

Task.cancel()的局限性

在asyncio中，Task.cancel()方法用于请求取消一个任务。当一个任务被取消时，它会在下一个可await的点抛出asyncio.CancelledError异常。任务的编写者可以通过捕获这个异常来执行清理工作，然后退出。然而，如果一个任务长时间运行，且在循环中没有频繁地遇到await表达式，或者它捕获并“吞噬”了CancelledError，那么cancel()可能不会立即生效，甚至根本不生效。

考虑以下示例代码，它模拟了一个长时间运行的后台任务：

import asyncio

async def background_task_problematic():
    while True:
        print('doing something')
        await asyncio.sleep(1) # 这是一个await点

async def main_problematic():
    task = asyncio.create_task(background_task_problematic())
    # 模拟任务运行一段时间
    await asyncio.sleep(5)
    print('Attempting to cancel task...')
    task.cancel() # 尝试取消任务
    # 理论上这里应该等待任务完成，但实际上它不会停止
    try:
        await task
    except asyncio.CancelledError:
        print("Task was cancelled (this might not be reached if task doesn't stop)")
    print('Done!')

asyncio.run(main_problematic())

运行上述代码，你会发现background_task_problematic会无限期地打印"doing something"，即使task.cancel()被调用了。这是因为尽管await asyncio.sleep(1)提供了一个取消点，但任务内部的while True循环并没有显式地检查取消状态或处理CancelledError以退出循环。在某些情况下，即使抛出了CancelledError，如果任务逻辑没有响应它（例如，只是简单地继续循环），任务也不会停止。

解决方案：使用asyncio.Event进行协作式终止

为了实现更可靠、更可控的任务终止，我们可以采用协作式的方式，即让任务本身能够感知外部的停止请求，并主动退出。asyncio.Event是实现这一机制的理想选择。

asyncio.Event是一个简单的同步原语，它维护一个内部标志，可以被set()设置为真，或被clear()设置为假。任务可以使用wait()方法等待事件被设置，或者使用is_set()方法检查事件的当前状态。

以下是使用asyncio.Event改进后的代码示例：

import asyncio

async def background_task_graceful(stop_event: asyncio.Event):
    """
    一个长时间运行的后台任务，通过asyncio.Event进行优雅终止。
    """
    print('Background task started.')
    while not stop_event.is_set(): # 检查停止事件是否被设置
        print('doing something...')
        try:
            # 即使这里有await，也需要定期检查stop_event
            # 或者确保await的函数能被取消
            await asyncio.sleep(1)
        except asyncio.CancelledError:
            # 如果同时使用了cancel()，这里可以处理
            print("Background task received cancellation request, but event is primary stop mechanism.")
            break # 收到取消请求，也退出
    print('Background task stopping gracefully.')

async def main_graceful():
    """
    主协程，负责启动和停止后台任务。
    """
    stop_event = asyncio.Event() # 创建一个事件对象
    task = asyncio.create_task(background_task_graceful(stop_event))

    print('Main: Background task launched. Running for 5 seconds...')
    await asyncio.sleep(5) # 模拟主程序运行一段时间

    print('Main: Signalling background task to stop...')
    stop_event.set() # 设置事件，通知后台任务停止

    print('Main: Awaiting background task to complete...')
    await task # 等待后台任务真正完成其清理并退出

    print('Main: Done!')

if __name__ == '__main__':
    asyncio.run(main_graceful())

代码解析：

1. background_task_graceful(stop_event: asyncio.Event):

   

   AppMall应用商店

   AI应用商店，提供即时交付、按需付费的人工智能应用服务

   56

   查看详情
   • 该任务现在接收一个asyncio.Event对象作为参数。
   • while not stop_event.is_set(): 是核心。任务的循环条件变成了检查stop_event是否被设置。只要事件未被设置，任务就继续执行。
   • 当stop_event.set()被调用时，stop_event.is_set()将返回True，从而导致while循环终止，任务可以执行任何必要的清理工作（在此例中是打印消息）后退出。
   • 添加try...except asyncio.CancelledError是为了展示即使同时使用cancel()，也可以在这里进行处理。但在这个设计中，stop_event是主要的终止机制。

2. main_graceful():

   • stop_event = asyncio.Event(): 在主协程中创建事件对象。
   • task = asyncio.create_task(background_task_graceful(stop_event)): 将stop_event传递给后台任务。
   • await asyncio.sleep(5): 模拟后台任务运行了5秒。
   • stop_event.set(): 在这里，主协程通知后台任务停止。这会改变stop_event的状态。
   • await task: 这一步至关重要。它确保主协程会等待background_task_graceful完成其最后的循环迭代、执行清理并最终退出。如果没有await task，主协程可能会在后台任务完全停止之前就结束，导致后台任务被强制终止或出现未定义行为。

输出示例：

Background task started.
Main: Background task launched. Running for 5 seconds...
doing something...
doing something...
doing something...
doing something...
doing something...
Main: Signalling background task to stop...
Background task stopping gracefully.
Main: Awaiting background task to complete...
Main: Done!

从输出可以看出，后台任务在收到停止信号后，优雅地完成了最后一次循环，并打印了停止消息，然后才退出。

优点与注意事项

使用asyncio.Event的优点：

• 优雅终止： 任务可以执行必要的清理工作（如关闭文件、保存状态）后再退出，避免数据丢失或资源泄露。
• 协作式： 任务主动检查停止条件，而不是被动地等待外部中断。这使得任务的终止行为更加可预测。
• 清晰的控制流： 外部代码通过设置事件明确地请求任务停止，任务内部逻辑也明确地响应这个请求。
• 适用于复杂逻辑： 即使任务内部有复杂的计算或I/O操作，只要能定期检查is_set()，就能实现停止。

注意事项：

• 定期检查： 任务内部必须定期调用stop_event.is_set()来检查停止信号。如果任务在一个长时间的CPU密集型操作中，没有await点也没有检查事件，那么它仍然不会立即停止。
• await task的重要性： 在设置事件后，务必await任务，以确保它有足够的时间完成并退出。否则，主程序可能会在后台任务完成前就结束，导致资源未释放或状态不一致。
• 结合Task.cancel()： 在某些紧急情况下，你可能仍然需要Task.cancel()作为最后的手段，尤其是在任务未能响应Event信号时。一个健壮的系统可以结合两者：首先尝试通过Event优雅终止，在超时后如果任务仍未停止，则使用cancel()强制终止。
• 避免忙等待： 不要在一个紧密的循环中频繁检查is_set()而不await，这会消耗CPU。如果需要等待事件，请使用await stop_event.wait()，它会在事件被设置时唤醒任务。

总结

当asyncio.Task.cancel()不足以优雅地停止长时间运行的异步任务时，asyncio.Event提供了一种强大且可控的协作式终止机制。通过在任务内部定期检查事件状态，并由外部代码设置事件来发出停止信号，我们可以确保异步任务能够以受控且优雅的方式完成其生命周期，从而提高应用程序的健壮性和可靠性。理解并正确运用asyncio.Event是编写高质量asyncio应用的基石。

以上就是优雅地终止异步任务：asyncio.Event的实践应用的详细内容，更多请关注php中文网其它相关文章！