如何在返回响应后记录 POST 方法的返回值？

Question

我正在开发我的第一个 REST API，所以如果我错过了一些基本的东西，请提前道歉。我有一个函数，它从另一台服务器获取 JSON 请求，对其进行处理（根据数据进行预测），然后返回另一个带有结果的 JSON。我想在服务器的本地磁盘上保留对此端点的所有请求及其结果的日志，以用于评估目的和重新训练模型。但是，为了尽量减少返回结果给用户的延迟，我想先返回响应数据，然后再将其写入本地磁盘。对于我来说，如何正确地执行此操作并不明显，因为 FastAPI 范例要求 POST 方法的结果是修饰函数的返回值，因此我想要对数据执行的任何操作都必须在before 之前完成回来了。

下面是一个最小的工作示例，我认为这是迄今为止我最接近的尝试，使用带有

log

装饰器的自定义对象 - 我的想法只是将结果分配给日志对象作为类属性，然后使用另一种方法将其写入磁盘，但我不知道如何确保每次都调用该函数 after

get_data

。

import json
import uvicorn
from fastapi import FastAPI, Request
from functools import wraps
from pydantic import BaseModel

class Blob(BaseModel):
    id: int
    x: float

def crunch_numbers(data: Blob) -> dict:
    # does some stuff
    return {'foo': 'bar'}

class PostResponseLogger:

    def __init__(self) -> None:
        self.post_result = None

    def log(self, func, *args, **kwargs):
        @wraps(func)
        def func_to_log(*args, **kwargs):
            post_result = func(*args, **kwargs)
            self.post_result = post_result

            # how can this be done outside of this function ???
            self.write_data()

            return post_result
        return func_to_log

    def write_data(self):
        if self.post_result:
            with open('output.json', 'w') as f:
                    json.dump(self.post_result, f)

def main():
    app = FastAPI()
    logger = PostResponseLogger()

    @app.post('/get_data/')
    @logger.log
    def get_data(input_json: dict, request: Request):
        result = crunch_numbers(input_json)
        return result

    uvicorn.run(app=app)

if __name__ == '__main__':
    main()

基本上，我的问题归结为：“在

PostResponseLogger

类中，有没有一种方法可以在每次调用

self.write_data

后自动调用

self.log

？”，但是如果我完全使用错误的方法，任何也欢迎其他建议。

Answer 1

您可以为此目的使用

Background Task

。后台任务“仅在发送响应后运行”（请参阅Starlette 文档）。 “这对于需要在请求后发生的操作很有用，但客户端在收到响应之前实际上不必等待操作完成”（请参阅FastAPI 文档）。

您可以定义一个任务函数在后台运行，用于写入日志数据，如下所示：

def write_log_data():
    logger.write_data()

然后，导入

BackgroundTasks

并使用类型声明

BackgroundTasks

在端点中定义一个参数。在端点内部，使用方法

write_log_data

将任务函数（即

background_tasks

，如上所定义）传递到

.add_task()

对象，如下所示。有关如何使用

BackgroundTasks

的更多详细信息可以在这个答案中找到。

from fastapi import BackgroundTasks

@app.post('/get_data/')
def get_data(input_json: dict, request: Request, background_tasks: BackgroundTasks):
    result = crunch_numbers(input_json)
    background_tasks.add_task(write_log_data)
    return result

如果使用中间件来捕获和记录响应数据（如此答案中所述）或自定义

APIRoute

类（如此答案中所示），则可以应用相同的原理。

为了将来的参考，如果您（或任何人）需要使用

async/await

语法，并在执行一些繁重的后台计算时遇到并发问题（例如

event loop

被阻塞），请查看 这个答案，它解释了使用

async def

和

def

定义端点或后台任务函数之间的区别（简单地说，

async def

端点和后台任务函数都将在 event loop 中直接

运行，而正常情况下

def

函数将在与外部线程池不同的单独线程中运行，然后进行

await

ed），并在此类函数中运行阻塞 I/O 密集型或 CPU 密集型操作时提供解决方案。