雖然小型web應(yīng)用程序用單個腳本可以很方便，但這種方法卻不能很好地擴展。隨著應(yīng)用變得復(fù)雜，在單個大的源文件中處理會變得問題重重。

與大多數(shù)其他web框架不同，F(xiàn)lask對大型項目沒有特定的組織方式；應(yīng)用程序的結(jié)構(gòu)完全交給開發(fā)人員自己決定。在這一章，提出一個可能的方式來組織管理一個大型應(yīng)用程序的包和模塊。這種結(jié)構(gòu)將用于書中其余的示例中。

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

示例 基本多文件Flask應(yīng)用結(jié)構(gòu)

|-flasky
 |-app/
  |-templates/
  |-static/
  |-main/
   |-__init__.py
   |-errors.py
   |-forms.py
   |-views.py
  |-__init__.py
  |-email.py
  |-models.py
 |-migrations/
 |-tests/
  |-__init__.py
  |-test*.py
 |-venv/
 |-requirements.txt
 |-config.py
 |-manage.py

這個結(jié)構(gòu)有四個頂層目錄：

• Flask應(yīng)用一般放置在名為app的目錄下。
• migrations目錄包含數(shù)據(jù)庫遷移腳本，這和之前說的一樣。
• 單元測試放置在test目錄下
• venv目錄包含Python虛擬環(huán)境，這和之前說的也是一樣的。

還有一些新的文件：

• requirements.txt列出一些依賴包，這樣就可以很容易的在不同的計算機上部署一個相同的虛擬環(huán)境。
• config.py存儲了一些配置設(shè)置。
• manage.py用于啟動應(yīng)用程序和其他應(yīng)用程序任務(wù)。

為了幫助你完全理解這個結(jié)構(gòu)，下面會描述將hello.py應(yīng)用改為符合這一結(jié)構(gòu)的整個流程。

2、配置選項
應(yīng)用程序通常需要幾個配置設(shè)置。最好的例子就是在開發(fā)過程中需要使用不同的數(shù)據(jù)庫，測試，生產(chǎn)環(huán)境，這樣他們可以做到互不干擾。

我們可以使用配置類的層次結(jié)構(gòu)來代替hello.py中的簡單類字典結(jié)構(gòu)配置。下面展示了config.py文件。

config.py：應(yīng)用程序配置

import os
basedir = os.path.abspath(os.path.dirname(__file__))

class Config:
  SECRET_KEY = os.environ.get('SECRET_KEY') or 'hard to guess string' 
  SQLALCHEMY_COMMIT_ON_TEARDOWN = True
  FLASKY_MAIL_SUBJECT_PREFIX = '[Flasky]'
  FLASKY_MAIL_SENDER = 'Flasky Admin <flasky@example.com>' 
  FLASKY_ADMIN = os.environ.get('FLASKY_ADMIN')
  
  @staticmethod
  def init_app(app): 
    pass

class DevelopmentConfig(Config): 
  DEBUG = True

  MAIL_SERVER = 'smtp.googlemail.com'
  MAIL_PORT = 587
  MAIL_USE_TLS = True
  MAIL_USERNAME = os.environ.get('MAIL_USERNAME')
  MAIL_PASSWORD = os.environ.get('MAIL_PASSWORD') 
  SQLALCHEMY_DATABASE_URI = os.environ.get('DEV_DATABASE_URL') or \
    'sqlite:///' + os.path.join(basedir, 'data-dev.sqlite')

class TestingConfig(Config): 
  TESTING = True
  SQLALCHEMY_DATABASE_URI = os.environ.get('TEST_DATABASE_URL') or \
    'sqlite:///' + os.path.join(basedir, 'data-test.sqlite')

class ProductionConfig(Config):
  SQLALCHEMY_DATABASE_URI = os.environ.get('DATABASE_URL') or \
    'sqlite:///' + os.path.join(basedir, 'data.sqlite')

config = {
  'development': DevelopmentConfig,
  'testing': TestingConfig,
  'production': ProductionConfig,
  'default': DevelopmentConfig
}

Config基類包含一些相同配置；不同的子類定義不同的配置。額外配置可以在需要的時候在加入。

為了讓配置更靈活更安全，一些設(shè)置可以從環(huán)境變量中導(dǎo)入。例如，SECRET_KEY，由于它的敏感性，可以在環(huán)境中設(shè)置，但如果環(huán)境中沒有定義就必須提供一個默認值。

在三個配置中SQLALCHEMY_DATABASE_URI變量可以分配不同的值。這樣應(yīng)用程序可以在不同的配置下運行，每個可以使用不同的數(shù)據(jù)庫。

配置類可以定義一個將應(yīng)用程序?qū)嵗鳛閰?shù)的init_app()靜態(tài)方法。這里特定于配置的初始化是可以執(zhí)行的。這里Config基類實現(xiàn)一個空init_app()方法。

在配置腳本的底部，這些不同的配置是注冊在配置字典中。將其中一個配置(開發(fā)配置)注冊為默認配置。

3、應(yīng)用程序包
應(yīng)用程序包放置了所有應(yīng)用程序代碼、模板和靜態(tài)文件。它被簡單的稱為app，也可以給定一個特定于應(yīng)用的名稱(如果需要的話)。templates和static目錄是應(yīng)用的一部分，因此這兩個目錄應(yīng)該放置在app中。數(shù)據(jù)庫模型和電子郵件支持功能也要置入到這個包中，每個都以app/models.py和app/email.py形式存入自己的模塊當中。

3.1、使用一個應(yīng)用程序工廠

在單個文件中創(chuàng)建應(yīng)用程序的方式非常方便，但是它有一個大缺點。因為應(yīng)用程序創(chuàng)建在全局范圍，沒有辦法動態(tài)的適應(yīng)應(yīng)用配置的更改:腳本運行時，應(yīng)用程序?qū)嵗呀?jīng)創(chuàng)建，所以它已經(jīng)來不及更改配置。對于單元測試這是特別重要的，因為有時需要在不同的配置下運行應(yīng)用程序來獲得更好的測試覆蓋率。

解決這一問題的方法就是將應(yīng)用程序放入一個工廠函數(shù)中來延遲創(chuàng)建，這樣就可以從腳本中顯式的調(diào)用。

這不僅給腳本充足的時間來設(shè)置配置，也能用于創(chuàng)建多個應(yīng)用程序?qū)嵗恍┰跍y試過程中非常有用的東西。被定義在app包的構(gòu)造函數(shù)中的應(yīng)用程序工廠函數(shù)會在示例7-3中展示。

這個構(gòu)造函數(shù)導(dǎo)入大部分當前需要使用的擴展，但因為沒有應(yīng)用程序?qū)嵗跏蓟鼈儯梢员粍?chuàng)建但不初始化通過不傳遞參數(shù)給它們的構(gòu)造函數(shù)。create_app()即應(yīng)用程序工廠函數(shù)，需要傳入用于應(yīng)用程序的配置名。配置中的設(shè)置被保存在config.py中的一個類中，可以使用Flask的app.config配置對象的from_object()方法來直接導(dǎo)入。配置對象可以通過對象名從config字典中選出。一旦應(yīng)用程序被創(chuàng)建且配置好，擴展就可以被初始化。調(diào)用擴展里的init_app()之前先創(chuàng)建并完成初始化工作。

app/ _init__.py：應(yīng)用程序包構(gòu)造函數(shù)_

from flask import Flask, render_template 
from flask.ext.bootstrap import Bootstrap 
from flask.ext.mail import Mail
from flask.ext.moment import Moment
from flask.ext.sqlalchemy import SQLAlchemy 
from config import config

bootstrap = Bootstrap()
mail = Mail()
moment = Moment()
db = SQLAlchemy()

def create_app(config_name):
  app = Flask(__name__) 
  app.config.from_object(config[config_name]) 
  config[config_name].init_app(app)
  
  bootstrap.init_app(app)
  mail.init_app(app)
  moment.init_app(app)
  db.init_app(app)

  # attach routes and custom error pages here
  
  return app

工廠函數(shù)返回創(chuàng)建的應(yīng)用程序?qū)嵗?，但是請注意，在當前狀態(tài)下使用工廠函數(shù)創(chuàng)建的應(yīng)用程序是不完整的，因為它們沒有路由和自定義錯誤頁面處理程序。這是下一節(jié)的主題。

3.2、在藍圖中實現(xiàn)應(yīng)用程序的功能

應(yīng)用程序工廠的轉(zhuǎn)化工作引出了路由的復(fù)雜化。在單腳本應(yīng)用中，應(yīng)用程序?qū)嵗侨值模钥梢院苋菀椎厥褂胊pp.route裝飾器定義路由。但是現(xiàn)在應(yīng)用程序在運行時創(chuàng)建，app.route裝飾器只有在create_app()調(diào)用后才開始存在，這就太遲了。就像路由那樣，這些通過app.errorhandler裝飾器定義的自定義錯誤頁面處理程序也存在同樣的問題。

幸運的是Flask使用藍圖來提供一個更好的解決方案。一個藍圖就類似于一個可以定義路由的應(yīng)用程序。不同的是，和路由相關(guān)聯(lián)的藍圖都在休眠狀態(tài)，只有當藍圖在應(yīng)用中被注冊后，此時的路由才會成為它的一部分。使用定義在全局作用域下的藍圖，定義應(yīng)用程序的路由就幾乎可以和單腳本應(yīng)用程序一樣簡單了。

和應(yīng)用程序一樣，藍圖可以定義在一個文件或一個包中與多個模塊一起創(chuàng)建更結(jié)構(gòu)化的方式。為了追求最大的靈活性，可以在應(yīng)用程序包中創(chuàng)建子包來持有藍圖。下面展示了創(chuàng)建藍圖的構(gòu)造函數(shù)。

app/main/ _init__.py：創(chuàng)建藍圖_

from flask import Blueprint

main = Blueprint('main', __name__) 

from . import views, errors

藍圖是通過實例化Blueprint類對象來創(chuàng)建的。這個類的構(gòu)造函數(shù)接收兩個參數(shù)：藍圖名和藍圖所在的模塊或包的位置。與應(yīng)用程序一樣，在大多數(shù)情況下，對于第二個參數(shù)值使用Python的__name__變量是正確的。

應(yīng)用程序的路由都保存在app/main/views.py模塊內(nèi)部，而錯誤處理程序則保存在app/main/errors.py中。導(dǎo)入這些模塊可以使路由、錯誤處理與藍圖相關(guān)聯(lián)。重要的是要注意，在app/init.py腳本的底部導(dǎo)入模塊要避免循環(huán)依賴，因為view.py和errors.py都需要導(dǎo)入main藍圖。

藍圖和應(yīng)用程序一樣注冊在create_app()工廠函數(shù)中，如下所示。

示例 app/ _init__.py：藍圖注冊_

def create_app(config_name): 
  # ...
  from .main import main as main_blueprint 
  app.register_blueprint(main_blueprint)

  return app

下面則展示了錯誤處理。

app/main/errors.py：藍圖的錯誤處理

from flask import render_template 
from . import main

@main.app_errorhandler(404) 
def page_not_found(e):
  return render_template('404.html'), 404

@main.app_errorhandler(500) 
def internal_server_error(e):
  return render_template('500.html'), 500

在藍圖中寫錯誤處理的不同之處是，如果使用了errorhandler裝飾器，則只會調(diào)用在藍圖中引起的錯誤處理。而應(yīng)用程序范圍內(nèi)的錯誤處理則必須使用app_errorhandler。

這里展示了被更新在藍圖中的應(yīng)用程序路由。

app/main/views.py：帶有藍圖的應(yīng)用程序路由

from datetime import datetime
from flask import render_template, session, redirect, url_for

from . import main
from .forms import NameForm 
from .. import db
from ..models import User

@main.route('/', methods=['GET', 'POST']) 
def index():
  form = NameForm()
  if form.validate_on_submit():
    # ...
    return redirect(url_for('.index')) 
  return render_template('index.html',
              form=form, name=session.get('name'),
              known=session.get('known', False),
              current_time=datetime.utcnow())

在藍圖中寫視圖函數(shù)有兩大不同點。第一，正如之前的錯誤處理一樣，路由裝飾器來自于藍圖。第二個不同是url_for()函數(shù)的使用。你可能會回想，該函數(shù)的第一個參數(shù)為路由節(jié)點名，它給基于應(yīng)用程序的路由指定默認視圖函數(shù)。例如，單腳本應(yīng)用程序中的index()視圖函數(shù)的URL可以通過url_for('index')來獲得。

不同的是Flask名稱空間適用于來自藍圖的所有節(jié)點，這樣多個藍圖可以使用相同節(jié)點定義視圖函數(shù)而不會產(chǎn)生沖突。名稱空間就是藍圖名（Blueprint構(gòu)造函數(shù)中的第一個參數(shù)），所以index()視圖函數(shù)注冊為main.index且它的URL可以通過url_for('main.index')獲得。

在藍圖中，url_for()函數(shù)同樣支持更短格式的節(jié)點，省略藍圖名，例如url_for('.index')。有了這個，就可以這樣使用當前請求的藍圖了。這實際意味著相同藍圖內(nèi)的重定向可以使用更短的形式，如果重定向跨藍圖則必須使用帶名稱空間的節(jié)點名。

完成了應(yīng)用程序頁面更改，表單對象也保存在app/main/forms.py模塊中的藍圖里面。

4、啟動腳本
頂層目錄中的manage.py文件用于啟動應(yīng)用。

manage.py：啟動腳本

#!/usr/bin/env python
import os
from app import create_app, db
from app.models import User, Role
from flask.ext.script import Manager, Shell
from flask.ext.migrate import Migrate, MigrateCommand

app = create_app(os.getenv('FLASK_CONFIG') or 'default') 
manager = Manager(app)
migrate = Migrate(app, db)

def make_shell_context():
  return dict(app=app, db=db, User=User, Role=Role)

manager.add_command("shell", Shell(make_context=make_shell_context))
manager.add_command('db', MigrateCommand)

if __name__ == '__main__': 
  manager.run()

這個腳本開始于創(chuàng)建應(yīng)用程序。使用環(huán)境變量FLASK_CONFIG，若它已經(jīng)定義了則從中獲取配置；如果沒有，則是用默認配置。然后用于Python shell的Flask-Script、Flask-Migrate以及自定義上下文會被初始化。

為了方便，會增加一行執(zhí)行環(huán)境，這樣在基于Unix的操作系統(tǒng)上可以通過./manage.py來執(zhí)行腳本來替代冗長的python manage.py。

5、需求文件
應(yīng)用程序必須包含requirements.txt文件來記錄所有依賴包，包括精確的版本號。這很重要，因為可以在不同的機器上重新生成虛擬環(huán)境，例如在生產(chǎn)環(huán)境的機器上部署應(yīng)用程序。這個文件可以通過下面的pip命令自動生成：

(venv) $ pip freeze >requirements.txt

當安裝或更新一個包之后最好再更新一下這個文件。以下展示了一個需求文件示例：

Flask==0.10.1
Flask-Bootstrap==3.0.3.1
Flask-Mail==0.9.0
Flask-Migrate==1.1.0
Flask-Moment==0.2.0
Flask-SQLAlchemy==1.0
Flask-Script==0.6.6
Flask-WTF==0.9.4
Jinja2==2.7.1
Mako==0.9.1
MarkupSafe==0.18
SQLAlchemy==0.8.4
WTForms==1.0.5
Werkzeug==0.9.4
alembic==0.6.2
blinker==1.3
itsdangerous==0.23

當你需要完美復(fù)制一個虛擬環(huán)境的時候，你可以運行以下命令創(chuàng)建一個新的虛擬環(huán)境：

(venv) $ pip install -r requirements.txt

當你讀到這時，示例requirements.txt文件中的版本號可能已經(jīng)過時了。如果喜歡你可以嘗試用最近發(fā)布的包。如果遇到任何問題，你可以隨時回退到需求文件中與應(yīng)用兼容的指定版本。

6、單元測試
這個應(yīng)用非常小以至于不需要太多的測試，但是作為示例會在示例中展示兩個簡單的測試定義。

示例：tests/test_basics.py：單元測試

import unittest
from flask import current_app 
from app import create_app, db

class BasicsTestCase(unittest.TestCase): 
  def setUp(self):
    self.app = create_app('testing')
    self.app_context = self.app.app_context()
    self.app_context.push()
    db.create_all()

  def tearDown(self): 
    db.session.remove() 
    db.drop_all() 
    self.app_context.pop()

  def test_app_exists(self): 
    self.assertFalse(current_app is None)

  def test_app_is_testing(self): 
    self.assertTrue(current_app.config['TESTING'])

編寫好的測試使用的是來自于Python標準庫中標準的unittest包。setUp()和tearDown()方法在每個測試之前和之后運行，且任何一個方法必須以test_開頭作為測試來執(zhí)行。

建議：如果你想要學(xué)習(xí)更多使用Python的unittest包來寫單元測試的內(nèi)容，請參閱官方文檔。
setUp()方法嘗試創(chuàng)建一個測試環(huán)境，類似于運行應(yīng)用程序。首先它創(chuàng)建應(yīng)用程序配置用于測試并激活上下文。這一步確保測試可以和常規(guī)請求一樣訪問current_app。然后，當需要的時候，可以創(chuàng)建一個供測試使用的全新數(shù)據(jù)庫。數(shù)據(jù)庫和應(yīng)用程序上下文會在tearDown()方法中被移除。

第一個測試確保應(yīng)用程序?qū)嵗嬖凇５诙€測試確保應(yīng)用程序在測試配置下運行。為了確保tests目錄有效，需要在tests目錄下增加__init__.py文件，不過該文件可以為空，這樣unittest包可以掃描所有模塊并定位測試。

建議：如果你有克隆在GitHub上的應(yīng)用程序，你現(xiàn)在可以運行g(shù)it checkout 7a來切換到這個版本的應(yīng)用程序。為了確保你已經(jīng)安裝了所有依賴集，需要運行pip install -r requirements.txt。
為了運行單元測試，可以在manage.py腳本中增加一個自定義的命令。

下面展示如何添加測試命令。

示例：manage.pyt：單元測試啟動腳本

@manager.command
def test():
  """Run the unit tests."""
  import unittest
  tests = unittest.TestLoader().discover('tests') 
  unittest.TextTestRunner(verbosity=2).run(tests)

manager.command裝飾器使得它可以很容易的實現(xiàn)自定義命令。被裝飾的函數(shù)名可以被當做命令名使用，且函數(shù)的文檔字符串會顯示幫助信息。test()函數(shù)的執(zhí)行會調(diào)用unittest包中的測試運行器。

單元測試可以像下面這樣執(zhí)行：

(venv) $ python manage.py test

test_app_exists (test_basics.BasicsTestCase) ... ok
test_app_is_testing (test_basics.BasicsTestCase) ... ok

.----------------------------------------------------------------------
Ran 2 tests in 0.001s

OK

7、數(shù)據(jù)庫啟動
與單腳本的應(yīng)用相比，重構(gòu)后的應(yīng)用使用不同數(shù)據(jù)庫。

從環(huán)境變量中獲取的數(shù)據(jù)庫URL作為首選，默認SQLite數(shù)據(jù)庫作為可選。三個配置中的環(huán)境變量和SQLite數(shù)據(jù)庫文件名是不一樣的。例如，開發(fā)配置的URL是從DEV_DATABASE_URL環(huán)境變量中獲取，如果沒有定義則會使用名為data-dev.sqlite的SQLite數(shù)據(jù)庫。

無論數(shù)據(jù)庫URL源的是哪一個，都必須為新的數(shù)據(jù)庫創(chuàng)建數(shù)據(jù)庫表。如果使用了Flask-Migrate來保持遷移跟蹤，數(shù)據(jù)庫表可以被創(chuàng)建或更新到最近的版本通過下面的命令：

(venv) $ python manage.py db upgrade

相信與否，已經(jīng)到了第一部分結(jié)束的地方。你現(xiàn)在已經(jīng)學(xué)到了Flask必要的基本要素，但是你不確定如何將這些零散的知識組合在一起形成一個真正的應(yīng)用程序。第二部分的目的是通過開發(fā)一個完整的應(yīng)用程序來帶領(lǐng)你繼續(xù)前行。

最新評論