如何在 Python 中使用 Firestore 事务安全地批量更新多个文档

云雪大大_7014

云雪大大_7014

2026-05-06

204人浏览

原创

本文详解 Firestore Python SDK 中异步事务的正确用法,包括 @firestore.async_transactional 装饰器的调用规范、事务对象传递方式、避免常见 AttributeError 错误的关键实践,并提供可直接运行的完整示例。

本文详解 firestore python sdk 中异步事务的正确用法,包括 `@firestore.async_transactional` 装饰器的调用规范、事务对象传递方式、避免常见 attributeerror 错误的关键实践,并提供可直接运行的完整示例。

在 Firestore 中实现跨文档的原子性操作(如同时更新用户和项目记录)必须依赖事务(Transaction),但 Python SDK 的事务 API 与 JavaScript 或 Java 版本存在显著差异——尤其是异步事务的使用方式极易出错。你遇到的 AttributeError: 'str' object has no attribute '_read_only' 根源在于:将事务实例作为实例属性提前创建并复用,同时错误地将 @firestore.async_transactional 应用于类方法。这会导致装饰器接收到非事务对象(如字符串或 None),从而触发底层类型校验失败。

✅ 正确做法是:事务对象必须由 @firestore.async_transactional 自动注入,且被装饰函数必须是顶层函数(非绑定方法),接收 transaction 作为首个参数。事务生命周期应严格限定在该函数内,不可跨函数传递或复用已初始化的 self.transaction。

以下是符合最佳实践的重构代码:

import firebase_admin
from firebase_admin import credentials, firestore
import uuid

# 初始化 Firebase(仅需一次,建议在应用启动时执行)
if not firebase_admin._apps:
    cred = credentials.ApplicationDefault()
    firebase_admin.initialize_app(cred)

db = firestore.client()
users_ref = db.collection('users')
projects_ref = db.collection('projects')


@firestore.async_transactional
async def _create_project(transaction, user_id: str) -> dict:
    """事务内执行:读取用户、更新用户项目列表、创建新项目"""
    # 1. 读取用户文档(必须在事务内调用 get())
    user_doc = users_ref.document(user_id).get(transaction=transaction)
    if not user_doc.exists:
        raise ValueError(f"User {user_id} not found")

    # 2. 生成唯一项目 ID
    project_id = str(uuid.uuid4())

    # 3. 更新用户文档:追加 projectIds(注意:需先读取原值再合并,避免覆盖)
    user_data = user_doc.to_dict()
    current_projects = user_data.get("projectIds", [])
    updated_projects = current_projects + [project_id]
    transaction.update(user_doc.reference, {"projectIds": updated_projects})

    # 4. 创建新项目文档
    project_data = {
        "id": project_id,
        "userIds": [user_id],
        "createdAt": firestore.SERVER_TIMESTAMP
    }
    projects_ref.document(project_id).set(project_data, transaction=transaction)

    return {"projectId": project_id, "userId": user_id}


# 外层业务方法:不带装饰器,负责调用事务函数
class FirestoreApi:
    async def create_project(self, user_id: str) -> dict:
        # 直接调用被 @async_transactional 装饰的顶层函数
        return await _create_project(user_id=user_id)

? 关键注意事项:

macOS UI 自动化技能包 —— 用 Python 控制你的 Mac
macOS UI 自动化技能包 —— 用 Python 控制你的 Mac

让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限

下载
  • ❌ 禁止在 __init__ 中初始化 self.transaction —— 事务对象不能预先创建或跨调用复用;
  • ✅ 事务函数必须为模块级顶层函数(非 self. 方法),且第一个参数必须是 transaction;
  • ✅ 所有读写操作(.get()、.update()、.set())都必须显式传入 transaction= 参数;
  • ✅ 若需更新数组字段(如 projectIds),务必先 .get() 获取当前值,再合并更新,否则可能覆盖其他字段;
  • ✅ 异步事务函数返回值会自动成为外层 await 的结果,无需手动 commit()。

调用方式:

api = FirestoreApi()
result = await api.create_project("robert")
print(result)  # {'projectId': 'xxx', 'userId': 'robert'}

此模式确保了强一致性:若任一操作失败(如用户不存在、网络中断),整个事务自动回滚,数据库状态保持不变。这是构建可靠协作系统(如权限同步、计数器更新、订单-库存联动)的基石。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1871

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5064

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1809

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

30537

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3627

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3647

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1243

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2823

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程