# 蓝图(Blueprints)

# 概述(Overview)

蓝图是应用中可以作为子路由的对象。蓝图定义了同样的添加路由的方式,您可以将一系列路由注册到蓝图上而不是直接注册到应用上,然后再以可插拔的方式将蓝图注册到到应用程序。

蓝图对于大型应用特别有用。在大型应用中,您可以将应用代码根据不同的业务分解成多个蓝图。

# 创建和注册蓝图(Creating and registering)

首先,您必须先创建一个蓝图。蓝图对象有着和 Sanic 对象十分相似的方法,它也提供了相同的装饰器来注册路由。

# ./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"})

接下来,您可以将蓝图注册到 Sanic 应用上。

from sanic import Sanic
from my_blueprint import bp
app = Sanic(__name__)
app.blueprint(bp)

蓝图也提供了 websocket() 装饰器和 add_websocket_route 方法来实现 websocket 通讯。

# 蓝图组(Blueprint groups)

蓝图也可以以列表或者元组的形式进行注册,在这种情况下,注册时会递归地遍历当前序列,在序列中或者在子序列中的所有蓝图对象都会被注册到应用上。Blueprint.group 方法允许模拟一个后端目录结构来简化上述问题。请看这个例子:

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

# 第一个蓝图(First blueprint)

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

# 第二个蓝图(Second blueprint)

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

# 蓝图组(Blueprint group)

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

# 第三个蓝图(Third blueprint)

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

# 另一个蓝图组(Another blueprint group)

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

# 主应用(Main server)

所有的蓝图都会被注册。

# app.py
from sanic import Sanic
from .api import api
app = Sanic(__name__)
app.blueprint(api)

# 中间件(Middleware)

蓝图也可以有自己的中间件,这些中间件只会影响到注册到该蓝图上的路由。

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

# 异常(Exceptions)

正如 异常处理 一章所述,您可以定义蓝图特定的异常响应函数。

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

# 静态文件(Static files)

蓝图也可以单独指定需要代理的静态文件。

bp = Blueprint("bp", url_prefix="/bp")
bp.static("/web/path", "/folder/to/serve")
bp.static("/web/path", "/folder/to/server", name="uploads")

然后文件可以使用 url_for() 函数来获取。详见 路由 章节。

>>> print(app.url_for("static", name="bp.uploads", filename="file.txt"))
'/bp/web/path/file.txt'

# 监听器(Listeners)

蓝图也可以实现 监听器

@bp.listener("before_server_start")
async def before_server_start(app, loop):
    ...
@bp.listener("after_server_stop")
async def after_server_stop(app, loop):
    ...

# 版本管理(Versioning)

版本管理 这一章中介绍了如何进行版本管理,蓝图也可以使用该功能来管理不同版本 API。

version 参数会被作为前缀添加到路由上,如 /v1/v2 等等。

auth1 = Blueprint("auth", url_prefix="/auth", version=1)
auth2 = Blueprint("auth", url_prefix="/auth", version=2)

当我们将蓝图注册到APP上时,/v1/auth/v2/auth 路由将指向两个不同的蓝图,这就允许您为每个 API 版本创建子路由。

from auth_blueprints import auth1, auth2
app = Sanic(__name__)
app.blueprint(auth1)
app.blueprint(auth2)

您也可以将多个蓝图放在一个蓝图组下然后同时为他们添加上版本信息。

auth = Blueprint("auth", url_prefix="/auth")
metrics = Blueprint("metrics", url_prefix="/metrics")
group = Blueprint.group([auth, metrics], version="v1")
# This will provide APIS prefixed with the following URL path
# /v1/auth/ and /v1/metrics

# URL 生成(Generating a URL)

当使用 url_for() 来生成 URL 时,端点的名称将以以下格式来组织:

<blueprint_name>.<handler_name>
MIT Licensed
Copyright © 2018-present Sanic Community Organization

~ Made with ❤️ and ☕️ ~