轻量级的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缩进区别分析
Feb 15 Python
使用Python的Scrapy框架编写web爬虫的简单示例
Apr 17 Python
python安装教程
Feb 28 Python
python 读文件,然后转化为矩阵的实例
Apr 23 Python
Python返回数组/List长度的实例
Jun 23 Python
PyCharm设置每行最大长度限制的方法
Jan 16 Python
django框架面向对象ORM模型继承用法实例分析
Jul 29 Python
Django 批量插入数据的实现方法
Jan 12 Python
Python转换itertools.chain对象为数组的方法
Feb 07 Python
Python Numpy 控制台完全输出ndarray的实现
Feb 19 Python
PYcharm 激活方法(推荐)
Mar 23 Python
详解python with 上下文管理器
Sep 02 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 heredoc和phpwind的模板技术使用方法小结
2008/03/28 PHP
php 无限级数据JSON格式及JS解析
2010/07/17 PHP
PHP管理内存函数 memory_get_usage()使用介绍
2012/09/23 PHP
php读取目录及子目录下所有文件名的方法
2014/10/20 PHP
php中mysql操作buffer用法详解
2015/03/19 PHP
详解php curl带有csrf-token验证模拟提交方法
2018/04/18 PHP
Laravel 默认邮箱登录改成用户名登录的实现方法
2019/08/12 PHP
用js判断页面是否加载完成实现代码
2012/12/11 Javascript
查找iframe里元素的方法可传参
2013/09/11 Javascript
js判断字符是否是汉字的两种方法小结
2014/01/03 Javascript
JavaScript获取表单enctype属性的方法
2015/04/02 Javascript
JavaScript+CSS实现仿天猫侧边网页菜单效果
2015/08/25 Javascript
javascript运动框架用法实例分析(实现放大与缩小效果)
2016/01/08 Javascript
javascript绘制漂亮的心型线效果完整实例
2016/02/02 Javascript
jQuery EasyUI封装简化操作
2016/09/18 Javascript
Bootstrap treeview实现动态加载数据并添加快捷搜索功能
2018/01/07 Javascript
浅谈Vue 性能优化之深挖数组
2018/12/11 Javascript
详解vue 不同环境配置不同的打包命令
2019/04/07 Javascript
前端vue+elementUI如何实现记住密码功能
2020/09/20 Javascript
把MySQL表结构映射为Python中的对象的教程
2015/04/07 Python
Python在线运行代码助手
2016/07/15 Python
python监控进程脚本
2018/04/12 Python
Python实现爬取百度贴吧帖子所有楼层图片的爬虫示例
2018/04/26 Python
基于Python对数据shape的常见操作详解
2018/12/25 Python
详解Python用户登录接口的方法
2019/04/17 Python
Django缓存系统实现过程解析
2019/08/02 Python
python xlwt如何设置单元格的自定义背景颜色
2019/09/03 Python
Python调用系统命令os.system()和os.popen()的实现
2020/12/31 Python
一百多行代码实现react拖拽hooks
2021/03/23 Javascript
《月光启蒙》教学反思
2014/03/01 职场文书
大学生村官承诺书
2014/03/28 职场文书
股权收购意向书
2014/04/01 职场文书
党组织结对共建协议书
2016/03/23 职场文书
创业计划书之都市休闲农庄
2019/12/28 职场文书
CocosCreator如何实现划过的位置显示纹理
2021/04/14 Javascript
解决flex布局中子项目尺寸不受flex-shrink限制
2022/05/11 HTML / CSS