如何基于SQLAlchemy为跨API交互实体实现正确的乐观并发控制
问题根因
校验失效的核心原因是错用了SQLAlchemy内置version_id_col机制的触发逻辑,并非该机制无法支撑前后端分离场景的乐观并发控制。
SQLAlchemy内置版本计数器的工作规则很明确:
- 实体从数据库加载到Session时,会自动缓存当前行的真实版本值作为校验基线
- 生成UPDATE语句时,会把缓存的基线值作为WHERE子句的版本校验条件,同时自动将版本值自增
- 若执行更新时数据库当前版本与缓存基线不匹配,会抛出
StaleDataError
原代码的操作直接破坏了这套逻辑的校验基准:
- 从数据库加载实体时,Session已经缓存了数据库当前的真实版本值(即日志中的2)
- 手动执行
entity.version = 前端传入值,直接覆盖实体的属性值,导致最终SQL的SET子句中版本值被替换为传入的数值,WHERE条件仍使用加载时缓存的旧基线值 - 最终生成的SQL本质是“将数据库里版本为基线值的行,版本值更新为传入的数值”,完全没有对比前端传入版本与数据库当前值的一致性,自然无法拦截冲突场景。
正确实现方式
针对前后端分离场景“前端提交的版本值必须与数据库当前版本完全一致才允许更新”的要求,有两种可落地的实现路径:
方案1:原子UPDATE语句实现无间隙校验
这种方式不需要将实体加载到Session中,彻底消除加载-更新间隙的并发风险,性能更高:
def mutate( root, info, id, version: int, name: str, ) -> 'UpdateEntity': db = get_db_session() # 构造带版本校验的原子更新语句 update_stmt = ( update(Entity) .where( Entity.id == id, Entity.version == version # 直接和前端传入的版本值做比对 ) .values( name=name, version=Entity.version + 1 # 版本值自增 ) ) result = db.execute(update_stmt) db.commit() # 影响行数为0说明要么记录不存在,要么版本不匹配 if result.rowcount == 0: raise Exception( "Updating the entity was not successful since the entity was changed in the meantime. Please refresh." ) # 加载更新后的实体返回给前端 updated_entity = db.get(Entity, id) return UpdateEntity(updated_entity)
注意:这种方式不需要依赖SQLAlchemy的Session内置版本跟踪逻辑,即使保留类定义中的
__mapper_args__配置也不会产生冲突,因为没有实体对象被纳入Session跟踪范围。
方案2:复用SQLAlchemy内置版本机制
如果希望保留原代码中依赖StaleDataError做异常捕获的写法,不需要手动判断影响行数,可以在加载实体后,将Session内部缓存的版本校验基线替换为前端传入的版本值,不要直接修改实体的version属性:
from sqlalchemy import inspect def mutate( root, info, id, version: int, name: str, ) -> 'UpdateEntity': db = get_db_session() entity = db.get(Entity, id) if not entity: raise Exception("Entity not found") # 获取实体在Session中的内部状态,将版本校验基线替换为前端传入的版本值 state = inspect(entity) state._version_id = version # 仅更新需要修改的业务字段,不要手动给version属性赋值 entity.name = name try: db.commit() return UpdateEntity(entity) except StaleDataError as e: raise Exception( "Updating the entity was not successful since the entity was changed in the meantime. Please refresh." )
这种方式生成的UPDATE语句会完全符合预期:UPDATE entity SET version = 自动自增的值, name = ? WHERE entity.id = ? AND entity.version = 前端传入的版本值
两种方案的差异
- 原子UPDATE方案不需要将实体全量加载到内存,并发场景下没有行级锁外的额外开销,更适合高并发更新场景
- 复用内置版本机制的方案代码结构更贴近原有写法,自动触发
StaleDataError异常,不需要手动判断影响行数,但需要依赖SQLAlchemy的内部状态修改,升级版本时需要注意兼容性
内容的提问来源于stack exchange,提问作者neurolabs
相关产品推荐
相关产品推荐

