轻量级的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 相关文章推荐
利用Fn.py库在Python中进行函数式编程
Apr 22 Python
Python模块搜索概念介绍及模块安装方法介绍
Jun 03 Python
实时获取Python的print输出流方法
Jan 07 Python
解析Python的缩进规则的使用
Jan 16 Python
详解Python3中ceil()函数用法
Feb 19 Python
对django的User模型和四种扩展/重写方法小结
Aug 17 Python
Django框架反向解析操作详解
Nov 28 Python
TensorFlow 多元函数的极值实例
Feb 10 Python
使用Tensorboard工具查看Loss损失率
Feb 15 Python
基于SpringBoot构造器注入循环依赖及解决方式
Apr 26 Python
Python ellipsis 的用法详解
Nov 20 Python
vue.js刷新当前页面的实例讲解
Dec 29 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
PHP和XSS跨站攻击的防范
2007/04/17 PHP
关于PHP语言构造器介绍
2013/07/08 PHP
PHP IDE phpstorm 常用快捷键
2015/05/18 PHP
PHP实现的json类实例
2015/07/28 PHP
Yii2简单实现给表单添加验证码的方法
2016/07/18 PHP
php实现文件管理与基础功能操作
2017/03/21 PHP
通过PHP设置BugFree获取邮箱通知
2019/04/25 PHP
Node.js:Windows7下搭建的Node.js服务(来玩玩服务器端的javascript吧,这可不是前端js插件)
2011/06/27 Javascript
使用jquery mobile做幻灯播放效果实现步骤
2013/01/04 Javascript
node.js中的fs.futimesSync方法使用说明
2014/12/17 Javascript
JS中产生标识符方式的演变
2015/06/12 Javascript
jquery+CSS实现的多级竖向展开树形TRee菜单效果
2015/08/24 Javascript
js中setTimeout的妙用--防止循环超时
2017/03/06 Javascript
详解Angular2中Input和Output用法及示例
2017/05/21 Javascript
JavaScript中常见的八个陷阱总结
2017/06/28 Javascript
JavaScript 隐性类型转换步骤浅析
2018/03/15 Javascript
详解NodeJs开发微信公众号
2018/05/25 NodeJs
手动下载Chrome并解决puppeteer无法使用问题
2018/11/12 Javascript
vue-element-admin 菜单标签失效的解决方式
2019/11/12 Javascript
使用vue打包进行云服务器上传的问题
2020/03/02 Javascript
Vue.js暴露方法给WebView的使用操作
2020/09/07 Javascript
适用于 Vue 的播放器组件Vue-Video-Player操作
2020/11/16 Javascript
Python 的描述符 descriptor详解
2016/02/27 Python
Python中使用支持向量机SVM实践
2017/12/27 Python
Python3 Post登录并且保存cookie登录其他页面的方法
2018/12/28 Python
Python MongoDB 插入数据时已存在则不执行,不存在则插入的解决方法
2019/09/24 Python
Python 类,property属性(简化属性的操作),@property,property()用法示例
2019/10/12 Python
Python 通过正则表达式快速获取电影的下载地址
2020/08/17 Python
Python如何爬取51cto数据并存入MySQL
2020/08/25 Python
详解如何在登录过期后跳出Ifram框架
2020/09/10 HTML / CSS
衰败城市英国官网:Urban Decay英国
2020/04/29 全球购物
文员自我评价怎么写
2013/09/19 职场文书
优秀少先队工作者事迹材料
2014/05/13 职场文书
伏羲庙导游词
2015/02/09 职场文书
如何用JS实现简单的数据监听
2021/05/06 Javascript
Python 读取千万级数据自动写入 MySQL 数据库
2022/06/28 Python