前言:
在學(xué)習(xí)Falsk框架的時候發(fā)現(xiàn)了網(wǎng)上資源比較繁雜,而涉及到工程項目的文件配置和管理也是各有千秋。所以花了點時間專門整理一個配置項目工程目錄的文章,本篇文章從最初始化最簡潔的Flask安裝樣例出發(fā),從零開始編寫代碼和配置文件,旨在幫助本人以及廣大讀者理解項目目錄文件之間的關(guān)系。
那么接下來就讓我們進入到flask目錄配置的學(xué)習(xí)中。
首先這里我選擇pycharm進行開發(fā),毋庸置疑,pycharm是最好最流行的python IDE,功能強大,方便實用。借助于使用virtualenv創(chuàng)建好的虛擬環(huán)境,開始創(chuàng)建一個新的python空項目(這里不選擇直接使用flask框架創(chuàng)建項目)。
創(chuàng)建好一個空項目后,由我們自己手動新建各部分所需文件目錄,并編寫原始代碼。在這之前,我們先來了解一下Flask程序的默認(初始)結(jié)構(gòu)。
Flask框架默認(初始)項目結(jié)構(gòu)
app.pyfrom flask import Flaskapp = Flask(__name__)?@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()
創(chuàng)建一個app.py 文件之后,寫下上面的代碼,點擊運行。可以得到以下界面。
很顯然,程序運行成功了。
現(xiàn)在我們來編寫一些配置所需要的代碼。
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ù)庫 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) # 若是上線運行,此處可能是另一臺redis服務(wù)器 session_USE_SIGNER = True # 對cookie中session_id 進行隱藏處理 SESSION_SESSION_LIFETIME = 86400 # session數(shù)據(jù)的有效期,單位 秒??app.config.from_object(Config)?# 數(shù)據(jù)庫db = SQLAlchemy(app)?# 創(chuàng)建redis連接對象redis_store = redis.StrictRedis(host=BaseConfig.REDIS_HOST,port=BaseConfig.REDIS_PORT)?# 利用flask-session,將session數(shù)據(jù)保存到redis中Session(app)?# 為flask補充csrf防護CSRFProtect(app)??@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()
2.(自定義)創(chuàng)建工程目錄
在實際生產(chǎn)中,我們將單一配置文件中的依賴工具和功能提取抽離出來,寫到不同的模塊中,便于代碼的管理和復(fù)用
2.1 第一次抽取
(1)第一次的抽取,先用工廠模式將app的創(chuàng)建抽離出來,并分匹配【配置模式】,將【配置模式】作為 類 來傳遞
config.py
# 所有的配置項都放到config.py中# flask的配置項目,名字都是大寫字母?import redis?class BaseConfig(object): DEBUG = True? # 秘鑰 SECRET_KEY = "sdsadafafsfsd@$%9"? # 數(shù)據(jù)庫 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) # 若是上線運行,此處可能是另一臺redis服務(wù)器 SESSION_USE_SIGNER = True # 對cookie中session_id 進行隱藏處理 SESSION_SESSION_LIFETIME = 86400 # session數(shù)據(jù)的有效期,單位 秒??# 發(fā)行環(huán)境class ProductionConfig(BaseConfig): DEBUG = False??# 開發(fā)環(huán)境class DevelopmentConfig(BaseConfig): DEBUG = True??# 測試環(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)用對象 :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ù)庫db = SQLAlchemy(app)?# 創(chuàng)建redis連接對象redis_store = redis.StrictRedis(host=Config.REDIS_HOST,port=Config.REDIS_PORT)?# 利用flask-session,將session數(shù)據(jù)保存到redis中Session(app)?# 為flask補充csrf防護CSRFProtect(app)??@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()
2.2 第二次抽取
(1)第二次抽取,首先在項目根目錄創(chuàng)建一個新的 文件夾app,在app文件夾下創(chuàng)建–init–.py、models.py、views.py文件。
(2)將工廠模式函數(shù)create_app復(fù)制到–init–.py文件,同時將 數(shù)據(jù)庫初始化/實例化 app應(yīng)用程序的代碼抽離過來,如下:
(3)此時有一個問題,db = SQLAlchemy(app) 中 app還沒有被創(chuàng)建,當然我們可以導(dǎo)入manage模塊來解決這個問題,如下
import manage# 數(shù)據(jù)庫db = SQLAlchemy(manage.app)
但這樣很明顯就失去了一開始想要分隔抽離代碼功能的作用,所以這里采用以下方法解決:
先創(chuàng)建SQLAlchemy對象,但不進行賦值,而后在工廠函數(shù)中進行賦值。
——init——.py
from flask import Flaskfrom config import config_mapfrom flask_sqlalchemy import SQLAlchemy??# 數(shù)據(jù)庫 初始化關(guān)聯(lián)appdb = SQLAlchemy()??# 工廠模式def create_app(config_name): """ 創(chuàng)建flask的應(yīng)用對象 :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過程 # 使用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連接對象redis_store = redis.StrictRedis(host=Config.REDIS_HOST,port=Config.REDIS_PORT)?# 利用flask-session,將session數(shù)據(jù)保存到redis中Session(app)?# 為flask補充csrf防護CSRFProtect(app)??@app.route('/')def index(): return 'Hello Flask'??if __name__ == '__main__': app.run()
2.3 第三次抽取
(1)這里將redis連接對象也抽取到–init–.py文件中,和上一個抽取中的db一樣,其他模塊中的代碼也會使用到redis,所以這里db、redis不能放在工廠函數(shù)中,否則會導(dǎo)致其他模塊導(dǎo)包是無法導(dǎo)入。
(2)設(shè)置全局變量redis_store = None,然后在工廠函數(shù)中再進行初始化。
2.4 第四次抽取
(1)第四次抽取,將session和csrf兩個功能同樣抽取到–init–.py文件中,因為session和csrf是Flask的補充功能,在程序執(zhí)行中只需要初始化一次以修改 flask機制或引入該功能,初始化對象后,后續(xù)操作直接在視圖函數(shù)中使用flask自己的全局對象session和flask_wtf中csrf生成的內(nèi)容就可以了,并不使用Session(app)、CSRFProtect(app)對象。
因此,將Session(app)、CSRFProtect(app)對象直接寫在工廠函數(shù)中,創(chuàng)建時初始化一次就可以了。
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ù)庫 初始化關(guān)聯(lián)appdb = SQLAlchemy()?# 創(chuàng)建redis連接對象redis_store = None??# 工廠模式def create_app(config_name): """ 創(chuàng)建flask的應(yīng)用對象 :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過程 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補充csrf防護 CSRFProtect(app)? return app
好了,到此將項目目錄文件的一些基本配置完成了。接下來需要引入Flask藍圖的概念,繼續(xù)進行代碼分離,以及一些需要修改的地方,且放到下一篇文章來講。
版權(quán)聲明:本文內(nèi)容由互聯(lián)網(wǎng)用戶自發(fā)貢獻,該文觀點僅代表作者本人。本站僅提供信息存儲空間服務(wù),不擁有所有權(quán),不承擔(dān)相關(guān)法律責(zé)任。如發(fā)現(xiàn)本站有涉嫌抄襲侵權(quán)/違法違規(guī)的內(nèi)容, 請發(fā)送郵件至 舉報,一經(jīng)查實,本站將立刻刪除。