前言：

在學(xué)習(xí)Falsk框架的時(shí)候發(fā)現(xiàn)了網(wǎng)上資源比較繁雜，而涉及到工程項(xiàng)目的文件配置和管理也是各有千秋。所以花了點(diǎn)時(shí)間專門整理一個(gè)配置項(xiàng)目工程目錄的文章，本篇文章從最初始化最簡(jiǎn)潔的Flask安裝樣例出發(fā)，從零開(kāi)始編寫代碼和配置文件，旨在幫助本人以及廣大讀者理解項(xiàng)目目錄文件之間的關(guān)系。

那么接下來(lái)就讓我們進(jìn)入到flask目錄配置的學(xué)習(xí)中。

首先這里我選擇pycharm進(jìn)行開(kāi)發(fā)，毋庸置疑，pycharm是最好最流行的python IDE，功能強(qiáng)大，方便實(shí)用。借助于使用virtualenv創(chuàng)建好的虛擬環(huán)境，開(kāi)始創(chuàng)建一個(gè)新的python空項(xiàng)目（這里不選擇直接使用flask框架創(chuàng)建項(xiàng)目）。

創(chuàng)建好一個(gè)空項(xiàng)目后，由我們自己手動(dòng)新建各部分所需文件目錄，并編寫原始代碼。在這之前，我們先來(lái)了解一下Flask程序的默認(rèn)（初始）結(jié)構(gòu)。

Flask框架默認(rèn)(初始)項(xiàng)目結(jié)構(gòu)

app.pyfrom flask import Flaskapp = Flask(__name__)?@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()

創(chuàng)建一個(gè)app.py 文件之后，寫下上面的代碼，點(diǎn)擊運(yùn)行?？梢缘玫揭韵陆缑妗?/p>

很顯然，程序運(yùn)行成功了。

現(xiàn)在我們來(lái)編寫一些配置所需要的代碼。

1.在單一文件中構(gòu)建所有依賴工具

manage.py

from flask import Flaskfrom flask_sqlalchemy import SQLAlchemyfrom flask_SESSION import Sessionfrom flask_wtf import CSRFProtect?import redis??app = Flask(__name__)??class BaseConfig(object): """配置信息""" DEBUG = True? SECRET_KEY = "sdsadafafsfsd@$%9"? # 數(shù)據(jù)庫(kù) SQLALCHEMY_DATABASE_URL = "mysql://root:mysql@127.0.0.1:3306/database_name" SQLALCHEMY_TRACK_MODIFICATIONS = True? # redis REDIS_HOST = "127.0.0.1" REDIS_PORT = 6379? # flask_session 配置 SESSION_TYPE = "redis" SESSION_REDIS = redis.StrictRedis(host=REDIS_HOST,port=REDIS_PORT) # 若是上線運(yùn)行，此處可能是另一臺(tái)redis服務(wù)器 session_USE_SIGNER = True # 對(duì)cookie中session_id 進(jìn)行隱藏處理 SESSION_SESSION_LIFETIME = 86400 # session數(shù)據(jù)的有效期，單位 秒??app.config.from_object(Config)?# 數(shù)據(jù)庫(kù)db = SQLAlchemy(app)?# 創(chuàng)建redis連接對(duì)象redis_store = redis.StrictRedis(host=BaseConfig.REDIS_HOST,port=BaseConfig.REDIS_PORT)?# 利用flask-session，將session數(shù)據(jù)保存到redis中Session(app)?# 為flask補(bǔ)充csrf防護(hù)CSRFProtect(app)??@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()

2.(自定義)創(chuàng)建工程目錄

在實(shí)際生產(chǎn)中，我們將單一配置文件中的依賴工具和功能提取抽離出來(lái)，寫到不同的模塊中，便于代碼的管理和復(fù)用

2.1 第一次抽取

（1）第一次的抽取，先用工廠模式將app的創(chuàng)建抽離出來(lái)，并分匹配【配置模式】，將【配置模式】作為 類 來(lái)傳遞

config.py

# 所有的配置項(xiàng)都放到config.py中# flask的配置項(xiàng)目，名字都是大寫字母?import redis?class BaseConfig(object): DEBUG = True? # 秘鑰 SECRET_KEY = "sdsadafafsfsd@$%9"? # 數(shù)據(jù)庫(kù) SQLALCHEMY_DATABASE_URL = "mysql://root:mysql@127.0.0.1:3306/database_name" SQLALCHEMY_TRACK_MODIFICATIONS = True? # redis REDIS_HOST = "127.0.0.1" REDIS_PORT = 6379? # flask_session 配置 SESSION_TYPE = "redis" SESSION_REDIS = redis.StrictRedis(host=REDIS_HOST,port=REDIS_PORT) # 若是上線運(yùn)行，此處可能是另一臺(tái)redis服務(wù)器 SESSION_USE_SIGNER = True # 對(duì)cookie中session_id 進(jìn)行隱藏處理 SESSION_SESSION_LIFETIME = 86400 # session數(shù)據(jù)的有效期，單位 秒??# 發(fā)行環(huán)境class ProductionConfig(BaseConfig): DEBUG = False??# 開(kāi)發(fā)環(huán)境class DevelopmentConfig(BaseConfig): DEBUG = True??# 測(cè)試環(huán)境class TestingConfig(BaseConfig): pass??# 配置信息config_map = { 'develop': DevelopmentConfig, 'product': ProductionConfig, 'test': TestingConfig}

（2）第一次抽取后的manage.py 文件還剩下

manage.py

from flask import Flaskfrom flask_sqlalchemy import SQLAlchemyfrom flask_session import Sessionfrom flask_wtf import csrfProtectfrom config import config_map?import redis??# 工廠模式def create_app(config_name): """ 創(chuàng)建flask的應(yīng)用對(duì)象 :param config_name: str 配置模式的 模式的名字 ("develop","product") :return: """ app = Flask(__name__)? # 獲取配置模式的名字，獲取配置參數(shù)的類 config_class = config_map.get(config_name) app.config.from_object(config_class)? return app??app = create_app('develop')?# 數(shù)據(jù)庫(kù)db = SQLAlchemy(app)?# 創(chuàng)建redis連接對(duì)象redis_store = redis.StrictRedis(host=Config.REDIS_HOST,port=Config.REDIS_PORT)?# 利用flask-session，將session數(shù)據(jù)保存到redis中Session(app)?# 為flask補(bǔ)充csrf防護(hù)CSRFProtect(app)??@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()

2.2 第二次抽取

（1）第二次抽取，首先在項(xiàng)目根目錄創(chuàng)建一個(gè)新的 文件夾app，在app文件夾下創(chuàng)建–init–.py、models.py、views.py文件。

（2）將工廠模式函數(shù)create_app復(fù)制到–init–.py文件，同時(shí)將 數(shù)據(jù)庫(kù)初始化/實(shí)例化 app應(yīng)用程序的代碼抽離過(guò)來(lái)，如下：

（3）此時(shí)有一個(gè)問(wèn)題，db = SQLAlchemy(app) 中 app還沒(méi)有被創(chuàng)建，當(dāng)然我們可以導(dǎo)入manage模塊來(lái)解決這個(gè)問(wèn)題，如下

import manage# 數(shù)據(jù)庫(kù)db = SQLAlchemy(manage.app)

但這樣很明顯就失去了一開(kāi)始想要分隔抽離代碼功能的作用，所以這里采用以下方法解決：

先創(chuàng)建SQLAlchemy對(duì)象，但不進(jìn)行賦值，而后在工廠函數(shù)中進(jìn)行賦值。

——init——.py

from flask import Flaskfrom config import config_mapfrom flask_sqlalchemy import SQLAlchemy??# 數(shù)據(jù)庫(kù) 初始化關(guān)聯(lián)appdb = SQLAlchemy()??# 工廠模式def create_app(config_name): """ 創(chuàng)建flask的應(yīng)用對(duì)象 :param config_name: str 配置模式的 模式的名字 ("develop","product") :return: """ app = Flask(__name__)? # 獲取配置模式的名字，獲取配置參數(shù)的類 config_class = config_map.get(config_name) app.config.from_object(config_class)? # db初始化關(guān)聯(lián)app過(guò)程 # 使用app初始化db db.init_app(app)? return app

manage.py

from flask_session import Sessionfrom flask_wtf import CSRFProtect?import redis?from app import create_app??app = create_app('develop')?# 創(chuàng)建redis連接對(duì)象redis_store = redis.StrictRedis(host=Config.REDIS_HOST,port=Config.REDIS_PORT)?# 利用flask-session，將session數(shù)據(jù)保存到redis中Session(app)?# 為flask補(bǔ)充csrf防護(hù)CSRFProtect(app)??@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()

2.3 第三次抽取

（1）這里將redis連接對(duì)象也抽取到–init–.py文件中，和上一個(gè)抽取中的db一樣，其他模塊中的代碼也會(huì)使用到redis，所以這里db、redis不能放在工廠函數(shù)中，否則會(huì)導(dǎo)致其他模塊導(dǎo)包是無(wú)法導(dǎo)入。

（2）設(shè)置全局變量redis_store = None，然后在工廠函數(shù)中再進(jìn)行初始化。

2.4 第四次抽取

（1）第四次抽取，將session和csrf兩個(gè)功能同樣抽取到–init–.py文件中，因?yàn)閟ession和csrf是Flask的補(bǔ)充功能，在程序執(zhí)行中只需要初始化一次以修改 flask機(jī)制或引入該功能，初始化對(duì)象后，后續(xù)操作直接在視圖函數(shù)中使用flask自己的全局對(duì)象session和flask_wtf中csrf生成的內(nèi)容就可以了，并不使用Session(app)、CSRFProtect(app)對(duì)象。

因此，將Session(app)、CSRFProtect(app)對(duì)象直接寫在工廠函數(shù)中，創(chuàng)建時(shí)初始化一次就可以了。

manage.py

from app import create_app??app = create_app('develop')???@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()

–init–.py

from flask import Flaskfrom config import config_mapfrom flask_sqlalchemy import SQLAlchemyfrom flask_session import Sessionfrom flask_wtf import CSRFProtect?import redis?# 數(shù)據(jù)庫(kù) 初始化關(guān)聯(lián)appdb = SQLAlchemy()?# 創(chuàng)建redis連接對(duì)象redis_store = None??# 工廠模式def create_app(config_name): """ 創(chuàng)建flask的應(yīng)用對(duì)象 :param config_name: str 配置模式的 模式的名字 ("develop","product") :return: """ app = Flask(__name__)? # 獲取配置模式的名字，獲取配置參數(shù)的類 config_class = config_map.get(config_name) app.config.from_object(config_class)? # db初始化關(guān)聯(lián)app過(guò)程 db.init_app(app)? # 初始化redis工具 global redis_store redis_store = redis.StrictRedis(host=config_class.REDIS_HOST, port=config_class.REDIS_PORT)? # 利用flask-session，將session數(shù)據(jù)保存到redis中 Session(app)? # 為flask補(bǔ)充csrf防護(hù) CSRFProtect(app)? return app

好了，到此將項(xiàng)目目錄文件的一些基本配置完成了。接下來(lái)需要引入Flask藍(lán)圖的概念，繼續(xù)進(jìn)行代碼分離，以及一些需要修改的地方，且放到下一篇文章來(lái)講。