蓝图

蓝图是可以在应用程序中用于子路由的对象。蓝图不是向应用程序实例添加路由,而是定义类似的方法来添加路由,然后以灵活且可插入的方式向应用程序注册路由。

蓝图对于更大的应用程序特别有用,在这些应用程序中,可以将应用程序逻辑分解为多个组或职责区域。

我的第一张蓝图

下面显示了一个非常简单的蓝图,它在应用程序的根目录/注册一个处理程序函数。

假设您将此文件保存为my_blueprint.py,稍后可以导入主应用程序。

from sanic.response import json
from sanic import Blueprint

bp = Blueprint('my_blueprint')

@bp.route('/')
async def bp_root(request):
    return json({'my': 'blueprint'})

正在注册蓝图

蓝图必须在应用程序中注册。

from sanic import Sanic
from my_blueprint import bp

app = Sanic(__name__)
app.blueprint(bp)

app.run(host='0.0.0.0', port=8000, debug=True)

这将把蓝图添加到应用程序中,并注册该蓝图定义的任何路由。在本例中,app.router中注册的路由如下:

[Route(handler=<function bp_root at 0x7f908382f9d8>, methods=frozenset({'GET'}), pattern=re.compile('^/$'), parameters=[], name='my_blueprint.bp_root', uri='/')]

蓝图组和嵌套

蓝图也可以注册为列表或元组的一部分,注册器将在蓝图的任何子序列中循环并相应地注册它们。Blueprint.group方法用于简化此过程,允许模拟前端看到的后端目录结构。考虑一下这个(相当做作的)例子:

api/
├──content/
│  ├──authors.py
│  ├──static.py
│  └──__init__.py
├──info.py
└──__init__.py
app.py

此应用的蓝图层次结构的初始化过程如下:

# api/content/authors.py
from sanic import Blueprint

authors = Blueprint('content_authors', url_prefix='/authors')
# api/content/static.py
from sanic import Blueprint

static = Blueprint('content_static', url_prefix='/static')
# api/content/__init__.py
from sanic import Blueprint

from .static import static
from .authors import authors

content = Blueprint.group(static, authors, url_prefix='/content')
# api/info.py
from sanic import Blueprint

info = Blueprint('info', url_prefix='/info')
# api/__init__.py
from sanic import Blueprint

from .content import content
from .info import info

api = Blueprint.group(content, info, url_prefix='/api')

现在可以这样在app.py中注册这些蓝图:

# app.py
from sanic import Sanic

from .api import api

app = Sanic(__name__)

app.blueprint(api)

使用蓝图

蓝图与应用程序实例具有几乎相同的功能。

WebSocket路由

可以使用@bp.websocket decorator或bp.add_websocket_route方法在蓝图上注册websocket处理程序。

蓝图中间件

使用蓝图还允许您全局注册中间件。

@bp.middleware
async def print_on_request(request):
	print("I am a spy")

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

@bp.middleware('response')
async def halt_response(request, response):
	return text('I halted the response')

蓝图组中间件

使用此中间件将确保您可以将通用中间件应用于构成当前考虑中的蓝图组的所有蓝图。

bp1 = Blueprint('bp1', url_prefix='/bp1')
bp2 = Blueprint('bp2', url_prefix='/bp2')

@bp1.middleware('request')
async def bp1_only_middleware(request):
    print('applied on Blueprint : bp1 Only')

@bp1.route('/')
async def bp1_route(request):
    return text('bp1')

@bp2.route('/<param>')
async def bp2_route(request, param):
    return text(param)

group = Blueprint.group(bp1, bp2)

@group.middleware('request')
async def group_middleware(request):
    print('common middleware applied for both bp1 and bp2')
    
# Register Blueprint group under the app
app.blueprint(group)

例外情况

例外情况只能应用于全局蓝图。

@bp.exception(NotFound)
def ignore_404s(request, exception):
	return text("Yep, I totally found the page: {}".format(request.url))

静态文件

静态文件可以在蓝图前缀下全局提供服务。


# suppose bp.name == 'bp'

bp.static('/web/path', '/folder/to/serve')
# also you can pass name parameter to it for url_for
bp.static('/web/path', '/folder/to/server', name='uploads')
app.url_for('static', name='bp.uploads', filename='file.txt') == '/bp/web/path/file.txt'

启停

蓝图可以在服务器的启动和停止过程中运行函数。如果在多处理器模式下运行(超过1个工作进程),则在工作进程分叉后触发。

可用事件包括:

  • 在服务器启动之前:在服务器开始接受连接之前执行

  • 服务器启动后:服务器开始接受连接后执行

  • 在服务器停止之前:在服务器停止接受连接之前执行

  • 服务器停止后:在服务器停止且所有请求完成后执行

bp = Blueprint('my_blueprint')

@bp.listener('before_server_start')
async def setup_connection(app, loop):
    global database
    database = mysql.connect(host='127.0.0.1'...)

@bp.listener('after_server_stop')
async def close_connection(app, loop):
    await database.close()

用例:API版本控制

蓝图对于API版本化非常有用,其中一个蓝图可能指向/v1/<routes>,另一个蓝图指向/v2/<routes>。

当一个蓝图初始化时,它可以接受一个可选的版本参数,该参数将被预先附加到蓝图上定义的所有路由上。这个特性可以用来实现我们的API版本控制方案。

# blueprints.py
from sanic.response import text
from sanic import Blueprint

blueprint_v1 = Blueprint('v1', url_prefix='/api', version="v1")
blueprint_v2 = Blueprint('v2', url_prefix='/api', version="v2")

@blueprint_v1.route('/')
async def api_v1_root(request):
    return text('Welcome to version 1 of our documentation')

@blueprint_v2.route('/')
async def api_v2_root(request):
    return text('Welcome to version 2 of our documentation')

当我们在应用程序上注册蓝图时,routes/v1/api和/v2/api现在将指向单独的蓝图,这允许为每个api版本创建子站点。

# main.py
from sanic import Sanic
from blueprints import blueprint_v1, blueprint_v2

app = Sanic(__name__)
app.blueprint(blueprint_v1)
app.blueprint(blueprint_v2)

app.run(host='0.0.0.0', port=8000, debug=True)

带url_的url构建

如果要为蓝图内的路由生成URL,请记住端点名称采用的格式为<blueprint_name><handler_name>。例如:

@blueprint_v1.route('/')
async def root(request):
    url = request.app.url_for('v1.post_handler', post_id=5) # --> '/v1/api/post/5'
    return redirect(url)


@blueprint_v1.route('/post/<post_id>')
async def post_handler(request, post_id):
    return text('Post {} in Blueprint V1'.format(post_id))