Flask中要分模块开发，就需要用到蓝图--Blueprint，“蓝图”在Flask中是对路由的规划。本文简单介绍蓝图分模块开发时的工程目录结构，不对蓝图的基本知识做介绍。
1.工程目录示例
- src ：该Web服务依赖的算法类，不做介绍
- service：Web服务主目录
工程目录
2. 工程搭建思路说明
- Flask服务启动文件里面只存放与服务启动相关的内容；
- Settings配置文件里只放服务配置相关的内容；
- src算法模块只存放算法相关内容；
- apps模块存放与应用相关内容；
- 工厂模式：create_app()函数中定义主app构造相关内容，服务修改也主要在这里，实现工厂化生产；
- 各应用的视图文件中定义蓝图和该应用相关接口；
- create_app()中注册各蓝图，能够实现分模块管理和插拔管理；
3. Web服务具体代码示例
-
server.py：Flask服务启动的文件
即：
# 启动web服务
python server.py
代码：
from service.apps import create_app
from src.my_class import IRQA, FAQ
# 通过环境变量控制选择哪一个配置文件，方便各种环境切换
env = os.environ.get("FLASK_ENV", "develop")
# 主应用构造
app = create_app(env)
# 实例化类(服务接口中会使用到类，以实现指定功能)
app.irqa = IRQA
app.faq = FAQ
# 首页，可以不在此处
@app.route("/")
def index():
return "Welcome to MyProject"
if __name__ == '__main__':
# 启动服务
app.run()
- service.apps._init_.py：其中定义了主app构造函数
在create_app()函数里完成配置信息配置、蓝图注册等相关操作
from flask import Flask
from service.apps.faq.query_view import faq_bp
from service.apps.irqa.query_view import irqa_bp
from service.settings import Develop
def create_app(env):
"""
主app构造函数
"""
app = Flask(__name__, template_folder="../data")
# 导入配置
app.config.from_object(envs.get(env))
# 注册蓝图
app.register_blueprint(irqa_bp, url_prefix="/irqa")
app.register_blueprint(faq_bp, url_prefix="/faq")
return app
if __name__ == '__main__':
pass
- 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.query_view.py：应用2视图文件，其中定义应用2相关蓝图和具体视图
# 相关包导入
from flask import Blueprint, current_app
# 蓝图构建
irqa_bp = Blueprint("irqa", __name__)
# 视图定义
@irqa_bp.route("/index", endpoint="irqa_index")
def index():
# 使用到算法类irqa
return current_app.irqa.name
- 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
}
网友评论