6） 视图家族 路由组件
视图家族
1、视图类：APIView、GenericAPIView 干了哪些事： APIView：作为drf的基础view； as_view()禁用csrf； dispatch()二次封装request、三大认证、解析、渲染、响应、异常等模块； 源码顶部一堆类属性，可以用来做全局或局部插拔配置 GenericAPIView：继承APIView所有； 新增三个方法三个属性，这些不是为了给自己用的，是给mixins工具集用 2、视图工具集：mixin五大工具类(六个方法) list：群查 retrieve：单查 create：单增 destroy：单删，基本不会用，即使用也是重写 update：单整体改 partial_update：单局部改 前提：工具类都是由GenericAPIView的子类来继承 3、工具视图：Generic各种子类 ListAPIView(ListModelMixin, GenericAPIView):继承该类的视图类，只需要提供几个类属性，就可以完成群查，不需要书写get方法 ListCreateAPIView(ListModelMixin, CreateModelMixin, GenericAPIView) 4、视图集：ViewSet、GenericViewSet ViewSetMixin：重写as_view()，可以将请求方法与视图类中的自定义函数名完成映射 as_view({'get': 'list', 'post': 'my_post'}) GenericViewSet：可以自定义请求映射的Model操作视图集 ViewSet：可以自定义请求映射的任意操作视图集（一般与Model操作不是那么密切相关） 登陆的post并非新增、短信的验证码(get或post)都和model无关
一、GenericAPIView基类
# GenericAPIView是继承APIView的，使用完全兼容APIView # 重点：GenericAPIView在APIView基础上新增三个方法： # 1）get_queryset()：从类属性queryset中获得model的queryset数据 # 2）get_serializer()：从类属性serializer_class中获得serializer的序列化类 # 3）get_object()：从类属性queryset中获得model的queryset数据，再通过有名分组pk确定唯一操作对象
urlpatterns = [ url(r'^v2/books/$', views.BookGenericAPIView.as_view()), url(r'^v2/books/(?P<pk>.*)/$', views.BookGenericAPIView.as_view()), ]
view.py
from utils.response import APIResponse # 导入自己封装的response from . import models, serializers from rest_framework.generics import GenericAPIView class BookGenericAPIView(GenericAPIView):
# 新增三个属性： # 1.源码内部，服务于get_queryset() queryset = models.Book.objects.filter(is_delete=False) # 2.源码内部，声明序列化类，服务于get_serializer() serializer_class = serializers.BookModelSerializer # 3.自定义主键的 有名分组的名，源码中只认识pk如果路由中写的id，这里将pk改为id，和url中分组名称对应上就好，服务于get_object() lookup_field = 'pk' # 群取 # def get(self, request, *args, **kwargs): # book_query = self.get_queryset() # 固定方法，直接就拿到了，不需要你自己用pk去查 # book_ser = self.get_serializer(book_query, many=True) # 简化方法，参数该怎么穿还是怎么穿 # book_data = book_ser.data # 自动根据pk获取相对应的数据 # return APIResponse(results=book_data) # 单取 def get(self, request, *args, **kwargs): book_query = self.get_object() book_ser = self.get_serializer(book_query) book_data = book_ser.data return APIResponse(results=book_data) # 使用自己二次封装的response
二、mixins视图工具集 - 辅助GenericAPIView
# 1）mixins有五个工具类文件，一共提供了五个工具类，六个工具方法：单查、群查、单增、单删、单整体改、单局部改 # 2）继承工具类可以简化请求函数的实现体，但是必须继承GenericAPIView，需要GenericAPIView类提供的几个类属性和方法(见上方GenericAPIView基类知识点) # 3）工具类的工具方法返回值都是Response类型对象，如果要格式化数据格式再返回给前台，可以通过 response.data 拿到工具方法返回的Response类型对象的响应数据 # 4）ListModelMixin （群查）, CreateModelMixin, RetrieveModelMixin （单查）, UpdateModelMixin，DestroyModelMixin（这个是真的删除，所以永远不会用，即使用也是重写）
api / views.py
urlpatterns = [ url(r'^v3/books/$', views.BookMixinGenericAPIView.as_view()), url(r'^v3/books/(?P<pk>.*)/$', views.BookMixinGenericAPIView.as_view()), ] from rest_framework.mixins import ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin class BookMixinGenericAPIView(ListModelMixin, CreateModelMixin, RetrieveModelMixin, UpdateModelMixin, GenericAPIView): queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer def get(self, request, *args, **kwargs): # 单查 if 'pk' in kwargs: response = self.retrieve(request, *args, **kwargs) # 群查 else: # mixins提供的list方法的响应对象是Response，想将该对象格式化为APIResponse response = self.list(request, *args, **kwargs) # response的数据都存放在response.data中 return APIResponse(results=response.data) # 我们自己封装的方法，状态码和msg默认了，看二次封装那一块可以看到 # 单增 def post(self, request, *args, **kwargs): response = self.create(request, *args, **kwargs) return APIResponse(results=response.data) # 单整体改 def put(self, request, *args, **kwargs): response = self.update(request, *args, **kwargs) return APIResponse(results=response.data) #单局部改 def patch(self, request, *args, **kwargs): response = self.partial_update(request, *args, **kwargs) return APIResponse(results=response.data)
三、 工具视图 ListCreateAPIView, UpdateAPIView
# 1）工具视图都是GenericAPIView的子类，且不同的子类继承了不同的工具类，重写了请求方法 # 2）内部自带get、post、put、patch请求处理方法，工具视图的功能如果直接可以满足需求，只需要继承工具视图，
提供queryset与serializer_class即可完成群查等一系列操作，不需要自己写get等方法
路由
urlpatterns = [ url(r'^v4/books/$', views.BookListCreatePIView.as_view()), url(r'^v4/books/(?P<pk>.*)/$', views.BookListCreatePIView.as_view()), ]
api / views.py
from rest_framework.generics import ListCreateAPIView, UpdateAPIView class BookListCreatePIView(ListCreateAPIView, UpdateAPIView): queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer
四、 视图集 GenericViewSet、ViewSet
1. GenericViewSet 实现 单和群 操作解耦
# 1）视图集都是优先继承ViewSetMixin类，再继承一个视图类（GenericAPIView或APIView） # 2）ViewSetMixin提供了重写的as_view()方法，继承视图集的视图类，配置路由时调用as_view()必须传入 请求名-函数名 映射关系字典 # eg: url(r'^v5/books/$', views.BookGenericViewSet.as_view({'get': 'my_get_list'})), # 表示get请求会交给my_get_list视图函数处理
路由
urlpatterns = [ # View的as_view()：将get请求映射到视图类的get方法 # ViewSet的as_view({'get': 'my_get_list'})：将get请求映射到视图类的my_get_list方法 # get后只能映射一个函数，一一对应，单和群直接解耦，函数指名道姓，下面我们拿单查和群查举例 url(r'^v5/books/$', views.BookGenericViewSet.as_view({'get': 'my_get_list'})), url(r'^v5/books/(?P<pk>.*)/$', views.BookGenericViewSet.as_view({'get': 'my_get_obj'})), ]
api / views.py
from rest_framework.viewsets import GenericViewSet from rest_framework import mixins
class BookGenericViewSet(mixins.RetrieveModelMixin, mixins.ListModelMixin, GenericViewSet): queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer # 群查 def my_get_list(self, request, *args, **kwargs): return self.list(request, *args, **kwargs) # 单查 def my_get_obj(self, request, *args, **kwargs): return self.retrieve(request, *args, **kwargs) # 同理 只要是 http_method_names = ['get', 'post', 'put', 'patch', 'delete', 'head', 'options', 'trace'] 中的请求 ，我们都可以这样写两个，单和群分开
2. GenericAPIView 与 APIView 两大继承视图的区别
#源码 class GenericViewSet(ViewSetMixin, generics.GenericAPIView): pass class ViewSet(ViewSetMixin, views.APIView): pass
# 1）GenericViewSet和ViewSet都继承了ViewSetMixin，as_view都可以配置 请求-函数 映射 # 2）GenericViewSet继承的是GenericAPIView视图类，这里面有个标标准准的 queryset和serializer，标准的models类操作、需要序列化的走这个 # 3）ViewSet继承的是APIView视图类，用来完成不需要 model 类参与，或是非标准的 model 类操作接口（比如登录 ） # post请求代表新增接口时是标准的 model 类操作， # post请求验证码的接口，不需要 model 类的参与（转给第三方发短信），或是需要参与但不是正经那种 # 案例：登陆的post请求，并不是完成数据的新增，只是用post提交数据，得到的结果也不是登陆的用户信息，而是登陆的认证信息，不标准就走ViewSet
五、工具视图集 ModelViewSet
# 源码 配了五个，齐了（上面我们自定义的类只继承了两个） class ModelViewSet(mixins.CreateModelMixin, mixins.RetrieveModelMixin, mixins.UpdateModelMixin, mixins.DestroyModelMixin, mixins.ListModelMixin, GenericViewSet):
路由
urlpatterns = [ url(r'^v6/books/$', views.BookModelViewSet.as_view({'get': 'list', 'post': 'create'})), url(r'^v6/books/(?P<pk>.*)/$', views.BookModelViewSet.as_view({'get': 'retrieve', 'put': 'update', 'patch': 'partial_update','delete':'destroy'})), ]
api / views.py
from rest_framework.viewsets import ModelViewSet class BookModelViewSet(ModelViewSet): queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer # 删不是数据库，而是该记录中的删除字段，自带的是真的删除了，我们就重写 def destroy(self, request, *args, **kwargs): instance = self.get_object() # type: models.Book if not instance: return APIResponse(1, '删除失败') # 实际操作，在此之前就做了判断 instance.is_delete = True instance.save() return APIResponse(0, '删除成功')
六、 路由组件（了解）
# 下面五句话相当于写了这两句，并且他在源码里写死了，只能写标标准准的请求接口，不像我们常用路由方法的可以自定义，我们不使用，但是见到别人用要知道怎么回事 url(r'^v6/books/$', views.BookModelViewSet.as_view({'get': 'list', 'post': 'create'})), url(r'^v6/books/(?P<pk>.*)/$', views.BookModelViewSet.as_view({'get': 'retrieve', 'put': 'update', 'patch': 'partial_update', 'delete': 'destroy'})),
奇葩路由：
from django.conf.urls import include from rest_framework.routers import SimpleRouter router = SimpleRouter()
# 所有路由与ViewSet视图类的都可以注册，会产生 '^v6/books/$' 和 '^v6/books/(?P<pk>[^/.]+)/$' router.register('v6/books', views.BookModelViewSet) # 这里可以写很多版本，写一大堆，下面只需要一句就行了
# router.register('v7/books', views.BookModelViewSet)
# router.register('v8/books', views.BookModelViewSet)
urlpatterns = [
# 第一种添加子列表方式
url(r'^', include(router.urls)),
]
# 第二种添加子列表方式
# urlpatterns.extend(router.urls) # 这里只写一句，
