Sanic框架蓝图用法实例分析


Posted in Python onJuly 17, 2018

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

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

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

第一个蓝图

假设你在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!")

注册蓝图

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

from sanic import Sanic
from bp.bp_1 import bp
app = 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")

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

  • before_server_start:在服务器开始接收连接之前执行
  • after_server_start:在服务器开始接收连接之后执行
  • before_server_stop:在服务器停止接收连接之前执行
  • after_server_stop:在服务器停止接收连接之后执行
@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")

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

before server start
after server start

当服务器关闭时,将会依次打印如下信息:

before server stop
after server stop

API版本控制

与手机APP对接的接口开发中,API版本控制尤为重要,针对于低版本用户(尚未升级版本的用户)所用的仍是旧的接口数据,此时开发新功能时对此模块的数据需要进行修改,可是不能影响旧版本的用户,此时我们就需要对API版本进行控制。我们可以定义两个蓝图,一个指向/v1/<route>,另一个指向/v2/<route>。当蓝图初始化时,我们可以采用一个可选参数url_prefix,该参数将被置于蓝图定义的所有路由之上,这个特性可以来实现我们的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")

此时,我们已经定义好了两个蓝图来控制两个版本,我们需要在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))

更多关于Python相关内容可查看本站专题:《Python入门与进阶经典教程》、《Python数据结构与算法教程》、《Python函数使用技巧总结》、《Python字符串操作技巧汇总》及《Python文件与目录操作技巧汇总》

希望本文所述对大家Python程序设计有所帮助。

Python 相关文章推荐
Python编程pygame模块实现移动的小车示例代码
Jan 03 Python
python自动查询12306余票并发送邮箱提醒脚本
May 21 Python
python简单操作excle的方法
Sep 12 Python
对Python Pexpect 模块的使用说明详解
Feb 14 Python
Python数据类型之Dict字典实例详解
May 07 Python
Pycharm运行加载文本出现错误的解决方法
Jun 27 Python
pytorch之ImageFolder使用详解
Jan 06 Python
在python中使用pymysql往mysql数据库中插入(insert)数据实例
Mar 02 Python
Python 批量读取文件中指定字符的实现
Mar 06 Python
python类共享变量操作
Sep 03 Python
python 密码学示例——凯撒密码的实现
Sep 21 Python
Pytorch之扩充tensor的操作
Mar 04 Python
PyCharm设置SSH远程调试的方法
Jul 17 #Python
Flask框架通过Flask_login实现用户登录功能示例
Jul 17 #Python
pycharm远程linux开发和调试代码的方法
Jul 17 #Python
Flask框架各种常见装饰器示例
Jul 17 #Python
详解基于django实现的webssh简单例子
Jul 17 #Python
Python爬虫之网页图片抓取的方法
Jul 16 #Python
python编辑用户登入界面的实现代码
Jul 16 #Python
You might like
解析用PHP读写音频文件信息的详解(支持WMA和MP3)
2013/05/10 PHP
PHP 二维数组根据某个字段排序的具体实现
2014/06/03 PHP
php过滤HTML标签、属性等正则表达式汇总
2014/09/22 PHP
自制PHP框架之设计模式
2017/05/07 PHP
PHP异常处理定义与使用方法分析
2017/07/25 PHP
Thinkphp5.0 框架的请求方式与响应方式分析
2019/10/14 PHP
PHP 进程池与轮询调度算法实现多任务的示例代码
2019/11/26 PHP
php中用unset销毁变量并释放内存
2020/05/10 PHP
javascript SpiderMonkey中的函数序列化如何进行
2012/12/05 Javascript
js二维数组排序的简单示例代码
2014/01/24 Javascript
js实现的点击数量加一可操作数据库
2014/05/09 Javascript
JavaScript定时显示广告代码分享
2015/03/02 Javascript
js获取url传值的方法
2015/12/18 Javascript
js获取腾讯视频ID的方法
2016/10/03 Javascript
javascript遍历json对象的key和任意js对象属性实例
2017/03/09 Javascript
Vue 2.5.2下axios + express 本地请求404的解决方法
2018/02/21 Javascript
Vue动态控制input的disabled属性的方法
2018/06/26 Javascript
cordova+vue+webapp使用html5获取地理位置的方法
2019/07/06 Javascript
JS中getElementsByClassName与classList兼容性问题解决方案分析
2019/08/07 Javascript
jquery实现商品sku多属性选择功能(商品详情页)
2019/12/20 jQuery
vue集成一个支持图片缩放拖拽的富文本编辑器
2021/01/29 Vue.js
快速了解Python相对导入
2018/01/12 Python
python3+PyQt5自定义视图详解
2018/04/24 Python
Django中使用CORS实现跨域请求过程解析
2019/08/05 Python
基于Python脚本实现邮件报警功能
2020/05/20 Python
matplotlib设置颜色、标记、线条,让你的图像更加丰富(推荐)
2020/09/25 Python
美国现代家具网站:Design Within Reach
2018/07/19 全球购物
serialVersionUID具有什么样的特征
2014/02/20 面试题
市场营销专业毕业生自荐信
2013/11/02 职场文书
保密工作责任书
2014/04/16 职场文书
个人对照检查剖析材料
2014/10/13 职场文书
高中生个性发展自我评价
2015/03/09 职场文书
房地产公司工程部经理岗位职责
2015/04/09 职场文书
幼儿园教学反思范文
2016/03/02 职场文书
SQL Server中使用判断语句(IF ELSE/CASE WHEN )案例
2021/07/07 SQL Server
详解redis在微服务领域的贡献
2021/10/16 Redis