FastAPI 使用loguru记录Fastapi应用程序上的请求参数

在本文中，我们将介绍如何使用FastAPI和loguru记录Fastapi应用程序上的请求参数。

阅读更多：FastAPI 教程

1. 引言

FastAPI是一个用于构建Web API的现代、高性能、快速（高）框架，它是使用Python类型注释进行请求验证和文档生成的。

loguru是一个快速、简单、功能强大的Python日志库，它提供了直观和优雅的日志记录体验。

在FastAPI应用程序中，我们通常需要记录请求的参数，以便后续分析和调试。通过使用loguru，我们可以轻松地记录请求的参数。

2. 在FastAPI应用程序中使用loguru记录请求参数

要在FastAPI应用程序中使用loguru记录请求参数，我们需要执行以下步骤：

2.1 安装FastAPI和loguru

首先，我们需要安装FastAPI和loguru。可以使用pip命令来安装它们：

pip install fastapi loguru

2.2 导入所需的库

在开始使用FastAPI和loguru之前，我们需要导入所需的库。我们需要导入FastAPI和loguru的logging模块，并创建一个logger实例：

from fastapi import FastAPI
from loguru import logger

app = FastAPI()

2.3 添加请求日志中间件

接下来，我们需要添加一个请求日志中间件，以便记录请求的参数。我们可以使用FastAPI的middleware模块来添加中间件：

from fastapi.middleware import Middleware

middleware = [
    Middleware(CustomLogMiddleware),
]

app = FastAPI(middleware=middleware)

2.4 创建CustomLogMiddleware

然后，我们需要创建一个CustomLogMiddleware类，用于记录请求的参数。我们可以使用FastAPI的Request和Response类来获取请求和响应的信息：

from fastapi import Request, Response

class CustomLogMiddleware:
    async def __call__(self, request: Request, call_next):
        logger.info(f"Request: {request.method} {request.url}")
        logger.debug(f"Request Headers: {request.headers}")
        logger.debug(f"Request Body: {await request.body()}")

        response = await call_next(request)

        logger.info(f"Response Status Code: {response.status_code}")
        logger.debug(f"Response Headers: {response.headers}")
        logger.debug(f"Response Body: {await response.body()}")

        return response

2.5 启动FastAPI应用程序

最后，我们可以启动FastAPI应用程序，并测试请求参数记录功能。我们可以使用FastAPI的装饰器来定义API路由和请求处理函数：

@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

现在，当我们发送GET请求到/items/{item_id}时，请求的参数将被记录到日志文件中：

http://localhost:8000/items/42?q=test_param

输出日志示例：

2022-01-01 00:00:00 | INFO     | app:read_item:7 - Request: GET /items/42?q=test_param
2022-01-01 00:00:00 | DEBUG    | app:read_item:8 - Request Headers: {'host': 'localhost:8000', 'user-agent': 'curl/7.68.0', 'accept': '*/*'}
2022-01-01 00:00:00 | DEBUG    | app:read_item:9 - Request Body: b''
2022-01-01 00:00:00 | INFO     | app:read_item:12 - Response Status Code: 200
2022-01-01 00:00:00 | DEBUG    | app:read_item:13 - Response Headers: {'date': 'Sat, 01 Jan 2022 00:00:00 GMT', 'server': 'uvicorn', 'content-length': '23', 'content-type': 'application/json'}
2022-01-01 00:00:00 | DEBUG    | app:read_item:14 - Response Body: b'{"item_id": 42, "q": "test_param"}'