Flask中要分模塊開發(fā)，就需要用到藍(lán)圖--Blueprint，“藍(lán)圖”在Flask中是對(duì)路由的規(guī)劃。本文簡單介紹藍(lán)圖分模塊(升級(jí)版)開發(fā)時(shí)的工程目錄結(jié)構(gòu)，不對(duì)藍(lán)圖的基本知識(shí)做介紹。

1.工程目錄示例

• src ：該Web服務(wù)依賴的算法類，不做介紹
• service：Web服務(wù)主目錄

工程目錄

2. 升級(jí)版工程搭建思路說明

• Flask服務(wù)啟動(dòng)文件里面只存放與服務(wù)啟動(dòng)相關(guān)的內(nèi)容；
• Settings配置文件里只放服務(wù)配置相關(guān)的內(nèi)容；
• src算法模塊只存放算法相關(guān)內(nèi)容；
• apps模塊存放與應(yīng)用相關(guān)內(nèi)容；
• 工廠模式：create_app()函數(shù)中定義主app構(gòu)造相關(guān)內(nèi)容，服務(wù)修改也主要在這里，實(shí)現(xiàn)工廠化生產(chǎn)；
• 各應(yīng)用的視圖文件中定義藍(lán)圖和該應(yīng)用相關(guān)接口；
• 各應(yīng)用中定義懶加載函數(shù)注冊自己名下的藍(lán)圖；
• create_app()中注冊各應(yīng)用，能夠?qū)崿F(xiàn)分模塊和插拔管理；
• 服務(wù)能夠以命令行參數(shù)形式啟動(dòng)；
• 根據(jù)環(huán)境變量不同自動(dòng)選擇不同的配置文件；

3. Web服務(wù)具體代碼示例

• server.py：Flask服務(wù)啟動(dòng)的文件

其中使用了flask_script包，使服務(wù)能夠以命令行參數(shù)形式啟動(dòng)：
1) 安裝包: pip install flask-script；
2) 初始化：manager = Manager(app=app)，創(chuàng)建管理對(duì)象；
3) 啟動(dòng)：啟動(dòng)時(shí)以manager.run()方式啟動(dòng)；

即：

# 命令行形式啟動(dòng)web服務(wù)
python server.py runserver -r -d -p 端口號(hào) -h 主機(jī)ip

代碼：

import os
import sys
sys.path.insert(0, os.path.abspath("../"))  # 將service目錄添加至導(dǎo)包目錄

from flask_script import Manager  # flask擴(kuò)展包，使flask能夠命令行參數(shù)運(yùn)行應(yīng)用

from service.apps import create_app
from src.my_class import IRQA, FAQ

# 通過環(huán)境變量控制選擇哪一個(gè)配置文件，方便各種環(huán)境切換
env = os.environ.get("FLASK_ENV", "develop")

# 創(chuàng)建主應(yīng)用
app = create_app(env)

# 創(chuàng)建應(yīng)用管理對(duì)象
manager = Manager(app=app)

# 實(shí)例化類(視圖中會(huì)使用到這些類)
app.irqa = IRQA
app.faq = FAQ

# 首頁接口，可以不放在這里
@app.route("/")
def index():
    return "Welcome to MyProject"


if __name__ == '__main__':
    # 啟動(dòng)服務(wù)
    manager.run()

• service.apps._init_.py：其中定義了主app構(gòu)造函數(shù)

在create_app()函數(shù)里完成配置信息配置、應(yīng)用注冊等相關(guān)操作

from flask import Flask

from service.apps.faq import register_faq
from service.apps.irqa import register_irqa
from service.settings import envs


def create_app(env):

    app = Flask(__name__, template_folder="../data")

    # 導(dǎo)入配置
    app.config.from_object(envs.get(env))

    # 注冊應(yīng)用
    register_irqa(app)
    register_faq(app)

    return app


if __name__ == '__main__':

    pass

• service.apps.faq._init_.py：應(yīng)用1主要文件，其中通過定義函數(shù)的形式懶加載藍(lán)圖，這樣既方便注冊藍(lán)圖，又避免循環(huán)導(dǎo)包問題，

# 懶加載faq應(yīng)用下的各個(gè)藍(lán)圖
from service.apps.faq.query_view import faq_bp


def register_faq(app):
    """
    懶加載該應(yīng)用下藍(lán)圖
    :param app: 主應(yīng)用
    :return: None
    """
    # 注冊藍(lán)圖
    app.register_blueprint(faq_bp, url_prefix="/faq")

• service.apps.faq.query_view.py：應(yīng)用1視圖文件，其中定義應(yīng)用1相關(guān)藍(lán)圖和具體視圖

# “藍(lán)圖”、“current_app應(yīng)用上下文”導(dǎo)入
from flask import Blueprint, current_app

# 藍(lán)圖創(chuàng)建
faq_bp = Blueprint("faq", __name__)

# 視圖定義
@faq_bp.route("/index", endpoint="faq_index")
def index():
    
    #  使用到算法類faq
    result = current_app.faq.name
    return result

• service.apps.irqa._init_.py: 應(yīng)用2主要文件，其中也通過定義函數(shù)的形式懶加載藍(lán)圖，該應(yīng)用總共定義了兩個(gè)藍(lán)圖，這樣對(duì)本應(yīng)用中的接口也進(jìn)行了分模塊管理，

# 懶加載irqa應(yīng)用下的各個(gè)藍(lán)圖
from service.apps.irqa.content_view import irqa_content_bp
from service.apps.irqa.query_view import irqa_query_bp


def register_irqa(app):
    """
    懶加載該應(yīng)用下藍(lán)圖
    :param app: 主應(yīng)用
    :return: None
    """
    # 注冊藍(lán)圖
    app.register_blueprint(irqa_query_bp, url_prefix="/irqa")
    app.register_blueprint(irqa_content_bp, url_prefix="/irqa")

• service.apps.irqa.query_view.py：應(yīng)用2視圖文件1，其中定義應(yīng)用2第一個(gè)藍(lán)圖和具體視圖

from flask import Blueprint, current_app

irqa_query_bp = Blueprint("irqa_query", __name__)


@irqa_query_bp.route("/index", endpoint="irqa_index")
def index():
    # 使用到了算法類irqa
    return current_app.irqa.name

• service.apps.irqa.content_view.py：應(yīng)用2視圖文件2，其中定義了第二個(gè)藍(lán)圖和具體視圖，

from flask import Blueprint, current_app

irqa_content_bp = Blueprint("irqa_content", __name__)


@irqa_content_bp.route("/content", endpoint="irqa_content")
def index():
    return "獲取指定內(nèi)容"

• service.settings.py：Flask服務(wù)配置文件

# Flask配置文件


class DefaultConfig(object):
    """
    默認(rèn)配置類
    """
    DEBUG = False
    TESTING = False


class DevelopConfig(DefaultConfig):
    """
    開發(fā)環(huán)境配置類
    """
    DEBUG = True
    # 其他配置


class TestingConfig(DefaultConfig):
    """
    測試環(huán)境配置類
    """
    Testing = True
    # 其他配置


class ShowingConfig(DefaultConfig):
    """
    演示環(huán)境配置類
    """
    # 其他配置


class ProductConfig(DefaultConfig):
    """
    生產(chǎn)環(huán)境配置類
    """
    DEBUG = False
    # 其他配置


envs = {
    "develop": DevelopConfig,
    "testing": TestingConfig,
    "showing": ShowingConfig,
    "product": ProductConfig,
    "default": DevelopConfig
}