-drf-视图组件

1 视图的作用与继承关系

Django REST framwork提供的视图的主要作用：

• 控制序列化器的执行(检验、保存、转换数据)
• 控制数据库查询的执行

2 视图基类

REST framework提供了众多的通用视图基类与扩展类，以简化视图的编写。

APIView

from rest_framework.views import APIView

APIView是REST framework提供的所有视图的基类，继承自Django的View父类。

APIView与View的不同之处在于：

• 传入到视图方法中的是REST franmework的Request对象，而不是Django的HttpRequeset对象；
• 视图方法可以返回REST framework的Response对象，视图会为响应数据设置（render）符合前端要求的格式；
• 任何APIException异常都会被捕获到，并且处理成合适的响应信息；
• 在进行dispatch()分发前，会对请求进行身份认证、权限检查、流量控制。

支持定义的类属性

• authentication_classes 列表或元祖，身份认证类
• permissoin_classes 列表或元祖，权限检查类
• throttle_classes 列表或元祖，流量控制类

在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。

# re_path('books/(?P<id>\d+)', views.Book.as_view())

class Book(APIView):
    def get(self, request, id):
        book = models.Book.objects.get(id=id)
        ser = serializer.BookModelSerializer(instance=book)
        return Response(ser.data)

GenericAPIView(通用视图类)

from rest_framework.generics import GenericAPIView

继承自APIVIew，主要增加了操作序列化器和数据库查询的方法，与APIView相比作用是为下面Mixin扩展类的执行提供方法支持，以及封装了数据库与序列化器的操作(每个方法如post,get不必重复去操作序列化器与数据库)。通常在使用时，可搭配一个或多个Mixin扩展类。

提供关于序列化器使用的属性与方法

• 属性：

  • serializer_class 指明视图使用的序列化器

• 方法：

  • get_serializer_class(self)

    当出现一个视图类中调用多个序列化器时,那么可以通过条件判断在get_serializer_class方法中通过返回不同的序列化器类名就可以让视图方法执行不同的序列化器对象了。

    返回序列化器类，默认返回serializer_class，可以重写

    def get_serializer_class(self):
        if self.request.user.is_staff:
            return FullAccountSerializer
        return BasicAccountSerializer
    

  • get_serializer(self, *args, **kwargs)

    返回序列化器对象，主要用来提供给Mixin扩展类使用，如果我们在视图中想要获取序列化器对象，也可以直接调用此方法。

    注意，该方法在提供序列化器对象的时候，会向序列化器对象的context属性补充三个数据：request、format、view，这三个数据对象可以在定义序列化器时使用。

    • request 当前视图的请求对象
    • view 当前请求的类视图对象
    • format 当前请求期望返回的数据类型

提供的关于数据库查询的属性与方法

• 属性：

  • queryset 致命使用的数据查询集

• 方法：

  • get_queryset(self)

    返回视图使用的查询集，主要同来提供给Mixin扩展类使用，是列表视图与详情视图获取数据的基础，默认返回queryset属性，可以重写，例如：

    def get_queryset(self):
        user = self.request.user
        return user.accounts.all()
    

  • get_object(self)

    返回详情视图所需的模型类数据对象，主要用来提供给Mixin扩展类使用

    在视图中可以调用该方法获取详情信息的模型类对象

    若详情访问的对象不存在，会返回404

    该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。

class Book(GenericAPIView):
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookModelSerializer

    def get(self, request, *args, **kwargs):

        # book = self.queryset.filter(pk=id).first()
        # =====
        # book = self.get_object()  # 不用专门的参数接收id，自动获取
        book = self.get_queryset()
        print(type(book))
				# serializer实例化需要一个对象，而不是querset数组，所以当只取一条数据的时候需要用						first()转化为book对象，queryset也需要经过get_queryset转换成一个
        # <class 'django.db.models.query.QuerySet'>对象
        ser = self.get_serializer(instance=book, many=True)
        return Response(ser.data)

    def post(self, request):
        res = {'code': 100, 'msg': '保存成功'}
        # 反序列化称为一个对象
        # print(request.data['publish_id'])
        ser = self.get_serializer(data=request.data)

        if ser.is_valid():
            ser.save()
            res['result'] = ser.data  # 序列化输出
        else:
            res['code'] = 109
            res['msg'] = str(ser.errors)
        return Response(res)

其他可以设置的属性

• pagination_class 指明分页控制类
• filter_backends 指明过滤控制后端

我们用GenericAPIView可以省去每个方法中重复使用序列化器以及调用数据库的过程，但每个方法还是需要重复的去调用这个封装好的接口，于是就有了视图扩展类将几个方法封装起来，只需要继承即可调用。

3 5个视图扩展类

作用：

提供了几种后端视图(对数据资源进行增删查改)处理流程的实现，如果编写的视图属于这五种，则视图可以通过继承相应的扩展类来复用代码，减少自己编写的代码量。

这五个扩展类需要搭配GenericAPIView父类，因为五个扩展类的实现需要调用GenerricAPIView提供的序列化器以及数据库查询的方法

1）ListModeMixin

列表视图扩展类，提供list(request, *args, **kwargs)方法快速实现列表视图，返回200状态码。

该Mixin的list方法会对数据进行过滤和分页。

from rest_framework.mixins import ListModelMixin

源代码：

class ListModelMixin:
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
      # 过滤后，获取instance对象
        queryset = self.filter_queryset(self.get_queryset())

        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
				# 序列化器实例化对象
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)
      
# 由此基本的两步在list中实现，所以只要继承ListModelMixin后调用该list方法即可

举例：

from rest_framework.mixins import ListModelMixin

# ListModelMixin源码中是调用了GenericAPIView中查询数据库以及序列化器操作的基础下实现的
class BookListView(ListModelMixin, GenericAPIView):
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookModelSerializer

    def get(self, request):
        # 继承ListModelMixin后调用list方法，省去了调用得到数据对象以及序列化器接口的操作
        return self.list(request)

2) CreateModelMixin

创建视图扩展类，提供create(request, *args, **kwargs)方法快速实现创建资源的视图，成功返回201状态码。

如果序列化器对前端发送的数据验证失败，返回400错误。

from rest_framework.mixins import CreateModelMixin

源代码：

class CreateModelMixin:
    """
    Create a model instance.
    """
    def create(self, request, *args, **kwargs):
      	# 获取序列化器
        serializer = self.get_serializer(data=request.data)
        # 校验数据的合法性，不合法返回400错误
        serializer.is_valid(raise_exception=True)
        # 保存校验完全的数据
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(self, serializer):
        serializer.save()

    def get_success_headers(self, data):
        try:
            return {'Location': str(data[api_settings.URL_FIELD_NAME])}
        except (TypeError, KeyError):
            return {}
          
# 由此CreateModelMixin中的方法create基本实现了保存数据的操作，从获取序列化器到校验数据再到保存数据，所以只需要继承类后，调用该方法即可

举例：

class BookListView(ListModelMixin, GenericAPIView, CreateModelMixin):
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookModelSerializer

    def get(self, request):
       
        return self.list(request)
		# post方法与get不冲突，可同时继承
    def post(self, request):
        return self.create(request)

3) RetrieveModelMixin

详情视图扩展类，提供retrieve(request, *args, **kwargs)方法，可以快速实现返回一个存在的数据对象。ListModeMixin获取所有数据，RetrieveModelMixin获取单条数据，其路由需要传入该数据的id

如果存在，返回200， 否则返回404。

from rest_framework.mixins import RetrieveModelMixin

源代码：

class RetrieveModelMixin:
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 获取对象，会检查对象的权限
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)

举例：

class BookDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookModelSerializer
		# 重新定义一个类，与上个类get查询冲突,pk由方法retrieve中的self.get_object()自动接收
    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

4）UpdateModelMixin

更新视图扩展类，提供update(request, *args, **kwargs)方法，可以快速实现更新一个存在的数据对象。

同时也提供partial_update(request, *args, **kwargs)方法，可以实现局部更新。

成功返回200，序列化器校验数据失败时，返回400错误。

from rest_framework.mixins import UpdateModelMixin

源代码：

class UpdateModelMixin:
    """
    Update a model instance.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        # 得到需要更新的对象
        instance = self.get_object()
        # 传入该对象以及更新的数据
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        # 校验更新数据
        serializer.is_valid(raise_exception=True)
        # 通过后保存其数据
        self.perform_update(serializer)

        if getattr(instance, '_prefetched_objects_cache', None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache = {}

        return Response(serializer.data)

    def perform_update(self, serializer):
        serializer.save()

    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)

举例:

class BookDetailView(RetrieveModelMixin, GenericAPIView, UpdateModelMixin):
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookModelSerializer

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

    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

5) DestroyModelMixin

删除视图扩展类，提供destroy(request, *args, **kwargs)方法，可以快速实现删除一个存在的数据对象。

成功返回204，不存在返回404。

from rest_framework.mixins import DestroyModelMixin

源代码：

class DestroyModelMixin:
    """
    Destroy a model instance.
    """
    def destroy(self, request, *args, **kwargs):
        # 通过pk直接得到该对象，pk被self.get_object()自动接收
        instance = self.get_object()
        # 调用方法删除
        self.perform_destroy(instance)
        return Response(status=status.HTTP_204_NO_CONTENT)

    def perform_destroy(self, instance):
        instance.delete()

举例：

class BookDetailView(RetrieveModelMixin, GenericAPIView, UpdateModelMixin, DestroyModelMixin):
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookModelSerializer

    def get(self, request, pk):
        return self.retrieve(request, pk)

    def put(self, request, pk):
        return self.update(request, pk)
		# 直接继承后调用父类delete方法
    def delete(self, request, pk):
      	return self.destroy(request, pk)  # 最好用pk
        # return self.delete(request, *args, **kwargs)
        # 记得UpdateModelMixin中的方法是self.destroy(request, *args, **kwargs)
        # 如果手误写成delete就会循环调用自己

4 GenericAPIView的视图子类

1）CreateAPIView

提供post方法

继承自：GenericAPIView(封装了数据库操作以及序列化器的操作，只需操作接口调用)、
CreateModelMixin(在GenericAPIView，有create方法，省略了调用接口的步骤)
后续的基本相似

作用：创建数据对象

2） ListAPIView

提供get方法

继承自：GenericAPIView、ListModelMixin

作用：查看所有的数据对象

3）RetrieveAPIView

提供get方法

继承自: GenericAPIView、RetrieveModelMixin

作用：检验当前传入id的某条数据对象，有则序列化后返回202到前端，没有则返回404

4）DestoryAPIView

提供delete方法

继承自：GenericAPIView、DestoryModelMixin

作用：根据当前传入的id删除某一个数据对象

5）UpdateAPIView

提供put和patch方法

继承自：GenericAPIView、UpdateModelMixin

作用：根据当前传入的id更新某一个数据对象

6）RetrieveUpdateAPIView

提供 get、put、patch方法

继承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin

作用：根据当前传入的id更新或是查询某一个数据对象

7）RetrieveUpdateDestoryAPIView

提供 get、put、patch、delete方法

继承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

作用：根据当前传入的id更新、查询或删除某一个数据对象

5 视图集ViewSet

使用视图集ViewSet，可以将一系列逻辑相关的动作放到一个类中：

• list() 提供一组数据
• retrieve() 提供单个数据
• create() 创建数据
• update() 保存数据
• destory() 删除数据

ViewSet视图集类不再实现get()、post()等方法，而是实现动作 action 如 list() 、create() 等。

视图集只在使用as_view()方法的时候，才会将action动作与具体请求方式对应上。如：

from rest_framework.viewsets import ViewSet
'''
class ViewSet(ViewSetMixin, views.APIView):
    """
    The base ViewSet class does not provide any actions by default.
    """
    pass

# 导一个ViewSet相当于导入了ViewSetMixin, views.APIView，所以只需要导入ViewSet

'''

class BookInfo(ViewSet):
    def list(self, request):
        books = models.Book.objects.all()
        ser = serializer.BookModelSerializer(instance=books, many=True)
        print(self.action) # list
        return Response(ser.data)
      
# 部分源码解析   
'''
            for method, action in actions.items():
                handler = getattr(self, action) # 得到当前动作的内存地址的变量名
                setattr(self, method, handler)	# 将method映射给handler
                																			get-->list
                																# 然后直接通过list就可以调用get方法了
                              
'''

设置路由的操作：

urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', views.BookInfo.as_view({'get': 'list'}))
]

6 常用视图集父类

1）ViewSet

继承自APIView与ViewSetMixin(重写了as_view,可以通过映射获取请求方式)，作用也与APIView基本类似，提供了身份认证、全向校验、流量管理等。

ViewSet主要通过继承ViewSetMixin来实现在调用as_view()时传入字典（如{‘get’:’list’}）的映射处理工作。

在ViewSet中，没有提供任何动作action方法，需要我们自己实现action方法。

2）GenericViewSet

使用ViewSet通常并不方便，因为list、retrieve、create、update、destroy等方法都需要自己编写，而这些方法为之前讲过的Mixin扩展类提供的方法同名，且内部实现方式也大差不差，所以我们可以通过继承Mixin扩展类来复用这样方法而无需自己编写。但是Mixin扩展类还需要GenericViewSet去封装数据库的操作以及序列化器的操作，所以还需要继承GenericViewSet。

GenericViewSet就帮助我们完成了这样的继承工作，继承自GenericAPIView与ViewSetMixin，在实现了调用as_view()时传入字典（如{'get':'list'}）的映射处理工作的同时，还提供了GenericAPIView提供的基础方法，可以直接搭配Mixin扩展类使用。

举个栗子：

# views.py

from app10 import models
from app10 import serializer
from rest_framework.mixins import ListModelMixin
from rest_framework.mixins import CreateModelMixin
from rest_framework.mixins import RetrieveModelMixin
from rest_framework.mixins import UpdateModelMixin
from rest_framework.mixins import DestroyModelMixin
from rest_framework.viewsets import GenericViewSet

class BookInfo(GenericViewSet, ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin,
               DestroyModelMixin):
    queryset = models.Book.objects.all()
    serializer_class = serializer.BookModelSerializer

url配置

from django.contrib import admin
from django.urls import path, re_path
from app10 import views

urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', views.BookInfo.as_view({"get": "list", "post": "create"})),
    re_path('books/(?P<pk>\d+)',views.BookInfo.as_view({"get": "retrieve","put":"update","delete":"destroy"}))
]

视图层BookInfo继承了所有动作所在的类，如果要一一实现还需要，再根据请求方式在BookInfo中写对应的方法，比如get---->list，但是通过GenericViewSet(继承了ViewSetMixin, generics.GenericAPIView)可以产生get与list的映射关系，即调用了list就是调用了get，那么我们只需在url配置相关的映射关系，那么在视图中就不需要写get方法去对应请求方式，因为此时get就是list，可以直接映射到父类中的list然后产生调用，所以如上述当我们继承了所有方法的类后，就可以进行所有增删查改的操作，只需要主要是单挑数据还是所有数据的url匹配。

3）ModelViewSet

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

from rest_framework.viewsets import ModelViewSet

4）ReadOnlyModelViewSet

继承自GenericViewSet，同时包括了ListModelMixin、RetrieveModelMixin。

from rest_framework.viewsets import ReadOnlyModelViewSet

7 action动作

视图集中定义附加action动作

在视图集中，除了上述默认的方法动作外，还可以添加自定义动作。

举例：

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):
        """学生登录功能"""
        return Response({"message":"登录成功"})

url的定义

urlpatterns = [
    path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students8/(?P<pk>\d+)/",
            views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),

    path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))

]

action属性

在视图集中，我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。

例如：

from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def get_new_5(self,request):
        """获取最近添加的5个学生信息"""
        # 操作数据库
        print(self.action) # 获取本次请求的视图方法名

8 总结

#两个基类
APIView
GenericAPIView：有关数据库操作，queryset 和serializer_class


#5个视图扩展类(rest_framework.mixins)
CreateModelMixin：create方法创建一条
DestroyModelMixin：destory方法删除一条
ListModelMixin：list方法获取所有
RetrieveModelMixin：retrieve获取一条
UpdateModelMixin：update修改一条

#9个子类视图(rest_framework.generics)
CreateAPIView:继承CreateModelMixin,GenericAPIView，有post方法，新增数据
DestroyAPIView：继承DestroyModelMixin,GenericAPIView，有delete方法，删除数据
ListAPIView：继承ListModelMixin,GenericAPIView,有get方法获取所有
UpdateAPIView：继承UpdateModelMixin,GenericAPIView，有put和patch方法，修改数据
RetrieveAPIView：继承RetrieveModelMixin,GenericAPIView，有get方法，获取一条


ListCreateAPIView：继承ListModelMixin,CreateModelMixin,GenericAPIView，有get获取所有，post方法新增
RetrieveDestroyAPIView：继承RetrieveModelMixin,DestroyModelMixin,GenericAPIView，有get方法获取一条，delete方法删除
RetrieveUpdateAPIView：继承RetrieveModelMixin,UpdateModelMixin,GenericAPIView，有get获取一条，put，patch修改
RetrieveUpdateDestroyAPIView：继承RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin,GenericAPIView，有get获取一条，put，patch修改，delete删除

#视图集
ViewSetMixin：重写了as_view 
ViewSet：     继承ViewSetMixin和APIView

GenericViewSet：继承ViewSetMixin, generics.GenericAPIView
ModelViewSet：继承mixins.CreateModelMixin,mixins.RetrieveModelMixin,mixins.UpdateModelMixin,mixins.DestroyModelMixin,mixins.ListModelMixin,GenericViewSet
ReadOnlyModelViewSet：继承mixins.RetrieveModelMixin,mixins.ListModelMixin,GenericViewSet