继承modelviewset后，重写增删改查，在返回值中加入自己想要的信息。

最新推荐文章于 2024-04-29 15:38:44 发布

杨博策

最新推荐文章于 2024-04-29 15:38:44 发布

阅读量1.2k

点赞数 2

文章标签： python django 后端

本文链接：https://blog.csdn.net/weixin_43661701/article/details/129637069

版权

本文展示了如何在DjangoRestFramework的ModelViewSet基础上，自定义创建、删除、修改和查询操作。每个操作都返回包含ID的关键响应数据，如创建成功返回新对象ID，删除和修改成功返回被操作对象ID，查询则返回所有或单个对象的ID。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、创建

# 在继承modelviewset的情况下 重写新增功能，让返回值里增加 新增数据的id
class CustomViewSet(ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    
    def create(self, request, *args, **kwargs):
        serializer = self.get_serializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        # 使用validated_data创建新的对象实例
        instance = serializer.save()
        response_data = {
            'code': 200,
            'id': instance.id,
            'msg': '创建成功'
        }
        headers = self.get_success_headers(serializer.data)
        return Response(response_data, status=status.HTTP_201_CREATED, headers=headers)

"""
这个函数是在一个 Django Rest Framework 中的视图函数中实现的，其作用是创建一个新的对象实例并返回相关的响应数据。这个函数接收一个HTTP请求对象 request，并使用 self.get_serializer 方法获取视图关联的序列化器对象，使用 serializer.is_valid() 方法验证请求中的数据是否符合序列化器的定义，如果验证失败会抛出异常，而如果验证成功，则会使用 serializer.save() 方法创建一个新的对象实例。

之后，视图函数会将创建成功的对象实例的ID及相关信息作为响应数据返回给客户端，并在响应头中设置相关信息，比如状态码(status)、响应头(headers)等等。最后，这个函数将封装好的响应数据返回给客户端。
"""

二、删除

# 在继承modelviewset的情况下 重写删除功能，让返回值里增加被删除数据的id
from rest_framework import status
from rest_framework.response import Response
from rest_framework.viewsets import ModelViewSet

class CustomViewSet(ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    
    # 重写 destroy 方法
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()
        # 获取即将删除的实例的 id
        instance_id = instance.id
        self.perform_destroy(instance)
        # 返回删除成功的响应
        return Response(
            {"id": instance_id, "msg": "删除成功"},
            status=status.HTTP_204_NO_CONTENT,
        )

"""
在这个实现中，我们继承了 Django Rest Framework 中的 ModelViewSet，并重写了其中的 destroy 方法。在这个方法中，我们首先使用 self.get_object() 方法获取要删除的对象实例，并获取该实例的 id 值。然后，我们调用 self.perform_destroy(instance) 方法进行删除操作，并在成功删除后返回一个包含删除成功信息及被删除对象实例 id 的响应数据。

需要注意的是，在这个实现中，我们使用了 status.HTTP_204_NO_CONTENT 作为响应状态码，因为在 RESTful 设计中，删除成功时应该返回 204 状态码，表示删除成功但是没有返回任何数据。
"""

三、修改

# 在继承modelviewset的情况下 重写修改功能，让返回值里增加被修改数据的id

from rest_framework import status
from rest_framework.response import Response
from rest_framework.viewsets import ModelViewSet

class CustomViewSet(ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    
    # 重写 update 方法
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        # 获取即将修改的实例的 id
        instance_id = instance.id
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)
        # 返回修改成功的响应
        return Response(
            {"id": instance_id, "msg": "修改成功"},
            status=status.HTTP_200_OK,
        )

四、查询

# 在继承modelviewset的情况下 重写查询功能，让返回值里增加查询到的数据的id，如果是在url的后面传pk了就返回pk对应的数据，没传就返回查到的所有数据

from rest_framework import status
from rest_framework.response import Response
from rest_framework.viewsets import ModelViewSet

class CustomViewSet(ModelViewSet):
    queryset = MyModel.objects.all()
    serializer_class = MyModelSerializer
    
    # 重写 list 方法
    def list(self, request, *args, **kwargs):
        queryset = self.filter_queryset(self.get_queryset())
        serializer = self.get_serializer(queryset, many=True)
        # 获取查询到的所有实例的 id
        instance_ids = [instance.id for instance in queryset]
        return Response(
            {"id": instance_ids, "data": serializer.data},
            status=status.HTTP_200_OK,
        )

    # 重写 retrieve 方法
    def retrieve(self, request, *args, **kwargs):
        instance = self.get_object()
        # 获取查询到的实例的 id
        instance_id = instance.id
        serializer = self.get_serializer(instance)
        return Response(
            {"id": instance_id, "data": serializer.data},
            status=status.HTTP_200_OK,
        )

"""
在这个实现中，我们继承了 Django Rest Framework 中的 ModelViewSet，并分别重写了其中的 list 方法和 retrieve 方法。在 list 方法中，我们首先获取到查询到的所有实例，并使用列表推导式获取所有实例的 id 值。然后，我们将这些 id 值和序列化后的数据一起返回。

在 retrieve 方法中，我们首先使用 self.get_object() 方法获取要查询的对象实例，并获取该实例的 id 值。然后，我们使用和原先一样的方式进行数据序列化操作，最后在成功查询后返回一个包含查询成功信息及被查询对象实例 id 的响应数据。

需要注意的是，当用户在 url 的后面传了 pk 参数时，将会调用 retrieve 方法，而不是 list 方法，因此在 retrieve 方法中我们只需要返回一个单一实例的信息即可。而当用户没有传递 pk 参数时，将会调用 list 方法，因此在 list 方法中我们需要返回所有实例的信息。
"""