Flask是一個輕量級的Web框架。雖然是輕量級的，但是對于組件一個大型的、模塊化應(yīng)用也是能夠?qū)崿F(xiàn)的，“藍圖”就是這樣一種實現(xiàn)。對于模塊化應(yīng)用的實現(xiàn)，在Flask 0.2版本中進行了設(shè)計。本文暫時不對“藍圖”做詳細的介紹，而是先從0.2版本中的Module類的實現(xiàn)講起。其實，“藍圖”的實現(xiàn)和Module類的實現(xiàn)很相似。

為什么實現(xiàn)模塊化應(yīng)用

對于大型應(yīng)用而言，隨著功能的不斷增加，整個應(yīng)用的規(guī)模也會擴大。按照一定的規(guī)則將應(yīng)用的不同部分進行模塊化，不僅能夠使整個應(yīng)用邏輯清晰，也易于維護。例如，在Flask中，你也許想像如下構(gòu)建一個簡單的項目：

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

以上目錄結(jié)構(gòu)中，我們將之前的Flask單文件修改成了一個應(yīng)用包，所有的視圖函數(shù)都在views下，并且按照功能分為了admin和frontend兩個部分。為了實現(xiàn)這種模塊化應(yīng)用的構(gòu)建，在0.2版本中Flask實現(xiàn)了Module類。這個類實例可以通過注冊的方式，在Flask應(yīng)用創(chuàng)建后添加進應(yīng)用。

Module類實現(xiàn)了一系列的方法：

•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外，都可以作為裝飾器在自己的模塊中使用，這些裝飾器都返回一個函數(shù)。通過調(diào)用_record方法，可以將裝飾器返回的函數(shù)放到_register_events中。當Flask應(yīng)用創(chuàng)建之后，通過運行_register_events列表中的函數(shù)，可以將這個模塊注冊到應(yīng)用中去。

Flask應(yīng)用怎么注冊一個Module

以下我們以一個例子來說明Flask應(yīng)用怎么注冊一個Module。

1. 項目結(jié)構(gòu)

這個簡單的例子項目結(jié)構(gòu)如下：

/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

以上兩個模塊中，我們首先分別創(chuàng)建了一個Module類，然后像寫一般的視圖函數(shù)一樣，為每個模塊增加一些規(guī)則。之后，可以在創(chuàng)建Flask應(yīng)用的時候?qū)⑦@些模塊引入，就可以注冊了。

# 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對象；
•之后，我們創(chuàng)建了一個Flask應(yīng)用app，并且為這個應(yīng)用增加了一個視圖函數(shù)；
•為了注冊模塊，我們調(diào)用了應(yīng)用的register_module方法；
•最后，從werkzeug.serving中我們調(diào)用run_simple方法，用來創(chuàng)建一個本地的服務(wù)器用于測試這個Flask應(yīng)用。

根據(jù)以上的步驟，我們就可以測試這個應(yīng)用。分別以/blog和/admin為URL前綴，就可以訪問blog和admin兩個模塊了。

2. 注冊Module時發(fā)生了什么

根據(jù)上面的例子，只要簡單的調(diào)用Flask應(yīng)用的register_module方法，就可以注冊一個Module了。關(guān)于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)

通過以上代碼可以發(fā)現(xiàn)：
•可以通過增加url_prefix來區(qū)分不同的Module，這在app注冊admin和blog時我們已經(jīng)看到了；
•在注冊時，我們創(chuàng)建了一個_ModuleSetupState的類，這個類接收Flask應(yīng)用和一些參數(shù)生成一個state實例。這個實例反映了當前Flask應(yīng)用的狀態(tài)。
•前面在講到Module類的時候，我們講到Module未注冊時會將自己模塊的一些功能實現(xiàn)都放在_register_events列表中，這些功能實現(xiàn)都是函數(shù)形式。當需要將模塊注冊到某一應(yīng)用上時，只需要傳遞關(guān)于這個應(yīng)用信息的參數(shù)即可，即就是上面的state實例。這樣，通過運行函數(shù)，可以講一些屬性綁定到當前應(yīng)用上去。

以上面例子中不同模塊的URL綁定來講，通過注冊，應(yīng)用app現(xiàn)形成了如下的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規(guī)則放在一起，并在endpoint和視圖函數(shù)之間形成對應(yīng)關(guān)系。關(guān)于Flask應(yīng)用中URL處理，可以參考：Flask應(yīng)用中的URL處理。

最新評論