python fastapi middleware

引言

在编写Web应用程序时，中间件是一种非常有用的机制。它允许开发者在请求到达处理函数之前，对请求进行处理和定制。中间件可以用于一些通用的功能，例如身份验证、日志记录、错误处理等。在本文中，我们将介绍如何在Python FastAPI框架中使用中间件。

什么是中间件？

中间件是一种功能强大的编程模式，它允许我们将一些预处理逻辑通过可插拔的方式应用到请求和响应的处理过程中。在Web开发中，中间件是位于请求和响应处理之间的一层。当请求进入应用程序时，中间件会对请求进行处理，并可以在请求到达处理函数之前或之后插入自定义逻辑。

在Python FastAPI中，我们可以使用中间件对请求进行处理和定制，以满足我们的需求。FastAPI内置了一些中间件，同时允许我们编写自己的中间件。

FastAPI内置中间件

FastAPI内置了一些常用的中间件，我们可以直接使用它们，而无需编写额外的代码。以下是一些常用的内置中间件：

CORS中间件

跨域资源共享 (Cross-Origin Resource Sharing, CORS) 是一种机制，用于允许网页应用程序从不同域源访问相应的资源。CORS中间件可以用来处理跨域请求。在FastAPI中使用CORS中间件非常简单，我们只需要在应用实例中使用相应的参数即可。

from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware

app = FastAPI()

origins = [
    "http://localhost",
    "http://localhost:8080",
    "http://example.com",
    "http://example.com:8080",
]

app.add_middleware(
    CORSMiddleware,
    allow_origins=origins,
    allow_credentials=True,
    allow_methods=["*"],
    allow_headers=["*"],
)

上述代码演示了如何在FastAPI应用中使用CORS中间件。allow_origins参数指定了允许的跨域来源。allow_credentials参数指定是否允许携带身份验证信息。allow_methods参数指定允许的请求方法，allow_headers参数指定允许的请求头。

GZip中间件

GZip中间件可以用来对响应进行GZip压缩。使用GZip压缩可以减小响应数据的大小，提高网络传输效率。在FastAPI中使用GZip中间件非常简单，我们只需要在应用实例中使用相应的参数即可。

from fastapi import FastAPI
from fastapi.middleware.gzip import GZipMiddleware

app = FastAPI()

app.add_middleware(GZipMiddleware, minimum_size=1000)

上述代码演示了如何在FastAPI应用中使用GZip中间件。minimum_size参数指定了只有响应数据大小超过指定值时才进行GZip压缩。

TrustedHost中间件

TrustedHost中间件用于校验请求的主机名。它可以用来验证主机名是否符合预期，以防止请求被劫持和恶意使用。在FastAPI中使用TrustedHost中间件非常简单，我们只需要在应用实例中使用相应的参数即可。

from fastapi import FastAPI, Request
from fastapi.middleware.trustedhost import TrustedHostMiddleware

app = FastAPI()

app.add_middleware(
    TrustedHostMiddleware,
    allowed_hosts=["example.com", "*.example.com"],
)

上述代码演示了如何在FastAPI应用中使用TrustedHost中间件。allowed_hosts参数指定了允许的主机名，可以使用通配符”*”表示允许所有子域名。

自定义中间件

除了使用FastAPI内置的中间件外，我们还可以编写自定义的中间件来满足特定的需求。自定义中间件可以扩展FastAPI的功能，提供更强大的处理能力。

自定义中间件需要实现一个可调用对象，并且具有如下的方法签名：

def custom_middleware(request: Request, call_next: Callable) -> Any:
    pass

可调用对象接收一个请求对象和一个call_next函数作为参数，返回一个响应对象。call_next函数负责调用下一个中间件或处理函数。在中间件中可以对请求进行处理，并在调用call_next之前或之后添加自定义逻辑。

以下是一个示例，展示了如何编写一个简单的自定义中间件：

from fastapi import FastAPI, Request
from typing import Callable

app = FastAPI()

async def custom_middleware(request: Request, call_next: Callable):
    # 在请求到达处理函数之前的处理逻辑
    print("中间件：处理请求")

    response = await call_next(request)

    # 在请求处理完成后的处理逻辑
    print("中间件：处理响应")

    return response

app.middleware("http")(custom_middleware)

上述代码演示了如何编写一个简单的自定义中间件。我们使用middleware方法来注册中间件，并指定了适用的路由。在实际使用中，我们可以根据需求编写更复杂的中间件，并应用到特定的路由上。

中间件的执行顺序

在FastAPI中，中间件按照注册的顺序执行。先注册的中间件会比后注册的中间件先执行。当接收到请求时，中间件会按照注册顺序依次执行，然后调用处理函数处理请求，并在响应返回时按照相反的顺序执行。

如下所示是一个中间件执行顺序的示例：

from fastapi import FastAPI, Request

app = FastAPI()

@app.middleware("http")
async def middleware1(request: Request, call_next):
    print("中间件1：处理请求（前）")
    response = await call_next(request)
    print("中间件1：处理响应（后）")
    return response

@app.middleware("http")
async def middleware2(request: Request, call_next):
    print("中间件2：处理请求（前）")
    response = await call_next(request)
    print("中间件2：处理响应（后）")
    return response

@app.get("/")
async def root():
    return {"message": "Hello, World!"}

假设我们访问根路径/，则中间件的执行顺序如下：

中间件1：处理请求（前）
中间件2：处理请求（前）
处理函数：处理请求
中间件2：处理响应（后）
中间件1：处理响应（后）

结语

本文介绍了如何在Python FastAPI框架中使用中间件。我们可以使用内置的中间件如CORS、GZip和TrustedHost中间件来处理常见的需求，也可以编写自定义的中间件来扩展应用程序的功能。在FastAPI中，中间件按照注册的顺序执行，并可以在请求到达处理函数之前或之后插入自定义逻辑。

使用中间件可以实现一些常见的功能，例如：

• 身份验证：可以编写一个中间件，在请求到达处理函数之前检查用户的身份验证信息，并做相应的处理。
• 日志记录：可以编写一个中间件，对请求进行记录，包括请求方式、路径、IP地址等信息，便于后续的日志分析和故障排查。
• 错误处理：可以编写一个中间件，用于捕获应用程序中发生的异常，返回友好的错误响应给客户端。

中间件是一个非常有用的机制，它可以将一些通用的逻辑与具体的请求处理逻辑分离开来，使代码更加模块化和可维护。在使用中间件时，需要根据需求选择合适的中间件，并了解它们的执行顺序和参数配置。