Flask应用工厂模式下flask run启动访问根路径返回404错误
根路径404问题根源与合规实现方案
问题核心成因
你当前代码的核心问题是生成了3个完全隔离的Flask应用实例,而非同一个应用的共享上下文,具体拆分如下:
flask run命令启动服务时,识别的应用实例是根目录sf.py中create_app()返回的实例,这个实例从生成到启动,全程没有绑定任何路由规则,访问根路径自然返回404- 你在
app/routes.py中在模块顶层调用create_app(),生成了第二个完全独立的Flask实例,把/根路由注册到了这个没有被任何服务启动的实例上 - 你在
clients/client.py中又第三次调用create_app(),生成了第三个独立的Flask实例,仅用于MQTT客户端的数据库上下文
三个实例完全隔离,路由绑定的实例和对外提供服务的实例不是同一个,404属于必然结果。
另外app/__init__.py末尾导入routes模块的逻辑,因为routes模块自己生成了独立实例,根本没有把路由注册到工厂方法对外返回的app上,进一步加剧了实例不匹配的问题。
符合Flask应用工厂模式的修复步骤
1. 调整路由模块的实现,禁止在路由文件中生成独立app
- 删除
app/routes.py里模块顶层app = create_app()的逻辑,把路由注册逻辑封装成接收app实例的初始化函数,避免生成独立实例:
from flask import request, jsonify from app.models import Area, Sensor, Monitoring from flask.views import MethodView # 移除原有的模块级app生成逻辑 def init_routes(app): @app.route('/') def hello_world(): return 'Hello, World!'
2. 重构create_app工厂方法,支持配置传入,统一实例生成逻辑
- 修改
app/__init__.py的工厂函数,在内部统一完成数据库初始化、路由注册逻辑,同时预留配置传入接口,满足不同环境的配置分离需求:
from flask import Flask from .models import db POSTGRES = { 'user': 'sf', 'pw': 'sf', 'db': 'sf', 'host': 'localhost', 'port': '5432', } def create_app(config_object=None): app = Flask(__name__) # 加载默认开发环境配置 app.config['DEBUG'] = True app.config['SQLALCHEMY_DATABASE_URI'] = 'postgresql://%(user)s:%(pw)s@%(host)s:%(port)s/%(db)s' % POSTGRES app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False # 如果传入了自定义配置(比如测试环境配置),直接覆盖默认值 if config_object: app.config.from_object(config_object) # 统一初始化数据库绑定 db.init_app(app) # 统一注册路由,不再通过末尾import触发 from .routes import init_routes init_routes(app) return app
3. 调整服务入口文件,向flask run暴露正确的应用实例
- 修改根目录
sf.py,把工厂返回的app实例赋值给顶级变量,让flask run能正确识别启动:
from app import create_app # 把工厂生成的实例赋值给app变量,flask run会自动识别 app = create_app()
4. 重构MQTT客户端的上下文逻辑,避免生成独立app
- 删除
clients/client.py里模块顶层app = create_app()的独立实例生成逻辑,改成类初始化时接收外部传入的Flask app实例,复用同一个应用的上下文:
from paho.mqtt.client import Client import json from app.models import db, Monitoring # 移除原有的模块级app生成逻辑 class CustomClient(Client): def __init__(self, flask_app): super().__init__() self.flask_app = flask_app def add_reading(self, reading): # 使用传入的app上下文执行数据库操作 with self.flask_app.app_context(): db.session.add(reading) db.session.commit() def on_connect(self, client, userdata, flags, rc): print( "Connected:", str(client._host) + ":" + str(client._port) ) def on_subscribe(self, mqttc, obj, mid, granted_qos): print( "Subscribed:", str(mid), str(granted_qos) ) def on_message(self, client, userdata, message): msg = message.payload.decode() print(message.topic, msg) data = json.loads(msg) reading = Monitoring(**data) self.add_reading(reading) def run(self): self.connect("localhost", 1883, 60) self.subscribe("Main/#", 0) self.loop_forever()
- 在MQTT客户端的启动脚本(比如根目录
run_client.py)中,导入统一的app实例,传给CustomClient类初始化:
from app import create_app from clients.client import CustomClient if __name__ == '__main__': app = create_app() mqtt_client = CustomClient(app) mqtt_client.run()
测试配置分离的实现
- 不需要在各个模块中手动生成不同的app实例,只需要给
create_app工厂方法传入独立的测试配置对象即可实现环境隔离,比如专门定义测试配置类:
# app/config.py class TestConfig: TESTING = True SQLALCHEMY_DATABASE_URI = 'sqlite:///:memory:' # 用内存数据库做测试,不依赖正式环境的PostgreSQL SQLALCHEMY_TRACK_MODIFICATIONS = False
- 写测试用例的时候,调用
create_app(TestConfig)就能生成完全独立的测试环境app,不会和开发、生产环境的配置互相干扰,也不会出现多实例的上下文混乱问题。
常见踩坑提醒
- 不要在路由、客户端等业务模块的顶层代码中直接调用
create_app(),这种写法会在模块被导入时就生成独立的app实例,和工厂对外返回的实例完全隔离,是多实例问题的根源 flask run只会识别入口文件中暴露的顶级app变量,如果调用create_app()但不把返回值赋值给变量,框架无法定位到可启动的WSGI服务实例- 同一个SQLAlchemy的db对象不要绑定多个独立的Flask实例,否则会出现会话上下文找不到、数据库操作失效的问题。
内容的提问来源于stack exchange,提问作者Edoardo Zucchelli
相关产品推荐
相关产品推荐

