1 封装中间件
有些时候,我们需要对许多URL采取共同的处理,比如判断是否拥有权限访问某页面。这时,我们就可以通过中间件来实现,首先,我们可以声明一个中间件:
import time
from fastapi import FastAPI, Request
app = FastAPI()
@app.middleware("http")
async def add_process_time_header(request: Request, call_next):
start_time = time.time()
response = await call_next(request)
process_time = time.time() - start_time
response.headers["X-Process-Time"] = str(process_time)
return response
是的,这是一个经典的例子,我甚至相信你们在其他的文章里面看过,这也是官网上对中间件的一个展示。
那么,根据这个栗子,我们就可以总结出中间件的步骤:
使用函数装饰器注册:
@app.middleware("http") :-
函数的参数:
request:Request,其中Request可以直接从fastapi中导入,不过,要知道它其实直接取自starlette
call_next:这是一个函数,它不一定是你注册的那个响应函数,传入request,返回response,你可以在中间件中对response进行一些处理后再继续返回
返回response
2.使用已有的的中间件:
使用方式:app.add_middleware
参数:
1. 第一个参数为要添加的中间件
2. 第二个参数为对中间件的配置
- CORS
例子:
from fastapi import FastAPI
from fastapi.middleware.cors import CORSMiddleware
app = FastAPI()
origins = [
"http://localhost.tiangolo.com",
"https://localhost.tiangolo.com",
"http://localhost",
"http://localhost:8080",
]
app.add_middleware(
CORSMiddleware,
allow_origins=origins,
allow_credentials=True,
allow_methods=["*"],
allow_headers=["*"],
)
@app.get("/")
async def main():
return {"message": "Hello World"}
- 添加ASGI中间件
由于FastAPI基于Starlette并实现了<abbr title="异步服务器网关接口" style="box-sizing: inherit; text-decoration: none; border-bottom: 0.05rem dotted var(--md-default-fg-color--light); cursor: help;">ASGI</abbr>规范,因此您可以使用任何ASGI中间件。
只要遵循ASGI规范,就不必为FastAPI或Starlette制作中间件。
通常,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()
接收中间件类作为第一个参数,以及任何其他要传递给中间件的参数。
HTTPSRedirectMiddleware
强制所有传入请求必须为https
或wss
。
取而代之的是任何传入的请求http
或ws
将重定向到安全方案的请求。
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
app = FastAPI()
app.add_middleware(HTTPSRedirectMiddleware)
@app.get("/")
async def main():
return {"message": "Hello World"}
TrustedHostMiddleware
强制所有传入请求都具有正确设置的Host
标头,以防止受到HTTP Host Header攻击。
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
手柄GZIP用于包括任何请求响应"gzip"
中的Accept-Encoding
报头。
中间件将处理标准响应和流响应。
from fastapi.middleware.gzip import GZipMiddleware
app = FastAPI()
app.add_middleware(GZipMiddleware, minimum_size=1000)
@app.get("/")
async def main():
return "somebigcontent"
支持以下参数:
-
minimum_size
-不要GZip响应小于此最小大小(以字节为单位)。默认为500
。