高级中间件¶
在主教程中,你学习了如何为你的应用程序添加自定义中间件。
然后你还学习了如何使用CORSMiddleware
处理 CORS。
在本节中,我们将看到如何使用其他中间件。
添加 ASGI 中间件¶
由于 FastAPI 基于 Starlette 并实现了 ASGI 规范,你可以使用任何 ASGI 中间件。
中间件不必专为 FastAPI 或 Starlette 开发即可使用,只要它遵循 ASGI 规范即可。
通常,ASGI 中间件是期望将 ASGI 应用程序作为第一个参数接收的类。
因此,在第三方 ASGI 中间件的文档中,他们可能会告诉你这样做:
from unicorn import UnicornMiddleware
app = SomeASGIApp()
new_app = UnicornMiddleware(app, some_config="rainbow")
但 FastAPI(实际上是 Starlette)提供了一种更简单的方法来做到这一点,确保内部中间件能够正确处理服务器错误和自定义异常处理程序。
为此,你可以使用 app.add_middleware()
(就像 CORS 的例子一样)。
from fastapi import FastAPI
from unicorn import UnicornMiddleware
app = FastAPI()
app.add_middleware(UnicornMiddleware, some_config="rainbow")
app.add_middleware()
接收一个中间件类作为第一个参数,以及要传递给中间件的任何附加参数。
集成中间件¶
FastAPI 包含多个用于常见用例的中间件,接下来我们将看到如何使用它们。
技术细节
对于接下来的示例,你也可以使用 from starlette.middleware.something import SomethingMiddleware
。
FastAPI 在 fastapi.middleware
中提供了几个中间件,只是为了方便开发者使用。但大多数可用的中间件直接来源于 Starlette。
HTTPSRedirectMiddleware
¶
强制所有传入请求必须是 https
或 wss
。
任何传入的 http
或 ws
请求都将被重定向到安全方案。
from fastapi import FastAPI
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
app = FastAPI()
app.add_middleware(HTTPSRedirectMiddleware)
@app.get("/")
async def main():
return {"message": "Hello World"}
TrustedHostMiddleware
¶
强制所有传入请求都具有正确设置的 Host
头,以防范 HTTP 主机头攻击。
from fastapi import FastAPI
from fastapi.middleware.trustedhost import TrustedHostMiddleware
app = FastAPI()
app.add_middleware(
TrustedHostMiddleware, allowed_hosts=["example.com", "*.example.com"]
)
@app.get("/")
async def main():
return {"message": "Hello World"}
支持以下参数:
allowed_hosts
- 允许作为主机名使用的域名列表。支持*.example.com
等通配符域名用于匹配子域名。要允许任何主机名,可以使用allowed_hosts=["*"]
或省略此中间件。
如果传入请求未正确验证,则会发送 400
响应。
GZipMiddleware
¶
处理包含 Accept-Encoding
头中 "gzip"
的任何请求的 GZip 响应。
此中间件将处理标准响应和流式响应。
from fastapi import FastAPI
from fastapi.middleware.gzip import GZipMiddleware
app = FastAPI()
app.add_middleware(GZipMiddleware, minimum_size=1000, compresslevel=5)
@app.get("/")
async def main():
return "somebigcontent"
支持以下参数:
minimum_size
- 不对小于此最小字节大小的响应进行 GZip 压缩。默认为500
。compresslevel
- 在 GZip 压缩期间使用。它是一个从 1 到 9 的整数。默认为9
。较低的值会导致更快的压缩但更大的文件大小,而较高的值会导致更慢的压缩但更小的文件大小。
其他中间件¶
还有许多其他 ASGI 中间件。
例如:
要查看其他可用的中间件,请查阅 Starlette 的中间件文档 和 ASGI 精彩列表。