23.FastAPI后台任务

23.FastAPI后台任务

在应用开发中，偶尔会有这样的需求：当一个请求结束后，程序需要执行一些较慢的数据处理，比如：发送邮件、大的数据量的统计汇总等操作。在FastAPI中，提供了后台任务来处理响应后的任务。FastAPI后台任务的创建包括任务函数的创建，声明后台任务及添加后台任务。

23.1创建任务函数

任务函数是一个可以接收参数的标准函数， 可以是一个async def或正常的def函数。如：

async def write_log(msg:str):
    with open(file='access_log.log', mode='a') as log_file:
        log_file.write('{0}-{1}\r\n'.format(datetime.now().strftime('%Y-%m-%d, %H:%M:%S'), msg))

以上任务函数的作用是将消息写入日志文件。

23.2声明后台任务

声明后台任务的方法是在需要调用后台任务的路由函数中声明BackgroundTasks类型的对象，BackgroundTasks从fastapi中导入。如：

@app.get(path='/')
async def root(backgroundtasks: BackgroundTasks):

23.3添加后台任务

在路由操作函数中，调用 后台任务对象的add_task()方法添加后台任务函数并传递参数。如：

backgroundtasks.add_task(write_log, msg=str(uuid.uuid1()))

完整的代码如下：

# coding: utf-8
from fastapi import FastAPI
from fastapi import BackgroundTasks
from datetime import datetime
import uuid
​
app = FastAPI()
​
​
async def write_log(msg:str):
    with open(file='access_log.log', mode='a') as log_file:
        log_file.write('{0}-{1}\r\n'.format(datetime.now().strftime('%Y-%m-%d, %H:%M:%S'), msg))
​
@app.get(path='/')
async def root(backgroundtasks: BackgroundTasks):
    backgroundtasks.add_task(write_log, msg=str(uuid.uuid1()))
    return "Hello world"

执行请求：

curl http://127.0.0.1:8000
"Hello world"

多次执行后查看日志文件access_log.log，其内容如下：

2022-02-07, 15:43:30-a4d2d29a-87e9-11ec-b60a-70c94ec87656
​
2022-02-07, 15:43:31-a54c0c6c-87e9-11ec-bdd9-70c94ec87656
​
2022-02-07, 15:43:31-a5bb71d2-87e9-11ec-ba73-70c94ec87656