Django新手求助：如何基于ModelViewSet自定义按班级名查询的详情视图集

1. 确保班级名称唯一（可选但强烈建议） #

要通过班级名称查询单个班级，首先给Class模型的name字段添加唯一约束，避免同名班级导致查询冲突：

class Class(models.Model):
    name = models.CharField(max_length=128, unique=True)  # 添加unique=True
    students = models.ManyToManyField("Student")
 
    def __str__(self) -> str:
        return self.name

执行迁移命令更新数据库：

python manage.py makemigrations
python manage.py migrate

2. 配置序列化器 #

确保ClassSerializer能正确序列化关联的学生数据，假设已有StudentSerializer，可以嵌套使用：

from rest_framework import serializers
from .models import Class, Student

class StudentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = '__all__'  # 也可指定具体字段，比如'id', 'name'

class ClassSerializer(serializers.ModelSerializer):
    students = StudentSerializer(many=True, read_only=True)  # 嵌套序列化学生列表

    class Meta:
        model = Class
        fields = ['id', 'name', 'students']  # 必须包含students字段以返回学生数据

3. 修改ViewSet，指定按名称查询 #

默认ModelViewSet的详情视图用主键（pk）查询，我们需要修改lookup_field为name，让它通过班级名称匹配资源：

from rest_framework import viewsets
from .models import Class
from .serializers import ClassSerializer

class ClassViewSet(ModelViewSet):
    serializer_class = ClassSerializer
    queryset = Class.objects.all()
    lookup_field = 'name'  # 指定用name作为查询字段

4. 配置路由 #

使用DRF的默认路由注册ClassViewSet，自动生成包含详情视图的路由：

from django.urls import path, include
from rest_framework.routers import DefaultRouter
from .views import ClassViewSet

router = DefaultRouter()
router.register(r'classes', ClassViewSet)  # 路由前缀为classes

urlpatterns = [
    path('', include(router.urls)),
]

测试API #

现在可以通过GET请求访问/classes/{班级名称}/获取指定班级的详情及学生列表，例如：

GET /classes/高一1班/

响应会包含班级名称和对应的学生数组。

特殊情况处理（无唯一约束时） #

如果无法给name加唯一约束，可重写get_object方法处理同名班级场景（不推荐，详情视图应返回单个资源）：

from rest_framework.exceptions import Http404

class ClassViewSet(ModelViewSet):
    serializer_class = ClassSerializer
    queryset = Class.objects.all()
    lookup_field = 'name'

    def get_object(self):
        queryset = self.get_queryset()
        filter_kwargs = {self.lookup_field: self.kwargs[self.lookup_field]}
        obj = queryset.filter(**filter_kwargs).first()
        if obj is None:
            raise Http404("班级不存在")
        self.check_object_permissions(self.request, obj)
        return obj

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