Flask中蓝图的使用——分模块开发(升级版)

Flask中要分模块开发，就需要用到蓝图--Blueprint，“蓝图”在Flask中是对路由的规划。本文简单介绍蓝图分模块(升级版)开发时的工程目录结构，不对蓝图的基本知识做介绍。

1.工程目录示例

• src ：该Web服务依赖的算法类，不做介绍
• service：Web服务主目录

工程目录

2. 升级版工程搭建思路说明

• Flask服务启动文件里面只存放与服务启动相关的内容；
• Settings配置文件里只放服务配置相关的内容；
• src算法模块只存放算法相关内容；
• apps模块存放与应用相关内容；
• 工厂模式：create_app()函数中定义主app构造相关内容，服务修改也主要在这里，实现工厂化生产；
• 各应用的视图文件中定义蓝图和该应用相关接口；
• 各应用中定义懒加载函数注册自己名下的蓝图；
• create_app()中注册各应用，能够实现分模块和插拔管理；
• 服务能够以命令行参数形式启动；
• 根据环境变量不同自动选择不同的配置文件；

3. Web服务具体代码示例

• server.py：Flask服务启动的文件

其中使用了flask_script包，使服务能够以命令行参数形式启动：
1) 安装包: pip install flask-script；
2) 初始化：manager = Manager(app=app)，创建管理对象；
3) 启动：启动时以manager.run()方式启动；

即：

# 命令行形式启动web服务
python server.py runserver -r -d -p 端口号 -h 主机ip

代码：

import os
import sys
sys.path.insert(0, os.path.abspath("../"))  # 将service目录添加至导包目录

from flask_script import Manager  # flask扩展包，使flask能够命令行参数运行应用

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

# 通过环境变量控制选择哪一个配置文件，方便各种环境切换
env = os.environ.get("FLASK_ENV", "develop")

# 创建主应用
app = create_app(env)

# 创建应用管理对象
manager = Manager(app=app)

# 实例化类(视图中会使用到这些类)
app.irqa = IRQA
app.faq = FAQ

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


if __name__ == '__main__':
    # 启动服务
    manager.run()

• service.apps._init_.py：其中定义了主app构造函数

在create_app()函数里完成配置信息配置、应用注册等相关操作

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")

    # 导入配置
    app.config.from_object(envs.get(env))

    # 注册应用
    register_irqa(app)
    register_faq(app)

    return app


if __name__ == '__main__':

    pass

• service.apps.faq._init_.py：应用1主要文件，其中通过定义函数的形式懒加载蓝图，这样既方便注册蓝图，又避免循环导包问题，

# 懒加载faq应用下的各个蓝图
from service.apps.faq.query_view import faq_bp


def register_faq(app):
    """
    懒加载该应用下蓝图
    :param app: 主应用
    :return: None
    """
    # 注册蓝图
    app.register_blueprint(faq_bp, url_prefix="/faq")

• service.apps.faq.query_view.py：应用1视图文件，其中定义应用1相关蓝图和具体视图

# “蓝图”、“current_app应用上下文”导入
from flask import Blueprint, current_app

# 蓝图创建
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: 应用2主要文件，其中也通过定义函数的形式懒加载蓝图，该应用总共定义了两个蓝图，这样对本应用中的接口也进行了分模块管理，

# 懒加载irqa应用下的各个蓝图
from service.apps.irqa.content_view import irqa_content_bp
from service.apps.irqa.query_view import irqa_query_bp


def register_irqa(app):
    """
    懒加载该应用下蓝图
    :param app: 主应用
    :return: None
    """
    # 注册蓝图
    app.register_blueprint(irqa_query_bp, url_prefix="/irqa")
    app.register_blueprint(irqa_content_bp, url_prefix="/irqa")

• service.apps.irqa.query_view.py：应用2视图文件1，其中定义应用2第一个蓝图和具体视图

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：应用2视图文件2，其中定义了第二个蓝图和具体视图，

from flask import Blueprint, current_app

irqa_content_bp = Blueprint("irqa_content", __name__)


@irqa_content_bp.route("/content", endpoint="irqa_content")
def index():
    return "获取指定内容"

• service.settings.py：Flask服务配置文件

# Flask配置文件


class DefaultConfig(object):
    """
    默认配置类
    """
    DEBUG = False
    TESTING = False


class DevelopConfig(DefaultConfig):
    """
    开发环境配置类
    """
    DEBUG = True
    # 其他配置


class TestingConfig(DefaultConfig):
    """
    测试环境配置类
    """
    Testing = True
    # 其他配置


class ShowingConfig(DefaultConfig):
    """
    演示环境配置类
    """
    # 其他配置


class ProductConfig(DefaultConfig):
    """
    生产环境配置类
    """
    DEBUG = False
    # 其他配置


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