【django开发手册】DRF提升Django查询效率，你需要知道的重要操作

Django专栏

• 💖 作者简介：大家好，我是Zeeland，全栈领域优质创作者。
• 📝 CSDN主页：Zeeland🔥
• 📣 我的博客：Zeeland
• 📚 Github主页: Undertone0809 (Zeeland) (github.com)
• 🎉 支持我：点赞👍+收藏⭐️+留言📝
• 📣 系列专栏：django开发手册🍁
• 💬介绍：The mixture of software dev+Iot+ml+anything🔥

Django系列专栏

• 【django开发手册】Django 中使用自定义用户模型：一个比自带 User 更强的选择
• 【django开发手册】如何使用select_related进行一次连表查询
• 【django开发手册】drf通过添加自定义字段优化DRF序列化器，轻松实现高速API
• 【django开发手册】解决admin添加外键下拉显示外键的问题
• 【Django Rest Framework优化实践】ResponseResult、异常处理方法详解
• 【DRF】深度分析枚举类型在DRF中的序列化问题及解决方案
• 【django开发手册】关于django admin添加表信息的时候外键无法为空的问题解决方案
• 【django开发手册】django admin如何显示外键对应的字段
• 【django开发手册】DRF外键模型查询没有信息？教你实现序列化返回

前言

在Django ORM中，使用prefetch_related可以避免N+1查询问题，提高查询性能。在实际的开发中，我们通常需要在序列化时嵌套使用prefetch_related，将嵌套数据一起序列化出来。

快速上手

以下是一个案例，一个项目Project包含多个Bim模型BimFaceModel，需要在查询Project时同时查询其对应的BimFaceModel信息。

普通的查询代码如下：

class ProjectViewSet(viewsets.ModelViewSet):
    queryset = models.Project.objects.all()
    serializer_class = ProjectSerializer

    def list(self, request, *args, **kwargs):
        queryset = self.filter_queryset(self.get_queryset())

        # 这里是关键，每个查询都会再执行一次查询
        for project in queryset:
            models.BimFaceModel.objects.filter(project_id=project.project_id)

        serializer = self.get_serializer(queryset, many=True)
        return ResponseResult(data=serializer.data).to_response()

可以看到，如果不加处理，每次循环都需要再次查询对应的BimFaceModel信息，会产生N+1查询问题，影响性能。

使用prefetch_related进行优化：

class ProjectViewSet(viewsets.ModelViewSet):
    queryset = models.Project.objects.all()
    serializer_class = ProjectSerializer

    def list(self, request, *args, **kwargs):
        queryset = self.get_queryset().prefetch_related('bimfacemodel_set')
        serializer = self.get_serializer(queryset, many=True)
        return ResponseResult(data=serializer.data).to_response()

可以看到使用prefetch_related方法来提前加载Project对象的bimfacemodel_set属性。然后在序列化时，可以将每个Project对象的bimfacemodel_set一起序列化出来。

但是，在Project模型中，没有bimfacemodel_set这个属性，只是对于每个BimFaceModel都有对应的project_id作为外键。为了嵌套序列化BimFaceModel，需要在ProjectSerializer中使用BimFaceModelSerializer进行嵌套序列化，具体方法请见以下代码：

class BimFaceModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = BimFaceModel
        fields = ('model_id', 'model_name', 'field_id', 'x', 'y', 'z')


class ProjectSerializer(serializers.ModelSerializer):
    bimfacemodel_set = BimFaceModelSerializer(many=True, read_only=True)

    class Meta:
        model = Project
        fields = ('project_id', 'project_name', 'project_description', 'project_img', 'project_address', 'project_price', 'project_company',
                  'project_area', 'project_cycle', 'project_duty_com', 'project_design_com', 'project_check_com', 'project_build_com',
                  'creator_id', 'create_time', 'update_id', 'update_time', 'bimfacemodel_set')

通过上述方式，可以把每个Project对象对应的所有BimFaceModel序列化出来并放到bimfacemodel_set字段中。这样，就避免了N+1查询问题，在序列化数据时，也能够嵌套序列化。