Flask 如何让Flask-SQLAlchemy在发生异常时自动回滚会话

在本文中，我们将介绍如何在使用Flask-SQLAlchemy包时，让会话在发生异常时自动回滚。Flask-SQLAlchemy是Flask的SQLAlchemy扩展，提供了便捷的数据库操作功能。

阅读更多：Flask 教程

什么是会话回滚？

会话回滚是指当在数据库操作过程中发生异常时，将已经进行的操作全部撤销，即回滚到操作之前的状态。这样可以保证数据的一致性，并且避免因异常导致的数据损坏。

如何实现会话回滚？

在Flask-SQLAlchemy中，可以通过设置SQLALCHEMY_COMMIT_ON_TEARDOWN参数为False来关闭自动提交。这样，当发生异常时，会话将自动回滚。

下面是一个示例代码：

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__)
app.config['SQLALCHEMY_DATABASE_URI'] = 'mysql://username:password@localhost/db_name'
app.config['SQLALCHEMY_COMMIT_ON_TEARDOWN'] = False  # 关闭自动提交
db = SQLAlchemy(app)

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(50))

@app.route('/add_user')
def add_user():
    try:
        user = User(name='John')
        db.session.add(user)
        db.session.commit()  # 提交事务
        return 'User added successfully!'
    except Exception as e:
        db.session.rollback()  # 回滚事务
        return 'Failed to add user: {}'.format(str(e))

if __name__ == '__main__':
    app.run()

在上面的示例中，我们定义了一个User模型类，然后在add_user路由函数中进行了数据库操作。如果在操作过程中发生异常，会话将自动回滚，保证数据的一致性。

如何测试会话回滚是否生效？

为了测试会话回滚是否生效，我们可以故意制造一个异常。在上面的示例代码中，我们可以将User模型类的name属性改成唯一索引，这样重复插入相同用户时就会触发异常。在add_user函数中，我们可以故意重复插入相同用户，然后查看回滚效果。

修改User模型类如下：

class User(db.Model):
    id = db.Column(db.Integer, primary_key=True)
    name = db.Column(db.String(50), unique=True)  # 添加唯一索引

修改add_user函数如下：

@app.route('/add_user')
def add_user():
    try:
        user = User(name='John')
        db.session.add(user)
        db.session.commit()  # 提交事务
    except Exception as e:
        db.session.rollback()  # 回滚事务

    # 故意再次添加相同用户
    try:
        user = User(name='John')
        db.session.add(user)
        db.session.commit()  # 提交事务
        return 'User added successfully!'
    except Exception as e:
        db.session.rollback()  # 回滚事务
        return 'Failed to add user: {}'.format(str(e))

运行修改后的代码并访问/add_user路由，我们可以看到第二次插入相同用户时触发了异常，并且会话自动回滚，保证了数据的一致性。