Tortoise-ORM 中 Pydantic 模型未返回外键字段的解决方案

在使用 Tortoise-ORM 和 Pydantic 进行模型转换时，开发者可能会遇到外键字段未被正确返回的问题。本文将深入分析这一现象的成因，并提供完整的解决方案。

问题现象

当使用 pydantic_model_creator 创建 Pydantic 模型时，模型中的外键关系字段（如 parent_id）未被包含在生成的响应中。例如，一个部门模型包含指向自身的父部门外键关系，但在 API 响应中却缺失了这个字段。

根本原因

这个问题通常由两个关键因素导致：

1. 模型初始化时机不当：Tortoise-ORM 需要在创建 Pydantic 模型之前完成所有 ORM 模型的初始化。如果顺序错误，关系字段将无法被正确识别。

2. Pydantic 配置缺失：默认情况下，Pydantic 不会自动包含外键字段，需要显式配置才能包含这些关系。

解决方案

1. 正确的模型初始化顺序

确保在应用启动时首先初始化 Tortoise-ORM 模型：

from tortoise import Tortoise

async def init_db():
    await Tortoise.init(
        db_url='sqlite://db.sqlite3',
        modules={'models': ['path.to.your.models']}
    )
    # 生成 Pydantic 模型前必须调用此方法
    await Tortoise.generate_schemas()

2. 完整的 Pydantic 模型配置

创建 Pydantic 模型时，需要明确指定包含的关系字段：

from tortoise.contrib.pydantic import pydantic_model_creator

DeptOut = pydantic_model_creator(
    DeptModel,
    name='DeptOut',
    include=('id', 'name', 'sort', 'leader', 'phone', 'email', 'status', 'parent_id'),
    allow_cycles=True,
    model_config=modelOutConfig,
)

或者使用更灵活的方式包含所有字段：

DeptOut = pydantic_model_creator(
    DeptModel,
    name='DeptOut',
    include=tuple(DeptModel._meta.fields),  # 包含所有模型字段
    allow_cycles=True,
    model_config=modelOutConfig,
)

3. 包含关系对象（可选）

如果需要包含完整的关联对象而不仅仅是外键ID，可以这样配置：

DeptOutWithRelations = pydantic_model_creator(
    DeptModel,
    name='DeptOutWithRelations',
    include=('id', 'name', 'parent', 'children'),  # 包含关系字段
    allow_cycles=True,
    model_config=modelOutConfig,
)

最佳实践建议

1. 统一初始化流程：在应用启动时集中初始化 ORM 和 Pydantic 模型。

2. 明确的字段包含策略：根据业务需求明确指定需要包含的字段，避免意外暴露敏感数据。

3. 性能考虑：包含关系对象会导致额外的数据库查询，在高并发场景下应谨慎使用。

4. 文档注释：为每个 Pydantic 模型添加清晰的文档说明，注明包含的字段和关系。

通过遵循这些实践，开发者可以确保 Tortoise-ORM 和 Pydantic 的集成更加稳定可靠，外键关系字段也能被正确序列化和返回。