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 相关文章推荐
windows系统中python使用rar命令压缩多个文件夹示例
May 06 Python
Python浅复制中对象生存周期实例分析
Apr 02 Python
浅谈Pandas 排序之后索引的问题
Jun 07 Python
Python 生成 -1~1 之间的随机数矩阵方法
Aug 04 Python
Django中使用第三方登录的示例代码
Aug 20 Python
python Selenium实现付费音乐批量下载的实现方法
Jan 24 Python
pymongo中聚合查询的使用方法
Mar 22 Python
python 猴子补丁(monkey patch)
Jun 26 Python
Django对models里的objects的使用详解
Aug 17 Python
Python实现使用dir获取类的方法列表
Dec 24 Python
Python使用socketServer包搭建简易服务器过程详解
Jun 12 Python
Python序列化与反序列化相关知识总结
Jun 08 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
syphon 虹吸式咖啡冲泡冲煮倒水的得与失
2021/03/03 冲泡冲煮
php 文件上传类代码
2011/08/06 PHP
PHP gbk环境下json_dencode传送来的汉字
2012/11/13 PHP
php源码 fsockopen获取网页内容实例详解
2016/09/24 PHP
javascript 对象的定义方法
2007/01/10 Javascript
写的htc的数据表格
2007/01/20 Javascript
jquery Firefox3.5中操作select的问题
2009/07/10 Javascript
jquery ajax 简单范例(界面+后台)
2013/11/19 Javascript
jquery文本框中的事件应用以输入邮箱为例
2014/05/06 Javascript
js简单实现交换Li的值
2014/05/22 Javascript
JavaScript闭包函数访问外部变量的方法
2014/08/27 Javascript
微信小程序 开发工具快捷键整理
2016/10/31 Javascript
jquery动态添加以及遍历option并获取特定样式名称的option方法
2018/01/29 jQuery
vue注册组件的几种方式总结
2018/03/08 Javascript
基于Vue-Cli 打包自动生成/抽离相关配置文件的实现方法
2018/12/09 Javascript
ajax跨域访问遇到的问题及解决方案
2019/05/23 Javascript
[33:15]2018DOTA2亚洲邀请赛3月30日 小组赛B组 VP VS Mineski
2018/03/31 DOTA
简洁的十分钟Python入门教程
2015/04/03 Python
python使用nntp读取新闻组内容的方法
2015/05/08 Python
实例解析Python设计模式编程之桥接模式的运用
2016/03/02 Python
深入了解Python数据类型之列表
2016/06/24 Python
Windows下的Jupyter Notebook 安装与自定义启动(图文详解)
2018/02/21 Python
浅谈dataframe中更改列属性的方法
2018/07/10 Python
python使用xlrd模块读取xlsx文件中的ip方法
2019/01/11 Python
解决tensorflow读取本地MNITS_data失败的原因
2020/06/22 Python
CSS3中利用animation属性创建雪花飘落特效
2014/05/14 HTML / CSS
简单掌握CSS3中resize属性的用法
2016/04/01 HTML / CSS
男女钓鱼靴和甲板鞋:XTRATUF
2021/01/09 全球购物
Linux管理员面试经常问道的相关命令
2013/04/29 面试题
广州足迹信息技术有限公司Java软件工程师试题
2014/02/15 面试题
学前教育学生自荐信范文
2013/12/31 职场文书
个人三严三实对照检查材料
2014/09/25 职场文书
幽默导游词应该怎么写?
2019/08/26 职场文书
Mysql官方性能测试工具mysqlslap的使用简介
2021/05/21 MySQL
数据库之SQL技巧整理案例
2021/07/07 SQL Server
缓存替换策略及应用(以Redis、InnoDB为例)
2021/07/25 Redis