数据库事务回滚：FastAPI中的存档与读档大法

title: 数据库事务回滚：FastAPI中的存档与读档大法

date: 2025/05/10 00:18:52

updated: 2025/05/10 00:18:52

excerpt:

事务回滚机制确保数据库操作的原子性，适用于需要保持数据一致性的场景，如银行转账。FastAPI通过SQLAlchemy的session管理实现事务控制，使用上下文管理器处理事务，确保在异常时回滚。Alembic用于数据库版本控制，生成迁移脚本并管理多环境迁移策略。综合应用案例展示了用户注册时的事务处理，包括检查用户名唯一性、创建用户及其关联记录，并在异常时回滚。课后Quiz和常见报错解决提供了实际操作中的指导和问题处理方法。

categories:

后端开发
FastAPI

tags:

事务回滚
FastAPI
SQLAlchemy
Alembic
数据库迁移
Web开发
Python

扫描二维码

关注或者微信搜一搜：编程智域前端至全栈交流与成长

探索数千个预构建的 AI 应用，开启你的下一个伟大创意：https://tools.cmdragon.cn/

理解事务回滚机制

1.1 为什么需要事务回滚？

数据库事务回滚就像游戏中的存档机制，当执行某个任务失败时，可以回到任务开始前的状态。在Web开发中，当多个数据库操作需要保持原子性时（例如银行转账操作），事务回滚确保数据的一致性。

1.2 FastAPI中的事务实现

通过SQLAlchemy的session管理实现事务控制：

python 复制代码

from sqlalchemy import create_engine
from sqlalchemy.orm import sessionmaker

# 创建数据库连接（使用SQLite示例）
DATABASE_URL = "sqlite:///./test.db"
engine = create_engine(DATABASE_URL)
SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)

# Pydantic模型
from pydantic import BaseModel


class UserCreate(BaseModel):
    username: str
    email: str


# 数据库模型
from sqlalchemy import Column, Integer, String
from database import Base


class User(Base):
    __tablename__ = "users"
    id = Column(Integer, primary_key=True)
    username = Column(String(50), unique=True)
    email = Column(String(100))

1.3 事务操作最佳实践

使用上下文管理器处理事务：

python 复制代码

def create_user_with_profile(user_data: UserCreate):
    db = SessionLocal()
    try:
        with db.begin():
            # 创建用户
            new_user = User(**user_data.dict())
            db.add(new_user)

            # 创建用户配置（假设需要原子操作）
            db.execute("INSERT INTO profiles (user_id) VALUES (:user_id)",
                       {"user_id": new_user.id})

            return new_user
    except Exception as e:
        db.rollback()
        raise HTTPException(status_code=400, detail=str(e))
    finally:
        db.close()

Alembic数据版本控制

2.1 迁移脚本生成

安装配置Alembic：

bash 复制代码

pip install alembic
alembic init migrations

修改alembic.ini：

ini 复制代码

sqlalchemy.url = sqlite:///./test.db

2.2 版本管理操作流程

生成新迁移脚本：

bash 复制代码

alembic revision -m "add phone_number column"

手动编辑生成的迁移文件：

python 复制代码

def upgrade():
    op.add_column('users',
                  Column('phone_number', String(20))
                  )


def downgrade():
    op.drop_column('users', 'phone_number')

2.3 多环境迁移策略

在CI/CD中处理不同环境：

bash 复制代码

# 生产环境迁移
ALEMBIC_CONFIG=prod_alembic.ini alembic upgrade head

# 回滚到指定版本
alembic downgrade -1

综合应用案例

用户注册事务处理：

python 复制代码

from fastapi import APIRouter, Depends

router = APIRouter()


@router.post("/register")
async def register_user(user: UserCreate):
    db = SessionLocal()
    try:
        with db.begin():
            # 检查用户名唯一性
            if db.query(User).filter(User.username == user.username).first():
                raise ValueError("Username already exists")

            # 创建用户
            new_user = User(**user.dict())
            db.add(new_user)

            # 创建关联记录
            profile_data = {"user_id": new_user.id, "status": "active"}
            db.execute(
                "INSERT INTO profiles (user_id, status) VALUES (:user_id, :status)",
                profile_data
            )

        return {"message": "Registration successful"}
    except ValueError as ve:
        db.rollback()
        return {"error": str(ve)}
    finally:
        db.close()

课后Quiz：

Q: 当执行alembic downgrade命令时，系统实际执行什么操作？

A: 系统会按照迁移脚本的downgrade函数定义执行数据库结构回退操作，每个版本的downgrade会逆序执行。

常见报错解决：

问题：alembic.util.exc.CommandError: Can't locate revision identified by 'xxxx'

解决步骤：

检查migrations/versions目录是否存在对应版本的迁移文件
执行alembic history查看版本链
若存在断链，可删除alembic_version表后重新初始化

预防建议：

• 团队开发时统一管理迁移脚本

• 禁止手动修改数据库版本表

• 每次生成新迁移脚本后立即提交到版本控制系统

（完整示例代码需要安装fastapi, sqlalchemy, alembic等依赖，建议使用Python 3.8+环境，通过uvicorn main:app启动服务）

余下文章内容请点击跳转至个人博客页面或者扫码关注或者微信搜一搜：编程智域前端至全栈交流与成长，阅读完整的文章：数据库事务回滚：FastAPI中的存档与读档大法 | cmdragon's Blog

数据库事务回滚：FastAPI中的存档与读档大法

往期文章归档：