Django Ninja 中嵌套 Schema 解析问题的解决方案

问题背景

在使用 Django Ninja 框架开发 REST API 时，开发者经常会遇到需要返回嵌套数据结构的情况。本文探讨了一个典型问题：当 Schema 中包含嵌套的 Schema 时，子 Schema 的 resolve 方法没有被正确调用的问题。

问题现象

开发者定义了一个 DetailedAlbumOut Schema，其中包含一个 ArtistOut Schema 的列表。ArtistOut Schema 中有一个 url 字段需要通过 resolve_url 方法动态计算生成。当单独使用 ArtistOut Schema 时一切正常，但在嵌套使用时，resolve_url 方法没有被调用，导致验证错误。

问题分析

通过分析问题代码，发现以下几个关键点：

1. Resolver 方法签名不正确：原始代码中的 resolve 方法只接收了 obj 参数，而实际上 Django Ninja 会传递上下文对象 context。

2. 请求对象传递方式不当：开发者尝试通过直接为对象添加 request 属性的方式来传递请求对象，这不是 Django Ninja 推荐的做法。

3. 数据转换不完整：在处理输入数据时，没有正确地将 Schema 对象转换为字典，导致后续操作出现问题。

解决方案

1. 正确使用 Resolver 方法

Django Ninja 的 resolve 方法应该接收两个参数：obj 和 context。context 参数包含了请求上下文，可以通过它获取 request 对象。

@staticmethod
def resolve_url(obj, context):
    artist_url = reverse("api-1.0:retrieve_artist", kwargs={"id": obj.id})
    return context["request"].build_absolute_uri(artist_url)

2. 使用上下文传递请求对象

不再需要手动为对象添加 request 属性，Django Ninja 会自动将请求对象放入上下文中。

3. 完整的数据转换

在处理输入数据时，确保将 Schema 对象转换为字典：

data = payload.dict()

最佳实践

1. Resolver 方法设计：

   • 总是包含 obj 和 context 两个参数
   • 从 context 中获取请求对象
   • 保持方法简洁，只负责计算特定字段

2. 嵌套 Schema 使用：

   • 确保所有子 Schema 的 resolve 方法都遵循相同的参数约定
   • 在测试时先单独测试子 Schema，再测试嵌套情况

3. 请求处理：

   • 避免直接修改模型实例添加请求对象
   • 利用 Django Ninja 提供的上下文机制

总结

Django Ninja 提供了强大的 Schema 功能来处理复杂的数据结构。当遇到嵌套 Schema 的 resolve 方法不被调用的问题时，开发者应该：

1. 检查 resolve 方法的参数是否正确
2. 确保使用了正确的上下文传递方式
3. 验证数据转换过程是否完整

通过遵循这些最佳实践，可以避免类似问题的发生，构建出更加健壮的 API 接口。