如何使用Sanic框架藍(lán)圖

如何使用Sanic框架藍(lán)圖？很多新手對(duì)此不是很清楚，為了幫助大家解決這個(gè)難題，下面小編將為大家詳細(xì)講解，有這方面需求的人可以來(lái)學(xué)習(xí)下，希望你能有所收獲。

第一個(gè)藍(lán)圖

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

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!")

注冊(cè)藍(lán)圖

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

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

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

藍(lán)圖的使用

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

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

@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")

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

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

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

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

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

• before_server_start：在服務(wù)器開(kāi)始接收連接之前執(zhí)行

• after_server_start：在服務(wù)器開(kāi)始接收連接之后執(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")

當(dāng)服務(wù)器啟動(dòng)時(shí)，將會(huì)依次打印如下信息：

before server start
after server start

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

before server stop
after server stop

API版本控制

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

此時(shí)，我們已經(jīng)定義好了兩個(gè)藍(lán)圖來(lái)控制兩個(gè)版本，我們需要在app中注冊(cè)它們：

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進(jìn)行重定向，在藍(lán)圖中同樣使用：

from sanic.response import text,redirect
@bp.route("/")
async def handle_root(request):
  # bp為定義藍(lán)圖實(shí)例中的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))

看完上述內(nèi)容是否對(duì)您有幫助呢？如果還想對(duì)相關(guān)知識(shí)有進(jìn)一步的了解或閱讀更多相關(guān)文章，請(qǐng)關(guān)注億速云行業(yè)資訊頻道，感謝您對(duì)億速云的支持。