
在开发基于flask和sqlalchemy的rest api时,我们经常需要执行一些不在web请求生命周期内的数据库操作,例如:
直接在这些外部脚本中导入Flask应用的数据库模型和SQLAlchemy实例时,常见的挑战包括:
这些问题表明,我们需要一种更健壮的方式来管理SQLAlchemy实例,使其能够被Flask应用和外部脚本共享,同时避免紧密耦合和导入陷阱。
核心思想是将SQLAlchemy实例从Flask应用实例中分离出来,使其成为一个独立的模块。Flask-SQLAlchemy为此提供了db.init_app(app)方法,允许我们在稍后将SQLAlchemy实例绑定到特定的Flask应用。
我们将通过以下步骤重构项目结构:
创建一个名为database.py的文件,专门用于实例化SQLAlchemy对象,但不立即将其与任何Flask应用绑定。
# app/database.py from flask_sqlalchemy import SQLAlchemy # 实例化 SQLAlchemy 对象,但暂不绑定到 Flask 应用 db = SQLAlchemy()
修改models.py,使其从新的database.py模块导入db实例,而不是从app.py或其他地方导入。
# app/models.py
import uuid
from sqlalchemy import func
# 从独立的 database 模块导入 db
from .database import db
def uuid_str():
return str(uuid.uuid4())
class TokenBlocklist(db.Model):
id = db.Column(
db.String(36),
primary_key=True,
nullable=False,
index=True,
default=uuid_str
)
jti = db.Column(
db.String(36),
nullable=False,
index=True
)
type = db.Column(
db.String(10),
nullable=False
)
created_at = db.Column(
db.DateTime,
nullable=False,
server_default=func.now(),
index=True
)在主Flask应用文件app.py中,导入db实例,并通过db.init_app(app)将其绑定到Flask应用。确保在应用程序上下文(app.app_context())中执行数据库创建操作。
# app/app.py
from flask import Flask
# 从独立的 database 模块导入 db
from app.database import db
# 导入模型(如果需要,例如在 app.py 中定义路由或初始化数据时)
# from app.models import TokenBlocklist # 示例,实际可能不需要在这里直接导入
app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///db.sqlite'
app.config["SQLALCHEMY_TRACK_MODIFICATIONS"] = False
# 将 db 实例绑定到 Flask 应用
db.init_app(app)
# 在应用程序上下文中创建所有数据库表
with app.app_context():
db.create_all()
# 其他 Flask 路由和应用逻辑
# ...现在,我们可以创建一个独立的脚本(例如remove_old_tokens.py),它能够正确地访问数据库模型并执行操作。
项目结构示例:
app/
app.py
database.py
models.py
scheduled_tasks/
remove_old_tokens.py
instance/
db.sqliteremove_old_tokens.py 脚本:
# scheduled_tasks/remove_old_tokens.py
from flask import Flask
from datetime import datetime, timedelta
import sys
import os
# 将项目根目录添加到 Python 路径,以便进行绝对导入
# 假设脚本在 app/scheduled_tasks/,项目根目录在 app/ 的父目录
sys.path.append(os.path.abspath('../../'))
# 从 app 模块中导入解耦的 db 实例和模型
from app.database import db
from app.models import TokenBlocklist
def remove_old_tokens():
"""
删除创建时间超过40天的旧令牌。
"""
forty_days = timedelta(days=40)
forty_days_ago = datetime.now() - forty_days
# 构建 SQLAlchemy 删除查询
query = TokenBlocklist.__table__.delete().where(
TokenBlocklist.created_at < forty_days_ago
)
# 执行查询并提交事务
db.session.execute(query)
db.session.commit()
print('旧令牌已成功删除。')
# 为外部脚本创建一个最小的 Flask 应用实例
# 这允许 db 实例绑定到它,并提供应用程序上下文
app = Flask(__name__)
# 配置数据库 URI,确保路径正确
# 假设 db.sqlite 在 instance/ 目录下,相对于脚本的父目录的父目录
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///' \
+ os.path.abspath('../../instance/db.sqlite')
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
# 将 db 实例绑定到这个临时的 Flask 应用
db.init_app(app)
# 在应用程序上下文中执行数据库操作
with app.app_context():
# 确保数据库表存在(可选,如果 app.py 已经处理,这里可以省略)
db.create_all()
# 调用数据库操作函数
remove_old_tokens()通过将SQLAlchemy实例与Flask应用解耦,并利用db.init_app(app)和app.app_context(),我们可以优雅地解决在Flask应用外部执行数据库操作时遇到的导入和上下文问题。这种方法提高了代码的模块化和可维护性,使得定时任务、后台服务等非请求驱动的数据库操作能够与主Flask应用共享相同的模型定义和数据库配置,同时保持各自的独立性。
以上就是解耦Flask-SQLAlchemy:在应用外部执行数据库操作的教程的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号