緣由
Python在AI,AR VR這塊使用越來(lái)越廣泛矿微。同時(shí)在Web方面也有很多成熟的框架。而我本身由于使用
Flask 比較多念搬，個(gè)人認(rèn)為就是比較簡(jiǎn)單抑堡，容易入手，可定制化強(qiáng)朗徊。這里我將我經(jīng)過(guò)多個(gè)項(xiàng)目多次迭代的
自認(rèn)為還可以的框架結(jié)構(gòu)整理出來(lái)夷野。方便自己可以更容易創(chuàng)建新項(xiàng)目。
目錄結(jié)構(gòu)
.
├── api api存放
│ ├── controllers 所有的C層放在這里
│ ├── interceptors 攔截器相關(guān)
├── application.py 封裝的Flask的全局變量荣倾，包括app悯搔，數(shù)據(jù)庫(kù)等
├── common 存放公用部分
│ ├── libs 公用方法或者類
│ ├── models 所有的數(shù)據(jù)庫(kù)model
├── config 配置文件
│ ├── base_setting.py 基礎(chǔ)配置
│ ├── develop_setting.py 開發(fā)環(huán)境
│ ├── local_setting_demo.py 本地開發(fā)環(huán)境配置demo
│ └── production_setting.py 生產(chǎn)環(huán)境的配置
├── docs 文檔存放
│ ├── Mysql.md 所有數(shù)據(jù)庫(kù)變更必須在這里記錄
├── jobs 定時(shí)任務(wù)
│ ├── bin
│ └── tasks 所有定時(shí)任務(wù)都存放在這里
├── router 路由配置入口
│ ├── www.py 對(duì)應(yīng)web的路由配置
│ └── api.py 對(duì)應(yīng)api的路由配置
├── manage_web.py web啟動(dòng)入口
├── manage_job.py job定時(shí)器啟動(dòng)入口
├── manage_api.py api啟動(dòng)入口 (如果有api的話)
├── requirements.txt python 擴(kuò)展
├── uwsgi.ini 生產(chǎn)環(huán)境uwsgi
├── web HTTP存放
│ ├── controllers 所有的C層放在這里
│ ├── interceptors 攔截器相關(guān)
│ ├── static 靜態(tài)文件
│ └── templates 模板文件
功能特性
目錄結(jié)構(gòu)分層
相信代碼分層很多人都聽說(shuō)。但是未必都能理解這樣做會(huì)有什么好處舌仍。對(duì)于小型項(xiàng)目可能分不分不會(huì)有什么太大的問(wèn)題妒貌，但是如果對(duì)于一個(gè)大型項(xiàng)目，分層就會(huì)帶來(lái)特別明顯的好處铸豁。大家翻閱代碼知道去什么地方找灌曙，讓開發(fā)和維護(hù)更加簡(jiǎn)潔。
多環(huán)境配置隔離
flask默認(rèn)官方是有環(huán)境配置隔離方法的节芥，我個(gè)人覺得官方的方式不太好在刺，所以就結(jié)合以前使用php和在實(shí)際開發(fā)和運(yùn)維當(dāng)做自己規(guī)定了一套方案。如下 通過(guò)不同的配置文件做到多環(huán)境覆蓋
例如 develop 可以是開發(fā)環(huán)境头镊，production 是 生產(chǎn)環(huán)境蚣驼，還可以增加test 為測(cè)試環(huán)境
通過(guò)環(huán)境變量ops_config 來(lái)進(jìn)行切換
├── config 配置文件
│ ├── base_setting.py 基礎(chǔ)配置
│ ├── develop_setting.py 開發(fā)環(huán)境
│ ├── local_setting_demo.py 本地開發(fā)環(huán)境配置demo
│ └── production_setting.py 生產(chǎn)環(huán)境的配置
支持多APP模式
很多情況我們可能要開發(fā)好幾個(gè)應(yīng)用，只有一個(gè)滿足不了我們的需求相艇。例如增加一個(gè)api颖杏，增加一個(gè)admin 都有可能。為了滿足這種情況我就做了定制化架構(gòu)坛芽。
通過(guò)不同的入口來(lái)決定不同的應(yīng)用
├── api api存放
│ ├── controllers 所有的C層放在這里
│ ├── interceptors 攔截器相關(guān)
├── router 路由配置入口
│ ├── www.py 對(duì)應(yīng)web的路由配置
│ └── api.py 對(duì)應(yīng)api的路由配置
├── manage_web.py web啟動(dòng)入口
├── manage_api.py api啟動(dòng)入口 (如果有api的話)
├── web HTTP存放
│ ├── controllers 所有的C層放在這里
│ ├── interceptors 攔截器相關(guān)
│ ├── static 靜態(tài)文件
│ └── templates 模板文件
支持定時(shí)器
為了方便我們寫定時(shí)器留储，我自己寫了一個(gè)簡(jiǎn)單的腳手架。方便使用咙轩。網(wǎng)上也有很多其他的定時(shí)器插件获讳。但是從我時(shí)間實(shí)踐得來(lái)，定時(shí)器當(dāng)成一個(gè)獨(dú)立的應(yīng)用會(huì)更好活喊，不要和其他應(yīng)用有任何耦合最好丐膝。
├── jobs 定時(shí)任務(wù)
│ ├── bin
│ └── tasks 所有定時(shí)任務(wù)都存放在這里
├── manage_job.py job定時(shí)器啟動(dòng)入口
快速使用
- github：https://github.com/apanly/python3_flask_frame
- 碼云：https://gitee.com/apanly/python3_flask_frame
相關(guān)截圖
