Django MPTT使用DRF高效地序列化关系数据

时间:2014-11-22 01:39:50

标签: python django serialization django-rest-framework django-mptt

我有一个类别模型是MPTT模型。它是m2m to Group,我需要使用相关计数序列化树,想象我的Category树是这样的:

Root (related to 1 group)
 - Branch (related to 2 groups) 
    - Leaf (related to 3 groups)
...

所以序列化输出看起来像这样:

{ 
    id: 1, 
    name: 'root1', 
    full_name: 'root1',
    group_count: 6,
    children: [
    {
        id: 2,
        name: 'branch1',
        full_name: 'root1 - branch1',
        group_count: 5,
        children: [
        {
            id: 3,
            name: 'leaf1',
            full_name: 'root1 - branch1 - leaf1',
            group_count: 3,
            children: []
        }]
    }]
}

这是我目前的超低效实施:

模型

class Category(MPTTModel):
    name = ...
    parent = ... (related_name='children')

    def get_full_name(self):
        names = self.get_ancestors(include_self=True).values('name')
        full_name = ' - '.join(map(lambda x: x['name'], names))
        return full_name

    def get_group_count(self):
        cats = self.get_descendants(include_self=True)
        return Group.objects.filter(categories__in=cats).count()

查看

class CategoryViewSet(ModelViewSet):
    def list(self, request):
        tree = cache_tree_children(Category.objects.filter(level=0))
        serializer = CategorySerializer(tree, many=True)
        return Response(serializer.data)

串行

class RecursiveField(serializers.Serializer):
    def to_native(self, value):
        return self.parent.to_native(value)


class CategorySerializer(serializers.ModelSerializer):
    children = RecursiveField(many=True, required=False)
    full_name = serializers.Field(source='get_full_name')
    group_count = serializers.Field(source='get_group_count')

    class Meta:
        model = Category
        fields = ('id', 'name', 'children', 'full_name', 'group_count')

这有效,但也会在数据库中遇到疯狂的查询,还有其他关系,而不仅仅是Group。有没有办法让这个有效?如何编写自己的序列化程序?

2 个答案:

答案 0 :(得分:2)

您肯定遇到了N + 1查询问题,我已经介绍过in detail in another Stack Overflow answer。我建议阅读Django中的优化查询,因为这是一个非常常见的问题。

现在,Django MPTT还有一些问题,你需要解决N + 1查询。 self.get_ancestorsself.get_descendants方法都会创建一个新的查询集,在您的情况下会发生您要序列化的每个对象。您可能希望找到一种更好的方法来避免这些,我已经在下面描述了可能的改进。

get_full_name方法中,您正在调用self.get_ancestors以生成正在使用的链。考虑到在生成输出时始终拥有父级,您可以将其移动到重用父对象以生成名称的SerializerMethodField。以下内容可能有效:

class RecursiveField(serializers.Serializer):

    def to_native(self, value):
        return CategorySerializer(value, context={"parent": self.parent.object, "parent_serializer": self.parent})

class CategorySerializer(serializers.ModelSerializer):
    children = RecursiveField(many=True, required=False)
    full_name = SerializerMethodField("get_full_name")
    group_count = serializers.Field(source='get_group_count')

    class Meta:
        model = Category
        fields = ('id', 'name', 'children', 'full_name', 'group_count')

    def get_full_name(self, obj):
        name = obj.name

        if "parent" in self.context:
            parent = self.context["parent"]

            parent_name = self.context["parent_serializer"].get_full_name(parent)

            name = "%s - %s" % (parent_name, name, )

        return name

您可能需要略微编辑此代码,但一般的想法是,您不必总是需要获得祖先,因为您已经拥有祖先链。

这并不能解决您可能无法优化的Group查询,但至少应该减少您的查询。递归查询非常难以优化,并且他们通常需要进行大量计划,以确定如何最好地获得所需数据,而不会回退到N + 1情况。

答案 1 :(得分:0)

我找到了解决问题的办法。由于django-mptt的功能get_cached_trees,您可以执行以下操作:

from django.db.models import Count


class CategorySerializer(serializers.ModelSerializer):
    def get_group_count(self, obj, field=field):
        return obj.group_count

    class Meta:
        model = Category
        fields = [
            'name',
            'slug',
            'children',
            'group_count',
        ]

CategorySerializer._declared_fields['children'] = CategorySerializer(
    many=True,
    source='get_children',
)

class CategoryViewSet(ModelViewSet):
    serializer_class = CategorySerializer

    def get_queryset(self, queryset=None):
        queryset = Category.tree.annotate('group_count': Count('group')})
        queryset = queryset.get_cached_trees()
        return queryset

树是mptt中使用的TreeManager s django-categories,为此,我为此PR编写了稍微复杂一些的代码:https://github.com/callowayproject/django-categories/pull/145/files