Sanic Middleware 中間件

Translate from sanic docs

Middleware

Middleware are functions which are executed before or after requests to the server. They can be used to modify the request to or response from user-defined handler functions.

中間件是在服務(wù)器請(qǐng)求運(yùn)行前或運(yùn)行后執(zhí)行的函數(shù),其被用來(lái)調(diào)整 請(qǐng)求or響應(yīng)(從用戶自定義函數(shù)中)

There are two types of middleware: request and response. Both are declared using the @app.middleware decorator, with the decorator’s parameter being a string representing its type: request or response. Response middleware receives both the request and the response as arguments.

有 request 和 response 兩種中間件贷帮,均通過(guò)@app.middleware裝飾器聲明,裝飾器的參數(shù)是字符串蜀铲,類型有 request,response 。response中間件同時(shí)接收 request 和 response 參數(shù)票唆。

The simplest middleware doesn’t modify the request or response at all:

最簡(jiǎn)單的中間件夺刑,未修改 request, response

@app.middleware('request')
async def print_on_request(request):
    print("I print when a request is received by the server")

@app.middleware('response')
async def print_on_response(request, response):
    print("I print when a response is returned by the server")

Modifying the request or response

Middleware can modify the request or response parameter it is given, as long as it does not return it. The following example shows a practical use-case for this.

中間件可以修改給定的 request 和 response 參數(shù),前提是中間件不返回這些參數(shù)唆铐。下面的程序提供了一個(gè)可行的例子:

app = Sanic(__name__)

@app.middleware('response')
async def custom_banner(request, response):
    response.headers["Server"] = "Fake-Server"

@app.middleware('response')
async def prevent_xss(request, response):
    response.headers["x-xss-protection"] = "1; mode=block"

app.run(host="0.0.0.0", port=8000)

The above code will apply the two middleware in order. First, the middleware custom_banner will change the HTTP response header Server to Fake-Server, and the second middleware prevent_xss will add the HTTP header for preventing Cross-Site-Scripting (XSS) attacks. These two functions are invoked after a user function returns a response.

上面的代碼依次運(yùn)行了兩個(gè)中間件。第一個(gè)中間件 custom_banner 修改 HTTP Response hand server 為 Fake-server奔滑。第二個(gè)中間件 prevent_xss 將添加 HTTP header 以抵擋 XSS 攻擊艾岂。 這兩個(gè)函數(shù)在用戶函數(shù)返回響應(yīng)后被激活。

Responding early

If middleware returns a HTTPResponse object, the request will stop processing and the response will be returned. If this occurs to a request before the relevant user route handler is reached, the handler will never be called. Returning a response will also prevent any further middleware from running.

如果中間件返回 HTTPResponse 對(duì)象朋其, request會(huì)停止運(yùn)行并且 response 會(huì)被返回王浴。如果上述情況出現(xiàn)早與相應(yīng)的路由處理程序被觸發(fā), 那么這個(gè)處理器永遠(yuǎn)也不會(huì)被運(yùn)行梅猿。返回 response可以保護(hù)其他運(yùn)行中的中間件氓辣。

@app.middleware('request')
async def halt_request(request):
    return text('I halted the request')

@app.middleware('response')
async def halt_response(request, response):
    return text('I halted the response')
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市袱蚓,隨后出現(xiàn)的幾起案子钞啸,更是在濱河造成了極大的恐慌,老刑警劉巖喇潘,帶你破解...
    沈念sama閱讀 206,311評(píng)論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件体斩,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡颖低,警方通過(guò)查閱死者的電腦和手機(jī)絮吵,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,339評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)忱屑,“玉大人蹬敲,你說(shuō)我怎么就攤上這事暇昂。” “怎么了伴嗡?”我有些...
    開(kāi)封第一講書人閱讀 152,671評(píng)論 0 342
  • 文/不壞的土叔 我叫張陵急波,是天一觀的道長(zhǎng)。 經(jīng)常有香客問(wèn)我闹究,道長(zhǎng),這世上最難降的妖魔是什么食店? 我笑而不...
    開(kāi)封第一講書人閱讀 55,252評(píng)論 1 279
  • 正文 為了忘掉前任渣淤,我火速辦了婚禮,結(jié)果婚禮上吉嫩,老公的妹妹穿的比我還像新娘价认。我一直安慰自己,他們只是感情好自娩,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,253評(píng)論 5 371
  • 文/花漫 我一把揭開(kāi)白布用踩。 她就那樣靜靜地躺著,像睡著了一般忙迁。 火紅的嫁衣襯著肌膚如雪脐彩。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 49,031評(píng)論 1 285
  • 那天姊扔,我揣著相機(jī)與錄音惠奸,去河邊找鬼。 笑死恰梢,一個(gè)胖子當(dāng)著我的面吹牛佛南,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播嵌言,決...
    沈念sama閱讀 38,340評(píng)論 3 399
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼嗅回,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了摧茴?” 一聲冷哼從身側(cè)響起绵载,我...
    開(kāi)封第一講書人閱讀 36,973評(píng)論 0 259
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎苛白,沒(méi)想到半個(gè)月后尘分,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 43,466評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡丸氛,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 35,937評(píng)論 2 323
  • 正文 我和宋清朗相戀三年培愁,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片缓窜。...
    茶點(diǎn)故事閱讀 38,039評(píng)論 1 333
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡定续,死狀恐怖谍咆,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情私股,我是刑警寧澤摹察,帶...
    沈念sama閱讀 33,701評(píng)論 4 323
  • 正文 年R本政府宣布,位于F島的核電站倡鲸,受9級(jí)特大地震影響供嚎,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜峭状,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,254評(píng)論 3 307
  • 文/蒙蒙 一克滴、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧优床,春花似錦劝赔、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 30,259評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至移层,卻和暖如春仍翰,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背观话。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 31,485評(píng)論 1 262
  • 我被黑心中介騙來(lái)泰國(guó)打工歉备, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人匪燕。 一個(gè)月前我還...
    沈念sama閱讀 45,497評(píng)論 2 354
  • 正文 我出身青樓蕾羊,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親帽驯。 傳聞我的和親對(duì)象是個(gè)殘疾皇子龟再,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,786評(píng)論 2 345

推薦閱讀更多精彩內(nèi)容