轻量级的Web框架Flask 中模块化应用的实现


Posted in Python onSeptember 11, 2017

Flask是一个轻量级的Web框架。虽然是轻量级的,但是对于组件一个大型的、模块化应用也是能够实现的,“蓝图”就是这样一种实现。对于模块化应用的实现,在Flask 0.2版本中进行了设计。本文暂时不对“蓝图”做详细的介绍,而是先从0.2版本中的Module类的实现讲起。其实,“蓝图”的实现和Module类的实现很相似。

为什么实现模块化应用

对于大型应用而言,随着功能的不断增加,整个应用的规模也会扩大。按照一定的规则将应用的不同部分进行模块化,不仅能够使整个应用逻辑清晰,也易于维护。例如,在Flask中,你也许想像如下构建一个简单的项目:

/myapplication
  /__init__.py
  /views
    /__init__.py
    /admin.py
    /frontend.py

以上目录结构中,我们将之前的Flask单文件修改成了一个应用包,所有的视图函数都在views下,并且按照功能分为了admin和frontend两个部分。为了实现这种模块化应用的构建,在0.2版本中Flask实现了Module类。这个类实例可以通过注册的方式,在Flask应用创建后添加进应用。

Module类实现了一系列的方法:

•route(rule, **options)
•add_url_rule(rule, endpoint, view_func=None, **options)
•before_request(f)
•before_app_request(f)
•after_request(f)
•after_app_request(f)
•context_processor(f)
•app_context_processor(f)
•_record(func)

以上方法除了add_url_rule和_record外,都可以作为装饰器在自己的模块中使用,这些装饰器都返回一个函数。通过调用_record方法,可以将装饰器返回的函数放到_register_events中。当Flask应用创建之后,通过运行_register_events列表中的函数,可以将这个模块注册到应用中去。

Flask应用怎么注册一个Module

以下我们以一个例子来说明Flask应用怎么注册一个Module。

1. 项目结构

这个简单的例子项目结构如下:

/myapplication
  /__init__.py
  /app.py
  /views
    /__init__.py
    /admin.py
    /blog.py

admin.py和blog.py两个模块的代码如下:

# admin.py
from flask import Module
admin = Module(__name__)
@admin.route('/')
def index():
  return "This is admin page!"
@admin.route('/profile')
def profile():
  return "This is profile page."
# blog.py
from flask import Module
blog = Module(__name__)
@blog.route('/')
def index():
  return "This is my blog!"
@blog.route('/article/<int:id>')
def article(id):
  return "The article id is %d." % id

以上两个模块中,我们首先分别创建了一个Module类,然后像写一般的视图函数一样,为每个模块增加一些规则。之后,可以在创建Flask应用的时候将这些模块引入,就可以注册了。

# app.py
from flask import Flask
from views.admin import admin
from views.blog import blog
app = Flask(__name__)
@app.route('/')
def index():
  return "This is my app."
app.register_module(blog, url_prefix='/blog')
app.register_module(admin, url_prefix='/admin')
if __name__ == '__main__':
  from werkzeug.serving import run_simple
  run_simple('localhost', 5000, app)

在app.py中:

•我们首先引入了admin和blog两个Module对象;
•之后,我们创建了一个Flask应用app,并且为这个应用增加了一个视图函数;
•为了注册模块,我们调用了应用的register_module方法;
•最后,从werkzeug.serving中我们调用run_simple方法,用来创建一个本地的服务器用于测试这个Flask应用。

根据以上的步骤,我们就可以测试这个应用。分别以/blog和/admin为URL前缀,就可以访问blog和admin两个模块了。

2. 注册Module时发生了什么

根据上面的例子,只要简单的调用Flask应用的register_module方法,就可以注册一个Module了。关于register_module方法的代码如下:

def register_module(self, module, **options):
  """Registers a module with this application. The keyword argument
  of this function are the same as the ones for the constructor of the
  :class:`Module` class and will override the values of the module if
  provided.
  """
  options.setdefault('url_prefix', module.url_prefix)
  state = _ModuleSetupState(self, **options)
  for func in module._register_events:
    func(state)

通过以上代码可以发现:
•可以通过增加url_prefix来区分不同的Module,这在app注册admin和blog时我们已经看到了;
•在注册时,我们创建了一个_ModuleSetupState的类,这个类接收Flask应用和一些参数生成一个state实例。这个实例反映了当前Flask应用的状态。
•前面在讲到Module类的时候,我们讲到Module未注册时会将自己模块的一些功能实现都放在_register_events列表中,这些功能实现都是函数形式。当需要将模块注册到某一应用上时,只需要传递关于这个应用信息的参数即可,即就是上面的state实例。这样,通过运行函数,可以讲一些属性绑定到当前应用上去。

以上面例子中不同模块的URL绑定来讲,通过注册,应用app现形成了如下的URL“地图”:

>>> app.url_map
Map([<Rule '/admin/profile' (HEAD, GET) -> admin.profile>,
   <Rule '/admin/' (HEAD, GET) -> admin.index>,
   <Rule '/blog/' (HEAD, GET) -> blog.index>,
   <Rule '/' (HEAD, GET) -> index>,
   <Rule '/blog/article/<id>' (HEAD, GET) -> blog.article>,
   <Rule '/static/<filename>' (HEAD, GET) -> static>]
  )
>>> app.url_map._rules_by_endpoint
{'admin.index': [<Rule '/admin/' (HEAD, GET) -> admin.index>],
 'admin.profile': [<Rule '/admin/profile' (HEAD, GET) -> admin.profile>],
 'blog.article': [<Rule '/blog/article/<id>' (HEAD, GET) -> blog.article>],
 'blog.index': [<Rule '/blog/' (HEAD, GET) -> blog.index>],
 'index': [<Rule '/' (HEAD, GET) -> index>],
 'static': [<Rule '/static/<filename>' (HEAD, GET) -> static>]
}
>>> app.view_functions
{'admin.index': <function views.admin.index>,
 'admin.profile': <function views.admin.profile>,
 'blog.article': <function views.blog.article>,
 'blog.index': <function views.blog.index>,
 'index': <function __main__.index>
}

这样,就可以把不同模块的URL规则放在一起,并在endpoint和视图函数之间形成对应关系。关于Flask应用中URL处理,可以参考:Flask应用中的URL处理。

Python 相关文章推荐
Python ORM框架SQLAlchemy学习笔记之安装和简单查询实例
Jun 10 Python
Python中获取网页状态码的两个方法
Nov 03 Python
python中黄金分割法实现方法
May 06 Python
python超简单解决约瑟夫环问题
May 12 Python
深入讲解Python中的迭代器和生成器
Oct 26 Python
python字符串中的单双引
Feb 16 Python
Django缓存系统实现过程解析
Aug 02 Python
django 读取图片到页面实例
Mar 27 Python
使用python matplotlib 画图导入到word中如何保证分辨率
Apr 16 Python
使用Keras构造简单的CNN网络实例
Jun 29 Python
Python如何使用27行代码绘制星星图
Jul 20 Python
python脚本使用阿里云slb对恶意攻击进行封堵的实现
Feb 04 Python
Python 模拟购物车的实例讲解
Sep 11 #Python
python添加模块搜索路径方法
Sep 11 #Python
解决Django模板无法使用perms变量问题的方法
Sep 10 #Python
python实现批量修改文件名代码
Sep 10 #Python
python中利用队列asyncio.Queue进行通讯详解
Sep 10 #Python
Python上下文管理器和with块详解
Sep 09 #Python
Python使用asyncio包处理并发详解
Sep 09 #Python
You might like
mysql 字段类型说明
2007/04/27 PHP
centos 5.6 升级php到5.3的方法
2011/05/14 PHP
PHP两种去掉数组重复值的方法比较
2014/06/19 PHP
PHP关联数组实现根据元素值删除元素的方法
2015/06/26 PHP
Yii的Srbac插件用法详解
2016/07/14 PHP
PHP 加密 Password Hashing API基础知识点
2020/03/02 PHP
jQuery 性能优化指南(2)
2009/05/21 Javascript
jQuery 页面 Mask实现代码
2010/01/09 Javascript
js设置document.domain实现跨域的注意点分析
2015/05/21 Javascript
node.js实现爬虫教程
2020/08/25 Javascript
JQuery控制图片由中心点逐渐放大效果
2016/06/26 Javascript
React-Native做一个文本输入框组件的实现代码
2017/08/10 Javascript
NodeJs form-data格式传输文件的方法
2017/12/13 NodeJs
详解浏览器缓存和webpack缓存配置
2018/07/06 Javascript
JS/HTML5游戏常用算法之碰撞检测 地图格子算法实例详解
2018/12/12 Javascript
Node.js+Express+Mysql 实现增删改查
2019/04/03 Javascript
js实现QQ邮箱邮件拖拽删除功能
2020/08/27 Javascript
Python入门篇之条件、循环
2014/10/17 Python
用Python脚本来删除指定容量以上的文件的教程
2015/05/04 Python
Python封装shell命令实例分析
2015/05/05 Python
Python文档生成工具pydoc使用介绍
2015/06/02 Python
在Mac下使用python实现简单的目录树展示方法
2018/11/01 Python
Pytorch学习之torch用法----比较操作(Comparison Ops)
2020/06/28 Python
浅谈django框架集成swagger以及自定义参数问题
2020/07/07 Python
CSS3按钮鼠标悬浮实现光圈效果源码
2016/09/11 HTML / CSS
信访工作者先进事迹
2014/01/17 职场文书
2014年教师节讲话稿5篇
2014/09/10 职场文书
一份恶作剧的检讨书
2014/09/13 职场文书
办理收楼委托书范本
2014/10/09 职场文书
2014年监理个人工作总结
2014/12/11 职场文书
新生开学寄语大全
2015/05/28 职场文书
全民创业工作总结
2015/08/13 职场文书
不会写演讲稿,快来看看这篇文章!
2019/08/06 职场文书
CSS 实现多彩、智能的阴影效果
2021/05/12 HTML / CSS
python执行js代码的方法
2021/05/13 Python
Java 获取Word中所有的插入和删除修订的方法
2022/04/06 Java/Android