FasrAPI 中间件

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

是的,这是一个经典的例子,我甚至相信你们在其他的文章里面看过,这也是官网上对中间件的一个展示。

那么,根据这个栗子,我们就可以总结出中间件的步骤:

  1. 使用函数装饰器注册:
    @app.middleware("http") :

  2. 函数的参数:

    1. request:Request,其中Request可以直接从fastapi中导入,不过,要知道它其实直接取自starlette

    2. call_next:这是一个函数,它不一定是你注册的那个响应函数,传入request,返回response,你可以在中间件中对response进行一些处理后再继续返回

  3. 返回response

2.使用已有的的中间件:

使用方式:app.add_middleware
参数:
1. 第一个参数为要添加的中间件
2. 第二个参数为对中间件的配置

  1. 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"}
  1. 添加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

强制所有传入请求必须为httpswss

取而代之的是任何传入的请求httpws将重定向到安全方案的请求。

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
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342