C#转Python：创建含空字段、默认值与序列化别名的数据模型最佳实践

从C#转Python的话，Pydantic是目前最符合Python风格、能一站式满足你所有需求的方案，它的设计思路和Newtonsoft.Json有不少共通点，上手成本低。以下是具体实现方式：

核心方案：使用Pydantic的BaseModel #

Pydantic是Python生态中用于数据验证、序列化的主流库，天然支持可空字段、默认值、序列化别名，代码简洁易维护。

1. 字段支持为空（None） #

通过Python的typing.Optional类型标注，或者直接允许字段赋值为None，Pydantic会自动处理空值逻辑。

2. 部分字段设置默认值 #

直接在字段定义时赋值默认值，或者用Field类的default/default_factory参数（适用于需要动态生成默认值的场景，比如当前时间）。

3. 指定序列化别名 #

使用Field类的alias参数定义别名，序列化时通过model_dump(by_alias=True)输出带别名的结构。

完整代码示例 #

from pydantic import BaseModel, Field
from typing import Optional
from datetime import datetime

class User(BaseModel):
    # 可空字段：允许为None，无默认值（必填，但可以传None）
    id: Optional[int] = None
    # 必填字段，不可为空
    name: str
    # 可空且带默认值的字段
    email: Optional[str] = None
    # 动态默认值：实例化时自动生成当前时间
    created_at: datetime = Field(default_factory=datetime.now)
    # 带序列化别名的字段：序列化时会变成"userAlias"
    user_alias: str = Field(alias="userAlias")

# 实例化对象
user = User(
    name="Alice",
    user_alias="alice123"
    # id和email不传会用默认的None，created_at自动生成当前时间
)

# 序列化（输出带别名的JSON结构）
serialized_data = user.model_dump(by_alias=True)
print(serialized_data)
# 输出示例：
# {
#     "id": None,
#     "name": "Alice",
#     "email": None,
#     "created_at": "2024-05-20T15:30:00",
#     "userAlias": "alice123"
# }

备选方案：标准库dataclasses + 自定义序列化 #

如果不想引入第三方库，可以用Python标准库的dataclasses配合json模块实现，但需要手动处理别名映射，代码会繁琐一些：

from dataclasses import dataclass, asdict
from typing import Optional
from datetime import datetime
import json

@dataclass
class User:
    id: Optional[int] = None
    name: str
    email: Optional[str] = None
    created_at: datetime = None
    user_alias: str = None

    def __post_init__(self):
        # 动态设置默认值
        if self.created_at is None:
            self.created_at = datetime.now()

# 自定义序列化函数，处理别名
def serialize_user(user: User) -> str:
    data = asdict(user)
    # 替换别名
    data["userAlias"] = data.pop("user_alias")
    # 处理datetime序列化
    data["created_at"] = data["created_at"].isoformat()
    return json.dumps(data)

# 实例化
user = User(name="Bob", user_alias="bob456")
print(serialize_user(user))

显然，Pydantic的方案更简洁、更符合Python现代开发的风格，不需要手动处理序列化细节，还自带数据验证功能，推荐作为首选。

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