asyncio 长运行任务的优雅终止策略：告别 cancel() 的局限性

理解 Task.cancel() 的局局限性

在 asyncio 编程中，task.cancel() 方法是用于请求取消一个正在运行的任务。然而，正如官方文档所指出的，“task.cancel() 不保证任务会被取消”。这背后的原因在于，cancel() 机制本质上是协作式的。当一个任务被取消时，asyncio 会在任务下一次“让出控制权”给事件循环（即遇到 await 表达式）时，向该任务抛出一个 asyncio.cancellederror 异常。任务的编写者需要捕获并处理这个异常，以实现清理和退出逻辑。

考虑以下示例代码，它展示了一个长时间运行的后台任务，并试图通过 cancel() 方法来停止它：

import asyncio

async def background_task_problem():
    while True:
        print('doing something')
        await asyncio.sleep(1) # 任务在这里让出控制权

async def main_problem():
    task = asyncio.create_task(background_task_problem())
    # 模拟任务运行一段时间
    await asyncio.sleep(5)
    print("尝试取消任务...")
    task.cancel() # 请求取消
    try:
        await task # 等待任务完成（或抛出CancelledError）
    except asyncio.CancelledError:
        print("任务已被取消。")
    print('Done!')

# asyncio.run(main_problem())

运行上述代码，你会发现 background_task_problem 会持续打印 "doing something"，即使在 task.cancel() 被调用之后。这是因为 await task 发生在 task.cancel() 之后，主程序在等待任务结束，但任务内部并没有显式地处理 CancelledError。尽管 await asyncio.sleep(1) 是一个让出控制权的点，但如果 CancelledError 没有被任务内部捕获并导致退出，或者任务在 await 之前执行了大量操作，取消请求可能不会立即生效，甚至可能被忽略。在这种情况下，任务将无限期地运行下去，导致资源无法释放。

使用 asyncio.Event 实现协作式终止

为了实现更可靠、更优雅的长时间运行任务终止，我们可以采用 asyncio.Event 对象作为任务间的停止信号。这种方法的核心思想是：主任务创建一个 asyncio.Event 对象，并将其传递给后台任务。后台任务在其主循环中周期性地检查这个事件的状态。当主任务需要停止后台任务时，它只需设置这个事件，后台任务检测到事件被设置后，便会自行退出循环，完成清理工作。

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

import asyncio

async def background_task_solution(stop_event: asyncio.Event):
    """
    一个长时间运行的后台任务，通过检查stop_event来决定是否停止。
    """
    print("后台任务启动。")
    try:
        while not stop_event.is_set(): # 检查停止事件是否被设置
            print('doing something')
            await asyncio.sleep(1) # 在这里让出控制权，同时允许事件循环处理其他任务
    except asyncio.CancelledError:
        # 理论上，如果外部强行cancel，这里可以捕获，但我们主要依赖stop_event
        print("后台任务被外部取消（非预期）。")
    finally:
        print("后台任务正在清理资源并退出。")

async def main_solution():
    """
    主程序，负责启动后台任务并在指定时间后请求其停止。
    """
    stop_event = asyncio.Event() # 创建一个事件对象
    task = asyncio.create_task(background_task_solution(stop_event)) # 将事件传递给任务

    print("主程序：后台任务已启动，等待5秒...")
    await asyncio.sleep(5) # 模拟主程序执行其他操作或等待一段时间

    print("主程序：设置停止事件，请求后台任务停止。")
    stop_event.set() # 设置事件，通知后台任务停止

    print("主程序：等待后台任务完成。")
    await task # 等待后台任务自然结束

    print('主程序：所有任务完成！')

asyncio.run(main_solution())

代码解析：

SpeakingPass-打造你的专属雅思口语语料

使用chatGPT帮你快速备考雅思口语，提升分数

25

查看详情

1. stop_event = asyncio.Event(): 在 main_solution 函数中，我们首先创建了一个 asyncio.Event 实例。Event 对象有一个内部标志，初始为 False。
2. async def background_task_solution(stop_event: asyncio.Event):: 后台任务现在接受一个 stop_event 参数。
3. while not stop_event.is_set():: 这是关键所在。后台任务的循环条件不再是简单的 while True，而是检查 stop_event 是否被设置。is_set() 方法返回事件的当前状态。只要事件未被设置（即 False），循环就会继续。
4. await asyncio.sleep(1): 任务在这里让出控制权，允许事件循环处理其他任务，包括检查 stop_event 的状态。
5. stop_event.set(): 在 main_solution 中，当需要停止后台任务时，我们调用 stop_event.set()。这将把 Event 对象的内部标志设置为 True。
6. await task: 在设置 stop_event 后，main_solution 仍然 await task。这是为了确保后台任务有机会执行完其循环的当前迭代，检测到 stop_event，执行 finally 块中的清理工作，并最终优雅地退出。await task 会等待任务真正完成，而不是仅仅请求取消。

运行输出示例：

后台任务启动。
主程序：后台任务已启动，等待5秒...
doing something
doing something
doing something
doing something
doing something
主程序：设置停止事件，请求后台任务停止。
后台任务正在清理资源并退出。
主程序：等待后台任务完成。
主程序：所有任务完成！

从输出可以看出，在主程序设置 stop_event 后，后台任务在下一次循环迭代中检测到事件，打印清理信息后，便正常退出了。

最佳实践与注意事项

• 协作式原则： 使用 asyncio.Event 强调了 asyncio 的协作式多任务特性。任务必须主动检查停止信号。
• 优雅退出： 这种方法允许任务在退出前执行必要的清理工作（例如关闭文件句柄、释放锁等），这比 cancel() 强制抛出异常更可控。
• 确保 await task： 在设置停止事件后，务必 await 该任务。这不仅等待任务完成，也防止主程序在后台任务尚未完全退出时过早结束，导致资源泄露或状态不一致。
• 考虑超时： 对于某些可能因内部逻辑错误而无法响应停止事件的后台任务，可以在 await task 时结合 asyncio.wait_for 或 asyncio.timeout 来设置一个超时机制，防止主程序无限期等待。

  try:
      await asyncio.wait_for(task, timeout=10) # 最多等待10秒
  except asyncio.TimeoutError:
      print("后台任务超时未停止，可能存在问题。")
      # 此时可以考虑强制取消 task.cancel()

  登录后复制
• 适用于复杂场景： asyncio.Event 同样适用于更复杂的生产者-消费者模型，或需要协调多个任务启动/停止的场景。

总结

尽管 asyncio.Task.cancel() 是一个重要的取消机制，但对于长时间运行、内部循环紧密且不频繁让出控制权的任务，它可能无法提供立即或可靠的终止。通过引入 asyncio.Event 作为协作式的停止信号，我们能够实现一种更可控、更优雅的任务终止策略。这种方法允许后台任务在接收到停止信号后，有序地完成其当前工作并执行必要的清理，最终安全退出，从而提高了应用程序的健壮性和可维护性。在设计 asyncio 应用程序时，对于需要可控停止的后台任务，优先考虑使用 asyncio.Event 是一个推荐的实践。

以上就是asyncio 长运行任务的优雅终止策略：告别 cancel() 的局限性的详细内容，更多请关注php中文网其它相关文章！