Sanic框架藍圖用法實例分析

更新時間：2018年07月17日 09:56:36 作者：噴跑的豆子

這篇文章主要介紹了Sanic框架藍圖用法,結(jié)合實例形式分析了Sanic框架中藍圖的功能以及路由控制中藍圖的定義、注冊、簡單使用方法及相關(guān)操作注意事項,需要的朋友可以參考下

本文實例講述了Sanic框架藍圖用法。分享給大家供大家參考，具體如下：

藍圖是可以用于應(yīng)用程序內(nèi)子路由的對象。藍圖并未向應(yīng)用程序內(nèi)添加路由，而是定義了用于添加路由的類似方法，然后以靈活且可插入的方式向應(yīng)用程序注冊路由。

藍圖對于大型應(yīng)用程序尤其有用，您的應(yīng)用程序可以分解成為幾個小組或責任區(qū)域。

第一個藍圖

假設(shè)你在bp/bp_1.py文件下，定義了以下這么一個非常簡單的藍圖：

from sanic import Blueprint
from sanic.response import text
bp = Blueprint("first_bp")
@bp.route("/get_info")
async def get_info(request):
  return text("it is ok!")

注冊藍圖

定義了一個藍圖之后，必須在應(yīng)用程序中注冊：

from sanic import Sanic
from bp.bp_1 import bp
app = Sanic()
app.blueprint(bp)
if __name__ == "__main__":
  app.run()

如此，并將藍圖添加到應(yīng)用程序當中，并注冊藍圖所定義的所有路由。此時我們就可以訪問/get_info就可以獲取到數(shù)據(jù)了

藍圖的使用

在前面一篇《Sanic框架異常處理與中間件操作》中簡單介紹了一下在路由中如何使用中間件與異常以及監(jiān)聽器等，這些東西在藍圖中同樣可以使用：

中間件：使用藍圖可以在全局范圍內(nèi)注冊中間件

@bp.route("/get_info")
async def get_info(request):
  return text("get_info")
@bp.middleware("request")
async def handle_md_request(request):
  print("request middleware")
@bp.middleware("response")
async def handle_md_response(request,response):
  print("response middleware")

異常：使用藍圖可以在全局范圍內(nèi)注冊異常

from sanic.exceptions import NotFound
@bp.exception(NotFound)
async def handle_exception(request,exception):
  return text("404 exception")

靜態(tài)文件：靜態(tài)文件可以在藍圖前綴下全局提供

bp.static("/home","/aaa/bbb/abc.html")

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

before_server_start：在服務(wù)器開始接收連接之前執(zhí)行
after_server_start：在服務(wù)器開始接收連接之后執(zhí)行
before_server_stop：在服務(wù)器停止接收連接之前執(zhí)行
after_server_stop：在服務(wù)器停止接收連接之后執(zhí)行

@bp.listener("before_server_start")
async def before_server_start(request,loop):
  print("before server start")
@bp.listener("after_server_start")
async def after_server_start(request,loop):
  print("after server start")
@bp.listener("before_server_stop")
async def before_server_stop(request,loop):
  print("before server stop")
@bp.listener("after_server_stop")
async def after_server_stop(request,loop):
  print("after server stop")

當服務(wù)器啟動時，將會依次打印如下信息：

before server start
after server start

當服務(wù)器關(guān)閉時，將會依次打印如下信息：

before server stop
after server stop

API版本控制

與手機APP對接的接口開發(fā)中，API版本控制尤為重要，針對于低版本用戶(尚未升級版本的用戶)所用的仍是舊的接口數(shù)據(jù)，此時開發(fā)新功能時對此模塊的數(shù)據(jù)需要進行修改，可是不能影響舊版本的用戶，此時我們就需要對API版本進行控制。我們可以定義兩個藍圖，一個指向/v1/<route>，另一個指向/v2/<route>。當藍圖初始化時，我們可以采用一個可選參數(shù)url_prefix，該參數(shù)將被置于藍圖定義的所有路由之上，這個特性可以來實現(xiàn)我們的API版本控制方案：

from sanic import Blueprint
from sanic.response import text
bp1 = Blueprint("bp1",url_prefix="/v1")
bp2 = Blueprint("bp2",url_prefix="/v2")
@bp1.route("/get_data")
async def get_v1_data(request):
  return text("it is v1")
@bp2.route("/get_data")
async def get_v2_data(request):
  return text("it is v2")

此時，我們已經(jīng)定義好了兩個藍圖來控制兩個版本，我們需要在app中注冊它們：

from sanic import Sanic
from app.bp.bp_info import bp1,bp2
app = Sanic()
app.blueprint(bp1)
app.blueprint(bp2)
if __name__ == "__main__":
  app.run()

重定向

在之前的博文中，我們講到可以使用url_for基于處理程序方法名稱生成URL，然后使用redirect進行重定向，在藍圖中同樣使用：

from sanic.response import text,redirect
@bp.route("/")
async def handle_root(request):
  # bp為定義藍圖實例中的name
  url = request.app.url_for("bp.get_info",name="laozhang")
  return redirect(url)
@bp.route("/get_info/<name>")
async def get_info(request,name):
  return text("name:{}".format(name))

更多關(guān)于Python相關(guān)內(nèi)容可查看本站專題：《Python入門與進階經(jīng)典教程》、《Python數(shù)據(jù)結(jié)構(gòu)與算法教程》、《Python函數(shù)使用技巧總結(jié)》、《Python字符串操作技巧匯總》及《Python文件與目錄操作技巧匯總》

希望本文所述對大家Python程序設(shè)計有所幫助。

您可能感興趣的文章: