Python 装饰器：@dataclass

数据类让类定义简洁，代码可读性大幅提升。

三、字段自定义

dataclasses.field 提供更多灵活选项：

from dataclasses import dataclass, field

@dataclass
class Person:
    name: str
    age: int = 18              # 默认值
    id: int = field(init=False, repr=False)  # 不在 __init__ 中初始化，不在 __repr__ 中显示

• init=False：字段不参与初始化方法
• repr=False：字段不参与 repr 输出
• compare=False：字段不参与对象比较
• default / default_factory：设置默认值或生成默认值的工厂函数

其中，default_factory 参数用于生成可变默认值（如列表、字典），避免所有实例共享同一引用：

@dataclass
class Student:
    name: str
    grades: list[int] = field(default_factory=list)  # 每个实例独立列表

四、装饰器常用参数

@dataclass 装饰器可接收参数控制行为。

常用参数包括：init、repr、eq、order、frozen，以及 Python 3.10+ 引入的 slots、kw_only 等。

order=True

自动生成 <、<=、>、>= 等比较方法，默认使用字段定义顺序。

提示：order=True 依赖 eq=True，如果显式关闭 eq，将无法生成排序方法。

frozen=True

生成不可变对象，类似于 namedtuple，尝试修改属性会抛出 FrozenInstanceError。

slots=True（Python 3.10+）

使用 slots 优化内存和访问速度，防止动态添加新属性。

kw_only=True（Python 3.10+）

强制使用关键字参数初始化，提升代码可读性并避免参数顺序错误：

@dataclass(kw_only=True)
class Config:
    host: str
    port: int = 8080

cfg = Config(host="localhost")  # 必须关键字传参

五、post_init 特殊方法

数据类支持 post_init 方法，用于在 init 执行后完成额外初始化操作（如计算派生字段或验证数据）：

@dataclass
class Rectangle:
    width: float
    height: float
    area: float = field(init=False)  # 不参与初始化，后计算

    def __post_init__(self):
        self.area = self.width * self.height

提示：如果使用 frozen=True，在 post_init 中需要通过 object.setattr(self, "area", value) 来设置属性，否则会触发 FrozenInstanceError。

六、典型应用场景

1. 简化数据存储类

@dataclass
class Rectangle:
    width: float
    height: float

    def area(self):
        return self.width * self.height

r = Rectangle(5, 10)
print(r.area())  # 50

2. 不可变配置对象

@dataclass(frozen=True)
class Config:
    host: str
    port: int

cfg = Config("localhost", 8080)
cfg.port = 9090  # 报错：FrozenInstanceError

3. 排序与比较

@dataclass(order=True)
class Player:
    score: int
    name: str

players = [Player(20, "Alice"), Player(15, "Bob")]
players.sort()
print(players)  # 按 score 排序

排序规则默认按字段定义顺序进行比较，相当于比较 (score, name)。

七、与传统类对比

数据类主要用于存储数据，不适合包含大量业务逻辑的方法。对于复杂逻辑，可将数据类与实例方法结合使用。

八、与其他数据容器的对比

1. 与 typing.NamedTuple 的对比

NamedTuple 继承自元组，不可变且支持拆包，但扩展性较弱。

@dataclass 更灵活，支持可变性、默认值控制及继承，内存占用略高于 NamedTuple。

2. 性能与内存考虑

默认数据类使用 dict 存储属性，可通过 slots=True 减少内存占用（Python 3.10+）。

对性能敏感场景（如创建大量对象），可测试对比 @dataclass、NamedTuple 或传统类。

3. 类型检查器的支持

主流类型检查工具（如 mypy、Pyright）能识别 @dataclass，确保类型注解被正确验证，增强代码健壮性。

九、常见误区

1. 误认为数据类字段必须有默认值

非默认字段必须出现在默认字段之前，否则会报错：

@dataclass
class Example:
    a: int
    b: int = 0  # 正确

2. 滥用 frozen=True 修改对象

冻结对象无法修改属性，尝试修改会抛出 FrozenInstanceError。

3. 与继承组合时的注意事项

子类继承数据类时，字段顺序和默认值需谨慎，否则可能引发构造函数冲突。

4. 不适合包含大量业务逻辑的方法

数据类核心目的是简化数据封装，逻辑应以实例方法或外部函数实现。

小结

@dataclass 装饰器用于简化数据类定义，自动生成构造方法、表示方法、比较方法等，提高代码可读性与可维护性。结合 field() 可以自定义默认值、比较逻辑及初始化行为。通过 frozen=True、order=True 和 slots=True 等参数，数据类可以支持不可变对象、排序和内存优化。数据类非常适合存储数据、实现配置对象、排序对象或轻量级结构体，同时保持类型提示和代码简洁性。