理解SQLAlchemy中Session.merge()用法及跨线程传对象报错问题

问题诊断 #

首先明确：你的Session.merge()使用方式没有错误，报错和merge操作无关。
报错触发的核心原因如下：

• SQLAlchemy的ORM实例默认与加载它的Session实例绑定，你在read_user函数中用上下文管理器创建的Session会在with Session()代码块退出时自动关闭，此时你传入队列的User对象会进入**脱管（Detached）**状态，不再和任何Session绑定。
• SQLAlchemy的expire_on_commit配置默认开启，事务提交后实例的所有属性会被标记为过期，后续访问属性时会自动尝试通过绑定的Session刷新属性值。你在update_user函数中先访问了脱管实例的user.id属性，此时原Session已经关闭，无法完成属性刷新，就会抛出对应的错误。你调用merge的操作是在访问user.id之后执行的，所以还没来得及生效。

跨线程传递ORM实例的正确实现方法 #

有两种常用的可行方案：

方案1：调整属性访问时机，或者修改Session配置 #

改法A：先merge再访问属性

把属性访问逻辑移到merge操作之后，访问绑定了当前线程Session的新实例即可：

def update_user(age, queue):
    user = queue.get()
    with Session() as session:
        with session.begin():
            local_user = session.merge(user)
            # 访问已经绑定当前Session的local_user，而非脱管的原实例
            print('Got user', local_user.id)
            print(f'Thread-local user object: {local_user}')

改法B：关闭属性过期自动刷新

如果你需要在脱管状态下直接访问实例的旧属性值，可以在初始化Session时关闭expire_on_commit配置：

# 初始化Session工厂时添加配置
Session = sessionmaker(expire_on_commit=False)

注意：该配置下脱管实例的属性是事务提交时的快照，不会自动同步数据库最新变更。 #

方案2：仅传递主键，子线程自行查询实例（更推荐） #

该方案完全避免了跨Session传递实例的各类问题，是生产环境更常用的实现：

def read_user(name, queue):
    with Session() as session:
        with session.begin():
            print(f'Reading user with name={name} from DB')
            user = session.query(User).filter_by(name=name).first()
            print('User', user)
            queue.put(user.id) # 仅传递主键

def update_user(age, queue):
    user_id = queue.get()
    with Session() as session:
        with session.begin():
            local_user = session.get(User, user_id) # 当前线程自行查询实例
            print('Got user', local_user.id)
            print(f'Thread-local user object: {local_user}')

内容的提问来源于stack exchange，提问作者user3447843