Sanic框架蓝图用法实例分析

本文实例讲述了Sanic框架蓝图用法。分享给大家供大家参考，具体如下：

蓝图是可以用于应用程序内子路由的对象。蓝图并未向应用程序内添加路由，而是定义了用于添加路由的类似方法，然后以灵活且可插入的方式向应用程序注册路由。

蓝图对于大型应用程序尤其有用，您的应用程序可以分解成为几个小组或责任区域。

第一个蓝图

假设你在bp/bp_1.py文件下，定义了以下这么一个非常简单的蓝图：

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

注册蓝图

定义了一个蓝图之后，必须在应用程序中注册：

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

如此，并将蓝图添加到应用程序当中，并注册蓝图所定义的所有路由。此时我们就可以访问/get_info就可以获取到数据了

蓝图的使用

在前面一篇《Sanic框架异常处理与中间件操作》中简单介绍了一下在路由中如何使用中间件与异常以及监听器等，这些东西在蓝图中同样可以使用：

中间件：使用蓝图可以在全局范围内注册中间件

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

异常：使用蓝图可以在全局范围内注册异常

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

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

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

监听器：如果需要在服务器启动/关闭的时候，执行一些特殊的代码，则可以使用以下监听器，可用的监听器如下：

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

当服务器启动时，将会依次打印如下信息：