在django中，如何序列化mptt树？

Question

以下是我的代码：

class File(MPTTModel):
    name=models.CharField(max_length=36, primary_key=True)
    parent = TreeForeignKey('self', null=True, blank=True, related_name='children', db_index=True)
    num=models.IntegerField(null=True)
    class MPTTMeta:
        order_insertion_by = ['name']

我尝试使用以下代码序列化这个类：

class RecursiveField(serializers.Serializer):
    def to_representation(self, value):
        serializer = self.parent.parent.__class__(value, context=self.context)
        return serializer.data

class FileSerializer(serializers.ModelSerializer):
    parent=RecursiveField(many=True)
    class Meta:
        model = File
        fields=('name','num','parent')

但是我失败了，我只能输出这棵树的根节点的内容。似乎序列化器无法访问根的孩子，更进一步的孩子的孩子...... 具体问题是，在输出中，'parent' 显示为 'null'，但实际上它有 4 个孩子，每个孩子都包含几个后代。 我的代码有什么问题？ 谢谢大家帮助我！

Answer 1

MPTT 和 REST 框架都没有魔法。

MPTT 将新字段添加到您的模块中，以实现a nested set model。它还跟踪从子级到其父级的向上链接，用于一些优化，并在嵌套集树损坏时重建它。

因此，基本上，您的模型具有您手动添加的以下字段 name/num、您添加以触发 MPTT 的 parent，以及以下自动字段：

• tree_id：树标识符。连接到同一个根的所有节点共享同一个tree_id。
• ̀level：树中节点的深度。
• lft/rght：嵌套集索引。请参阅上面的链接，但基本思想是，如果一个节点的lft 大于或等于且其rght 小于或等于另一个节点的rght，则该节点是另一个节点的后代。

REST 框架 不支持 mptt，也不需要支持。它只会看到一个包含 7 个字段的常规模型，它会很高兴地对其进行序列化。

虽然您可以实现递归序列化程序以在...的对象的对象的对象的对象的嵌套对象中塑造序列化的表示形式，但这通常不是一个好主意。 p>

现在，如果您真的想这样做，则需要以另一种方式进行。您必须序列化根节点，并确保它们的序列化表示递归地包括它们的所有子节点。不是相反，就像你在这里尝试的那样。

我们的想法是构建这样的东西：

class FileSerializer(serializers.ModelSerializer):
    children = FileSerializer(many=True)
    class Meta:
        model = File
        fields=('name','num')

但是你不能这样做，因为FileSerializer 没有在你想要的地方定义。您可以尝试覆盖构造函数并在其中插入额外的序列化程序，如下所示：

class FileSerializer(serializers.ModelSerializer):
    class Meta:
        model = File
        fields=('name','num')

    def get_fields(self):
        fields = super(FileSerializer, self).get_fields()
        fields['children'] = FileSerializer(many=True)
        return fields

未经测试，但你明白了。

但是：

• 以这种幼稚的方式执行此操作是一个非常糟糕的主意，因为树中的每个非叶节点都会触发对数据库的额外查询以获取其子节点。
• 这不适用于反序列化。

如何如果你真的需要序列化平面节点，并在客户端重建对象树？

[{'id': 1, 'name': 'foo', 'parent': null},  // /foo
 {'id': 2, 'name': 'bar1', 'parent': 1},    // /foo/bar1
 {'id': 3, 'name': 'bar2', 'parent': 1},    // /foo/bar2
 {'id': 4, 'name': 'foo2', 'parent': null}, // /foo2
 {'id': 5, 'name': 'baz1', 'parent': 4},    // /foo2/baz1
 {'id': 6, 'name': 'baz2', 'parent': 4}]    // /foo2/baz2

Answer 2

2021 年更新。

对于那些需要创建嵌套树的人，我升级了@spectras 答案并设法返回了嵌套树。您只需要在FileSerializer 上的get_fields() 中添加'required=False'，并且在您的视图集中，您必须找到一种方法来“仅”返回第一个节点。

class FileSerializer(serializers.ModelSerializer):
    class Meta:
        model = File
        fields=('name','num')

    def get_fields(self):
        fields = super(FileSerializer, self).get_fields()
        fields['children'] = FileSerializer(many=True, required=False)
        return fields

就我而言，在视图集上，我过滤为仅返回具有parent=0 的项目。

继续上面的例子：

class FileViewSet(viewsets.ModelViewSet):
    """
    Viewset to be used on Urls.py
    """
    serializer_class = File

    def get_queryset(self):
        queryset = File.objects.filter(level=0)
        return queryset

您将拥有这样的端点：

[
     {
      'id': 1,
      'name': 'foo',
      'parent': 0,
      'children':[
         {
           'id': 2,
           'name': 'bar2',
           'parent': 1,
           'children':[
              {
                'id': 3,
                'name': 'bar3',
                'parent': 2,
                'children':[]
               }
             ]
          } 
       ]
     }, 
     {
      'id': 4,
      'name': 'bar2',
      'parent': 0,
      'children':[]
     }
]

如果您需要更新任何节点，只需添加您想要正常更新的节点的id即可。