如何在Django REST Framework中获取自定义模型管理器的额外字段？

不需要改用基础Serializer，通过以下两步就能解决问题：

1. 在ModelSerializer中显式声明count_comments字段 #

因为count_comments是通过annotate添加的查询集字段，并非模型本身的字段，所以需要在序列化器里显式定义它，让DRF知道要序列化这个字段：

from rest_framework import serializers
from .models import Publication

class PublicationSerializer(serializers.ModelSerializer):
    # 用IntegerField直接读取查询集里的annotate字段，设为只读属性
    count_comments = serializers.IntegerField(read_only=True)

    class Meta:
        model = Publication
        # 包含模型原有字段+count_comments
        fields = ['id', 'title', 'content', 'count_comments']

2. 在分页列表视图中重写get_queryset而非get方法 #

不要直接重写get方法（会跳过DRF内置的分页逻辑），而是重写get_queryset返回带统计字段的查询集，让DRF自动处理分页：

from rest_framework.generics import ListAPIView
from .models import Publication
from .serializers import PublicationSerializer
from .pagination import YourCustomPagination

class PublicationListView(ListAPIView):
    serializer_class = PublicationSerializer
    pagination_class = YourCustomPagination

    def get_queryset(self):
        # 返回自定义管理器处理后的查询集
        return Publication.objects.with_counts()

为什么之前重写get会导致分页失效？ #

DRF的分页逻辑是在get_queryset之后，通过get_paginated_response方法自动处理的。如果直接重写get方法自己构造响应，会绕过这套内置流程，导致分页功能失效。

额外说明 #

如果出于某些原因需要动态计算评论数（不推荐，会产生N+1查询问题），才需要用SerializerMethodField：

count_comments = serializers.SerializerMethodField()

def get_count_comments(self, obj):
    return obj.comments.count()

但优先使用annotate的方式，性能更优。

内容的提问来源于stack exchange，提问作者paulchoix