Python dataclasses.field的default_factory延迟初始化可变默认值

在 Python 中使用 dataclasses 时，直接将列表、字典等可变对象作为默认参数是一个经典的陷阱。这会导致所有实例意外共享同一个对象。为了解决这个问题，必须使用 dataclasses.field 配合 default_factory 参数来实现延迟初始化。本文将手把手教你如何正确配置和使用这一功能，彻底避免可变默认值带来的副作用。

1. 认识问题：直接使用可变默认值的陷阱

在开始修复之前，先看一段错误代码。直接在类属性中赋值一个空列表，会导致严重的数据混淆。

from dataclasses import dataclass

@dataclass
class ShoppingCart:
    items: list = []  # 错误写法：直接赋值可变对象

# 创建两个不同的购物车实例
cart_a = ShoppingCart()
cart_b = ShoppingCart()

# 向 cart_a 添加商品
cart_a.items.append("Apple")

# 打印结果
print(cart_a.items)  # 输出: ['Apple']
print(cart_b.items)  # 输出: ['Apple'] -> 意料之外！cart_b 也被修改了

运行上述代码会发现，虽然只操作了 cart_a，但 cart_b 中的 items 列表也发生了变化。这是因为类定义时，空列表 [] 只被创建了一次，所有实例都指向内存中的同一个列表对象。

2. 解决方案：使用 field 与 default_factory

为了确保每个实例都拥有自己独立的列表，需要使用 field() 函数，并传入 default_factory 参数。该参数接收一个可调用对象（如 list、dict 或 lambda 函数），在每次创建新实例时调用它以生成新对象。

核心步骤

1. 打开你的 Python 编辑器或 IDE。
2. 导入 dataclass 和 field：

   from dataclasses import dataclass, field

3. 定义类，并在可变字段中使用 field(default_factory=list)。
4. 实例化两个对象，分别修改其属性，验证独立性。

完整示例代码：

from dataclasses import dataclass, field

@dataclass
class ShoppingCart:
    items: list = field(default_factory=list)  # 正确写法

cart_a = ShoppingCart()
cart_b = ShoppingCart()

cart_a.items.append("Apple")
cart_b.items.append("Banana")

print(cart_a.items)  # 输出: ['Apple']
print(cart_b.items)  # 输出: ['Banana'] -> 结果正确，互不影响

3. 工作原理：内存分配对比

为了更直观地理解两者的区别，请看下面的内存分配流程图。左侧是错误的共享模式，右侧是正确的独立模式。

在“正确写法”中，default_factory 仅仅存储了生成对象的“配方”（即 list 这个类型），而不是直接存储对象。只有当 ShoppingCart() 被调用时，配方才会被执行，从而在内存中开辟新的空间。

4. 进阶用法：自定义默认值工厂

除了使用内置的 list 和 dict，你还可以将 default_factory 指向任何返回对象的函数或 Lambda 表达式。这对于设置复杂的默认结构非常有用。

场景：创建带有默认值的字典

如果你希望每个实例都有一个包含特定键的字典，而不是空字典，请遵循以下步骤：

1. 定义一个内部函数或使用 lambda。
2. 将该函数传给 default_factory。

代码实现：

from dataclasses import dataclass, field

def create_default_config():
    """生成包含默认配置的字典"""
    return {
        "verbose": True,
        "retry_times": 3,
        "timeout": 30
    }

@dataclass
class ServerConfig:
    name: str
    settings: dict = field(default_factory=create_default_config)

# 使用 lambda 的简化写法（效果相同）
# settings: dict = field(default_factory=lambda: {"verbose": True, "retry": 3})

# 实例化
s1 = ServerConfig(name="Web-01")
s2 = ServerConfig(name="DB-01")

# 修改 s1 的设置，验证 s2 是否受影响
s1.settings["timeout"] = 60

print(f"s1: {s1.settings}")  # 输出: {'verbose': True, 'retry_times': 3, 'timeout': 60}
print(f"s2: {s2.settings}")  # 输出: {'verbose': True, 'retry_times': 3, 'timeout': 30}

5. 常见数据类型的 default_factory 写法

为了方便查阅，下表总结了 Python 中常见可变类型的 default_factory 标准写法。

6. 注意事项

在实际开发中，请务必遵守以下规则以避免错误：

1. 不要在 default_factory 后加括号。

   • 错误：default_factory=list()
   • 正确：default_factory=list
   • 原因：你希望传递的是 list 这个函数对象，而不是函数调用的结果。如果加了括号，列表会在类定义时被创建，从而退化回“共享可变对象”的问题。

2. 不要将不可变类型（如 int, str, float）也强行使用 default_factory。

   • 虽然 default_factory=lambda: 0 也能工作，但直接写 count: int = 0 更简洁高效，且对于不可变对象不存在共享副作用。

3. 确保 default_factory 传入的是可调用对象。如果传入非函数对象（如 None 或数字），程序会在实例化时抛出 TypeError。