django rest framework-基于视图的类

前面我们说过装饰API视图:
REST framework提供了两种封装器，你可以使用他们写views

1. @api_view装饰器用在基于视图的方法上;
2. APIView 装饰器用在类view中;
   一般我习惯用类视图写比较方便，除了一些单独操作的用方法写。
   我们先来看column模型相关操作。

定义视图类

from article.models import Column
from .serializers import ColumnSerializer
from rest_framework.views import APIView

class ColumnView(APIView):
    def get(self, request):
        # 获取queryset
        columns = Column.objects.all()
        # 开始序列化；
        serializer_data = ColumnSerializer(columns, many=True)
        print(serializer_data)
        print(serializer_data.data)
        # 获取序列化后的数据，返回给客户端
        return Response(serializer_data.data)

    def post(self, request):
        # 获取数据
        client_data = request.data
        print(client_data)
        # 序列化数据
        verified_data = ColumnSerializer(data=client_data)
        print(verified_data)

        # 校验数据
        if verified_data.is_valid():

            column = verified_data.save()

            print(verified_data.data)  #需要保存之后才能获取.data

            return Response(verified_data.data)
        else:
            return Response(verified_data.errors, status=400)


class ColumnFilterView(APIView):
    def get(self, request, column_id):
        column_obj = Column.objects.get(pk=column_id)
        serializer_data = ColumnSerializer(column_obj) # 这是单个实例，不需要many=True，默认不写为False

        return Response(serializer_data.data)

    def put(self, request, column_id):
        column_obj = Column.objects.get(pk=column_id)
        verified_data = ColumnSerializer(instance=column_obj, data=request.data)  # 这是单个实例，不需要many=True，默认不写为False

        if verified_data.is_valid():
            verified_data.save()
            return Response(verified_data.data)
        else:
            return Response(verified_data.errors)

    def delete(self, request, column_id):
        print(request.data) # <QueryDict: {'link_url': ['http://www.qmpython.com'], 'index': ['8'], 'name': ['REST测试111']}>

        Column.objects.get(pk=column_id).delete()
        return  Response()

写了2个视图ColumnView用户获取column数据列表，ColumnFilterView用于针对某一个实例进行查询，修改，删除操作。

序列化

class ColumnSerializer(serializers.ModelSerializer):
    class Meta:
        model = Column
        fields = ['id','name', 'link_url', 'index']

URL配置

urlpatterns = [
    path('columns/', ColumnView.as_view(), name='columns'),
    path('columns/<int:column_id>/', ColumnFilterView.as_view(), name='columns_filter'),
]

测试

1. get获取一条记录

   
   image.png

2. put修改一条记录

   
   image.png

3.delete一条记录

image.png

从上可以看出视图中有增删改查，在我们实际中多数都是crud操作，而很多都是差不多，我们不得不重复编写代码，为了避免重复编写，提高可复用，我们可以用到mixinis类将常见的实现。

使用mixnis

基于类视图的一大好处是，允许我们快速创建可复用行为，我们使用的create/retrieve/update/delete操作
和我们任何后端模型API视图非常相似，这些常见操作在rest框架是通过mixin类中实现的。

改写视图

from article.models import Column
from .serializers import ColumnSerializer
from rest_framework.views import APIView


class ColumnView(mixins.ListModelMixin,
                 mixins.CreateModelMixin,
                 generics.GenericAPIView):

    queryset = Column.objects.all()  # 查询结果集
    serializer_class = ColumnSerializer # 序列化类

    def get(self, request, *args, **kwargs):
        return self.list(request, * args, ** kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)



class ColumnFilterView(mixins.RetrieveModelMixin,
                       mixins.UpdateModelMixin,
                       mixins.DestroyModelMixin,
                       generics.GenericAPIView):

    queryset = Column.objects.all()
    serializer_class = ColumnSerializer

    def get(self, request, pk):  # 记住url和这传递的是pk字段，不能是其他字段
        return self.retrieve(request)

    def put(self, request, pk):
        return self.update(request)


    def delete(self, request, pk):
        return self.destroy(request)

url配置

urlpatterns = [
    path('columns/', ColumnView.as_view(), name='columns'),
    path('columns/<int:pk>/', ColumnFilterView.as_view(), name='columns_filter'),
]

测试结果

通过在postman中测试结果和实现的效果一样。

小结

代码看起来更加简洁，我们使用GenericAPIView 类来提供核心的功能，然后使用mixins类来提供增删改查的功能，我们只需要定义好请求方法，对应的功能直接调用mixins类中的方法即可。

1）ListModelMixin
列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。
该Mixin的list方法会对数据进行过滤和分页。
2）CreateModelMixin
创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。
如果序列化器对前端发送的数据验证失败，返回400错误。
3） RetrieveModelMixin
详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。
如果存在，返回200， 否则返回404。
4）UpdateModelMixin
更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。
同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。
成功返回200，序列化器校验数据失败时，返回400错误。
5）DestroyModelMixin
删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。
成功返回204，不存在返回404。

使用通用类视图

使用mixin类，我们重写了视图以使用比以前少一点的代码，但我们可以进一步。 REST框架提供了一组已经混合的通用视图。来进一步修改我们的视图。

类视图：

class ColumnView(generics.ListCreateAPIView):

    queryset = Column.objects.all()  # 查询结果集
    serializer_class = ColumnSerializer # 序列化类

class ColumnFilterView(generics.RetrieveUpdateDestroyAPIView):

    queryset = Column.objects.all()
    serializer_class = ColumnSerializer

这个代码更加简洁,generics.ListCreateAPIView实际上继承了mixins中的mixins.ListModelMixin,mixins.CreateModelMixin,等于在又把mixins类根据get post put delete请求方式重新封装了一层。更加减少了我们的代码量。

url配置

urlpatterns = [
    path('columns/', ColumnView.as_view(), name='columns'),
    path('columns/<int:pk>/', ColumnFilterView.as_view(), name='columns_filter'),
]

注意：使用mixin和通用视图针对某一条传参需要穿固定pk字段。或者如果不传固定的PK，例如
我们路由这么写

      path('user/detail/', UserDetailView.as_view(), name='user_detail'),

对应视图则需要重写get_object方法，不使用pk值返回对象

    def get_object(self):
        """
        重写get_object,不使用pk值返回user
        因为查看某个对象具体详情，默认URL是需要配置类似
            path('users/<int:pk>/', UserDetailView.as_view(), name='user_detail'),
            但是这里我们没有使用Pk
        :return:
        """
        return self.request.user

否则会报错
AssertionError: Expected view UserDetailView to be called with a URL keyword argument named "pk". Fix your URL conf, or set the.lookup_fieldattribute on the view correctly.