【DRF】 类视图

系列文章目录

第四章 类视图

---

---

类视图

在DRF中，推荐使用类视图，因为类视图可以通过继承的方式把一些重复性的工作抽取出来，而使得代码更加简洁。当然如果你不想使用类视图，那么就用@api_view装饰器包裹一下就可以。

APIView：

APIView是DRF中类视图最基本的父类。基本用法跟Django中自带的View类是一样的。也是自己分别实现get、post等方法。示例代码如下：

class MerchantView(APIView):
    """
    检索, 更新和删除一个merchant实例对象.
    """
    def get_object(self, pk):
        try:
            return Merchant.objects.get(pk=pk)
        except Merchant.DoesNotExist:
            raise Http404

    def get(self, request, pk=None):
        if pk:
            merchant= self.get_object(pk)
            serializer = MerchantSerializer(merchant)
            return Response(serializer.data)
        else:
            queryset = Merchant.objects.all()
            serializer = MerchantSerializer(instance=queryset,many=True)
            return Response(serializer.data)

    def put(self, request, pk):
        merchant = self.get_object(pk)
        serializer = MerchantSerializer(merchant, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk):
        merchant= self.get_object(pk)
        merchant.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

当然APIView中还继承了一些常用的属性，比如authentication_classes、permission_classes、throttle_classes等。

Mixins：

mixins翻译成中文是混入，组件的意思。在DRF中，针对获取列表，检索，创建等操作，都有相应的mixin。示例代码如下：

from .models import Merchant
from .serializers import MerchantSerializer
from rest_framework import mixins
from rest_framework import generics

class MerchantView(
    generics.GenericAPIView,
    mixins.ListModelMixin,
    mixins.RetrieveModelMixin,
    mixins.CreateModelMixin,
    mixins.UpdateModelMixin,
    mixins.DestroyModelMixin
):
    queryset = Merchant.objects.all()
    serializer_class = MerchantSerializer

    def get(self,request,pk=None):
        if pk:
            return self.retrieve(request)
        else:
            return self.list(request)

    def post(self,request):
        return self.create(request)

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

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

以上我们通过继承generics.GenericAPIView，可以设置queryset以及serializer_class，那么视图函数就知道你是要针对哪个模型做处理，你的序列化的类是什么了。接着我们继承mixins.ListModelMixin/CreateModelMixin类，这样MerchantList就拥有了获取列表，以及创建数据的功能。下面我们通过写get和post方法，调用self.list和self.create方法，就可以轻松的实现获取商家列表和创建商家的功能。

Generic类视图：

以上我们通过mixin可以非常方便的实现一些CURD操作。实际上针对这些mixin，DRF还进一步的进行了封装，放到generics下。有以下generic类视图：
generics.ListAPIView：实现获取列表的。实现get方法。
generics.CreateAPIView：实现创建数据的。实现post方法。
generics.UpdateAPIView：实现更新数据的。实现put方法。
generics.DestroyAPIView：实现删除数据的。实现delete方法。
generics.RetrieveAPIView：实现检索数据的。
generics.ListCreateAPIView：实现列表和创建数据的。
generics.RetrieveUpdateAPIView：实现检索和更新数据的。
generics.RetrieveDestroyAPIView：实现检索和删除数据的。
generics.RetrieveUpdateDestroyAPIView：实现检索和更新和删除数据的。
用法如下：

    generics.CreateAPIView,
    generics.UpdateAPIView,
    generics.DestroyAPIView,
    generics.RetrieveAPIView
):
    serializer_class = MerchantSerializer
    queryset = Merchant.objects.all()

那么在定义url与视图映射的时候，还是按照之前的写法就够了：

urlpatterns = [
    path('merchant/',views.MerchantView.as_view()),
    path('merchant/<int:pk>/',views.MerchantView.as_view())
    # path('category',views.goods_category,name="category")
]

请求的url和method产生的结果如下：

method	url	结果
get	/merchant/31/	获取id=31的merchant数据
post	/merchant/	添加新的merchant数据
put	/merchant/31/	修改id=31的merchant数据
delete	/merchant/31	删除id=31的merchant数据

因为这里retrieve占用了get方法，所以如果想要实现获取列表的功能，那么需要再重新定义一个url和视图：

# views.py
class MerchantListView(generics.ListAPIView,):
    serializer_class = MerchantSerializer
    queryset = Merchant.objects.all()

# urls.py
urlpatterns = [
    path('merchant/',views.MerchantView.as_view()),
    path('merchant/<int:pk>/',views.MerchantView.as_view()),
    path('merchants/',views.MerchantListView.as_view())
    ...
]

这也是为什么List和Retrieve不能同时存在一个视图中的原因。

GenericAPIView介绍：

如果想要深入学会generic的一些用法。比如如何分页，如何过滤数据等。那么这时候就需要学习GenericAPIView的使用。

queryset：

queryset是用来控制视图返回给前端的数据。如果没什么逻辑，可以直接写在视图的类属性中，如果逻辑比较复杂，也可以重写get_queryset方法用来返回一个queryset对象。如果重写了get_queryset，那么以后获取queryset的时候就需要通过调用get_queryset方法。因为queryset 这个属性只会调用一次，以后所有的请求都是使用他的缓存。

serializer_class:

serializer_class用来验证和序列化数据的。也是可以通过直接设置这个属性，也可以通过重写get_serializer_class来实现。

lookup_field和lookup_url_kwarg：

lookup_field：是在检索的时候，根据什么参数进行检索。默认是pk，也就是主键。
lookup_url_kwarg：在检索的url中的参数名称。默认没有设置，跟lookup_field保持一致。

分页：

分页是通过设置pagination_class来实现的。默认这个属性的值是rest_framework.pagination.PageNumberPagination，也就是通过控制页码，每页的数量来实现的。我们可以通过在settings.REST_FRAMEWORK中设置PAGE_SIZE来控制每页的数量，然后在url中通过传递page参数来获取指定页数的数据。

重写方法：

1. get_queryset(self)：
   用于动态的返回一个queryset对象。
2. get_object(self)：
   用于在数据检索的时候，返回一条数据的。
3. perform_create(self,serializer)：
   保存对象的时候调用。
4. perform_update(self,serializer)：
   更新对象的时候调用。
5. perform_destroy(self,serializer)：
   删除对象的时候调用。

---