Sanic框架異常處理與中間件操作實例分析

更新時間：2018年07月16日 11:21:14 作者：噴跑的豆子

這篇文章主要介紹了Sanic框架異常處理與中間件操作,結合實例形式較為詳細的分析了Sanic框架拋出異常、異常處理、中間件、監(jiān)聽器相關原理與操作技巧,需要的朋友可以參考下

本文實例講述了Sanic框架異常處理與中間件操作。分享給大家供大家參考，具體如下：

簡介

Sanic是一個類似Flask的Python 3.5+ Web服務器，它的寫入速度非常快。除了Flask之外，Sanic還支持異步請求處理程序。這意味著你可以使用Python 3.5中新的閃亮的異步/等待語法，使你的代碼非阻塞和快速。

前言：Sanic最低支持Python 3.5，如果需要學習Sanic，請先下載版本不低于3.5的Python包

異常

異?？梢詮恼埱筇幚沓绦蛑袙伋?，并由Sanic自動處理。異常將消息作為第一個參數，并且還可以將狀態(tài)碼傳回HTTP響應中。

拋出異常：手動產生異常的方式，有過Python基礎的都知道，可以使用raise來產生一個異常：

from sanic.exceptions import ServerError
from sanic.response import text
@app.route("/get_exception")
async def get_exception(request):
  raise ServerError("it is error",status_code=500)

你也可以使用abort：

from sanic.exceptions import abort
from sanic.response import text
@app.route("/get_exception")
async def get_exception(request):
  abort(402)
  text("ok")

處理異常：有時我們需要對一些特殊異常做特殊處理，此時我們可以用到@app.exception裝飾器，然后在定義一個異常函數來進行處理。異常裝飾器處理函數必須以一個Request和Exception對象作為參數：

from sanic.response import text
from sanic.exceptions import NotFound
@app.exception(NotFound)
async def not_found_exception(request,exception):
  return text("not found=>{}".format(request.url))

中間件

中間件是服務器在請求之前或之后執(zhí)行的功能，他們可以用來修改修改用戶定義處理函數的請求或相應。Sanic提供兩種類型的中間件：請求和響應。兩者都是使用@app.middleware裝飾器聲明，兩個裝飾器分別需要傳入一個代表其類型的參數：request和response，下面舉一個簡單的栗子：

from sanic.response import text
@app.route("/get_info")
async def get_info(request):
  print(request.url)
  return text("it is ok!")
@app.middleware("request")
async def get_request_middleware(request):
  print("請求中間件")
@app.middleware("response")
async def get_response_middleware(request,response):
  print("響應中間件")

當我們訪問/get_info請求時，打印結果將會是這樣的：

請求中間件

http://localhost:5000/get_info

響應中間件

值得注意的是，如果是響應中間的處理函數，除了需要傳遞一個request對象參數，還需要傳遞一個response對象參數。從結果可以看出，request中間件是在接收到請求時立馬觸發(fā)的，而response中間件是在接收到響應時立馬觸發(fā)的。針對這兩者的特性，我們可以進行一些特殊的操作，來達到我們的目的：

@app.middleware("request")
async def get_request_middleware(request):
  request.args.update({"name":"laozhang"})
@app.middleware("response")
async def get_response_middleware(request,response):
  response.headers["name"] = "laozhang"

將所有的請求的args添加一條name=laozhang，并且在響應頭中添加name=laozhang

監(jiān)聽器

如果需要在服務器啟動/關閉的時候，執(zhí)行一些特殊的代碼，則可以使用以下監(jiān)聽器：

before_server_start：在服務器啟動之前執(zhí)行
after_server_start：在服務器啟動之后執(zhí)行
before_server_stop：在服務器關閉之前執(zhí)行
after_server_stop：在服務器關閉之后執(zhí)行

舉個栗子：

@app.listener("before_server_start")
async def before_server_start(request,loop):
  print("before_server_start")
@app.listener("after_server_start")
async def after_server_start(request,loop):
  print("after_server_start")
@app.listener("before_server_stop")
async def before_server_stop(request,loop):
  print("before_server_stop")
@app.listener("after_server_stop")
async def after_server_stop(request,loop):
  print("after_server_stop")

現在先啟動服務，而后關閉，發(fā)現執(zhí)行的順序將會是這樣：