Sanic框架中的后台任务管理指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00058/article/details/148374967

Sanic框架中的后台任务管理指南

sanic Accelerate your web app development | Build fast. Run fast. 项目地址: https://gitcode.com/gh_mirrors/sa/sanic

背景任务概述

在现代Web开发中，后台任务处理是一个非常重要的功能。Sanic作为一款高性能的异步Python Web框架，提供了强大而灵活的后台任务管理机制。本文将详细介绍如何在Sanic应用中创建和管理后台任务。

创建后台任务

在Sanic中创建后台任务非常简单，使用app.add_task()方法即可。这与Python标准库中的asyncio.create_task类似，但提供了更多便利功能。

基本任务创建

async def notify_server_started_after_five_seconds():
    await asyncio.sleep(5)
    print('服务器已成功启动!')

app.add_task(notify_server_started_after_five_seconds())

自动注入应用实例

Sanic提供了一个便利功能，可以自动将应用实例注入到任务函数中：

async def auto_inject(app):
    await asyncio.sleep(5)
    print(f"应用名称: {app.name}")

app.add_task(auto_inject)  # 注意这里传递的是函数本身，不是调用结果

显式传递应用实例

如果你更喜欢显式传递应用实例，也可以这样做：

async def explicit_inject(app):
    await asyncio.sleep(5)
    print(f"应用名称: {app.name}")

app.add_task(explicit_inject(app))  # 这里传递的是调用结果

应用启动前的任务添加

有时我们需要在应用运行前（即调用app.run()之前）添加后台任务。这种情况下，建议传递可调用对象而不是协程对象，Sanic会在每个工作进程中创建协程对象。

async def background_work():
    # 执行一些后台操作
    pass

app = Sanic("MyApp")
app.add_task(background_work)  # 传递函数本身
app.run(host="0.0.0.0", port=8000)

需要注意的是，这种方式添加的任务会在每个工作进程中运行。如果需要在主进程中执行一次性初始化工作，应该使用@app.main_process_start装饰器。

命名任务管理

Sanic提供了对任务的命名和管理功能，这在复杂应用中非常有用。

创建命名任务

app.add_task(background_work, name="background_job")

获取任务实例

task = app.get_task("background_job")

取消任务

await app.cancel_task("background_job")

清理已完成任务

为了避免内存泄漏，可以定期清理已完成或已取消的任务：

app.purge_tasks()

WebSocket应用示例

命名任务在WebSocket应用中特别有用，可以方便地管理每个连接的后台任务：

async def websocket_receiver(ws):
    while True:
        message = await ws.recv()
        if not message:
            break
        print(f"收到消息: {message}")

@app.websocket("/chat")
async def chat_handler(request, ws):
    task_name = f"receiver:{request.id}"
    request.app.add_task(websocket_receiver(ws), name=task_name)
    try:
        while True:
            await ws.send("保持连接...")
            await asyncio.sleep(10)
    finally:
        # 当WebSocket关闭时清理任务
        await request.app.cancel_task(task_name)
        request.app.purge_tasks()