如何用Django实现返回发帖用户占比的API接口

问题背景 #

现有内置User模型及自定义Post模型：

class Post(models.Model):
    post_date = models.DateTimeField(default=timezone.now)
    user = models.ForeignKey(User, on_delete=models.CASCADE, null=True, related_name='user_post')
    post = models.CharField(max_length=100)

需求是开发一个API接口，返回发帖用户占总用户的百分比，计算公式为：(发帖的唯一用户数 ÷ 总用户数) × 100。

用户尝试使用annotate和aggregate方法未得到正确结果，仅能获取每个用户的发帖数或单条帖子对应的用户数。当前使用PostParticipationAPIView继承ListAPIView的代码如下：

class PostParticipationAPIView(generics.ListAPIView):
    queryset = Post.objects.all()
    serializer_class = PostSerializer
            
    def get_queryset(self):
        start_date = self.request.query_params.get('start_date')
        end_date = self.request.query_params.get('end_date')
        # How can I take something like this, divide it by User.objects.all().count() * 100, and assign it to something to return as the queryset?
        queryset = Post.objects.filter(post_date__gte=start_date, post_date__lte=end_date).distinct('user').count()         
        return queryset

期望返回格式：

{
total_participation: 97.3
}

后续尝试自定义序列化器添加DecimalField字段时出现AttributeError，改用SerializerMethodField后返回结果随查询集数量重复，返回自定义数据时出现按字符串字符迭代的问题，需要正确的实现方式。

正确实现方式 #

1. 改用APIView而非ListAPIView #

因为不需要返回列表数据，只是单个统计值，用APIView更合适，避免ListAPIView强制返回查询集导致的迭代问题。

2. 编写视图逻辑 #

from rest_framework.views import APIView
from rest_framework.response import Response
from django.db.models import Count
from django.utils import timezone

class PostParticipationAPIView(APIView):
    def get(self, request):
        start_date = request.query_params.get('start_date')
        end_date = request.query_params.get('end_date')
        
        # 过滤时间范围内的帖子
        filtered_posts = Post.objects.all()
        if start_date:
            filtered_posts = filtered_posts.filter(post_date__gte=start_date)
        if end_date:
            filtered_posts = filtered_posts.filter(post_date__lte=end_date)
        
        # 用aggregate+Count+distinct统计唯一发帖用户数
        active_users = filtered_posts.aggregate(
            unique_users=Count('user', distinct=True)
        )['unique_users'] or 0
        
        # 总用户数（可根据需求排除超级管理员等特殊用户）
        total_users = User.objects.count() or 1  # 避免除以0报错
        
        # 计算百分比并保留1位小数
        participation_rate = round((active_users / total_users) * 100, 1)
        
        return Response({'total_participation': participation_rate})

3. 无需自定义序列化器 #

直接通过Response返回字典格式即可，完全符合期望的返回结构。

关键说明 #

• 使用Count('user', distinct=True)直接在数据库层面统计唯一用户数，比distinct('user').count()更高效，数据量大时优势明显。
• 处理total_users为0的边界情况，避免除以0抛出异常。
• 用APIView可以自由控制返回数据，不会出现ListAPIView要求返回查询集导致的重复或迭代问题。

内容的提问来源于stack exchange，提问作者Bring Coffee Bring Beer