FastApi从入门到精通：中间件篇

FastAPI 中间件：提升 API 开发的灵活性

简介

FastAPI 中间件是一个强大且多功能的工具，它允许开发者在请求处理之前和之后拦截和修改请求和响应。这种灵活性为 API 的开发开辟了广阔的可能性，从数据验证到性能优化，不一而足。

中间件的用途

中间件在各种场景中都有用武之地，例如：

• 数据验证： 检查传入请求中的数据是否符合预期的格式和约束。
• 日志记录： 捕获请求和响应信息，以便进行调试和分析。
• 跨域请求（CORS）： 处理跨域请求，允许从不同域访问 API。
• 自定义头信息： 向每个响应中添加自定义头信息，例如用于身份验证或缓存。
• 请求缓存： 缓存请求结果，以加快后续请求的响应速度。

创建中间件

编写 FastAPI 中间件非常简单。您需要创建一个函数，并使用 @app.middleware("http") 装饰器进行修饰。例如，以下中间件将记录每个请求和响应：

from fastapi import Request, HTTPException, status

@app.middleware("http")
async def log_request_response(request: Request, call_next):
    logger.info(f"Received request: {request.url}")
    try:
        response = await call_next(request)
        logger.info(f"Sent response: {response.status_code}")
        return response
    except HTTPException as e:
        logger.error(f"Error occurred: {e.detail}")
        return Response(content=str(e.detail), status_code=e.status_code)

此中间件将在每个请求之前和之后运行，记录请求的 URL 和响应的状态代码。

内置中间件

FastAPI 提供了一些内置中间件，以满足常见的需求：

• CORSMiddleware：处理跨域请求。
• HTTPHeaderMiddleware：添加自定义头信息。
• CacheControlMiddleware：缓存请求结果。
• GZipMiddleware：对响应进行 GZip 压缩。
• JSONMiddleware：解析 JSON 请求并生成 JSON 响应。

结论

FastAPI 中间件为 API 开发人员提供了前所未有的控制力和灵活性。通过编写自定义中间件，开发者可以扩展 API 的功能，并创建满足其特定需求的强大且高效的解决方案。

常见问题解答

1. 什么是 FastAPI 中间件？
   中间件是一个函数，它在每个请求和响应之前和之后都会被调用。

2. 中间件有什么用途？
   中间件用于数据验证、日志记录、跨域请求处理、自定义头信息添加等任务。

3. 如何创建中间件？
   创建中间件需要一个装饰器 @app.middleware("http") 和一个函数。

4. FastAPI 提供了哪些内置中间件？
   FastAPI 提供了 CORSMiddleware、HTTPHeaderMiddleware、CacheControlMiddleware 等中间件。

5. 中间件是如何调用的？
   中间件在每个请求被特定路径操作处理之前和每个响应被返回之前都会被调用。