Flask是一个轻量级的Web框架。虽然是轻量级的,但是对于组件一个大型的、模块化应用也是能够实现的,“蓝图”就是这样一种实现。对于模块化应用的实现,在Flask 0.2版本中进行了设计。本文暂时不对“蓝图”做详细的介绍,而是先从0.2版本中的Module
类的实现讲起。其实,“蓝图”的实现和Module
类的实现很相似。
为什么实现模块化应用
对于大型应用而言,随着功能的不断增加,整个应用的规模也会扩大。按照一定的规则将应用的不同部分进行模块化,不仅能够使整个应用逻辑清晰,也易于维护。例如,在Flask中,你也许想像如下构建一个简单的项目:
|
|
以上目录结构中,我们将之前的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. 项目结构
这个简单的例子项目结构如下:
|
|
admin.py
和blog.py
两个模块的代码如下:
|
|
|
|
以上两个模块中,我们首先分别创建了一个Module
类,然后像写一般的视图函数一样,为每个模块增加一些规则。之后,可以在创建Flask应用的时候将这些模块引入,就可以注册了。
|
|
在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
方法的代码如下:
|
|
通过以上代码可以发现:
可以通过增加
url_prefix
来区分不同的Module
,这在app
注册admin
和blog
时我们已经看到了;在注册时,我们创建了一个
_ModuleSetupState
的类,这个类接收Flask应用和一些参数生成一个state
实例。这个实例反映了当前Flask应用的状态。前面在讲到
Module
类的时候,我们讲到Module
未注册时会将自己模块的一些功能实现都放在_register_events
列表中,这些功能实现都是函数形式。当需要将模块注册到某一应用上时,只需要传递关于这个应用信息的参数即可,即就是上面的state
实例。这样,通过运行函数,可以讲一些属性绑定到当前应用上去。
以上面例子中不同模块的URL绑定来讲,通过注册,应用app
现形成了如下的URL“地图”:
|
|
这样,就可以把不同模块的URL规则放在一起,并在endpoint
和视图函数之间形成对应关系。关于Flask应用中URL处理,可以参考:Flask应用中的URL处理。
版权声明
Learn Python by Fan Chunke is licensed under a Creative Commons BY-NC-ND 4.0 International License.
由Fan Chunke创作并维护的Learn Python博客采用创作共用保留署名-非商业-禁止演绎4.0国际许可证。
本文首发于Learn Python 博客( http://fanchunke.me ),版权所有,侵权必究。
本文永久链接:http://fanchunke.me/Flask/Flask中模块化应用的实现/