一. 视图类传递参数给序列化类
1. 在视图类中实例化序列化对象时,可以设置context内容 2. 在序列化类中的局部钩子,全局钩子,create,update方法中,都可以用self.context访问视图类传递的内容 需求: 1. 在视图类中,可以通过request得到登录用户request.user 2. 在序列化类中,要完成数据库的校验与入库操作,可能会需要知道当前的登录用户,但是序列化类无法访问request 3. 在视图类中实例化序列化对象时,将request对象传递进去
视图层: views.py
class Book(APIView): def post(self, request, *args, **kwargs): book_ser = serializers.BookModelSerializer(data=request_data,context={'request':request}) book_ser.is_valid(raise_exception=True) book_result = book_ser.save() return Response({ 'status': 0, 'msg': 'ok', 'results': serializers.BookModelSerializer(book_result).data })
序列化层: serializers.py
class BookModelSerializer(ModelSerializer): class Meta: model = models.Book fields = ('name', 'price') def validate_name(self, value): # 访问view视图类传递过来的参数,相当于视图与序列化之间完成交互的 print(self.context.get('request').method) return value
二. 二次封装response类
为了解决上面写太多的response,我们进行response的二次封装
先重新建立一个utils的文件夹, 然后自定义一个APIResponse类,用它来继承(Response)
class APIResponse(Response): def __init__(self, data_status=0, data_msg='ok', results=None, http_statue=None, headers=None, exception=None, **kwargs)
# data的初始状态 data={ 'status': data_status, 'msg': data_msg, }
# data的响应数据体
# resuults可能是False,0等数据,这些数据某些情况下也会作为合法数据返回 if result is not None: data['results'] = results
# data响应的其他内容 if kwargs is not None: for k, v in kwargs.items(); setattr(data, k, v) super().__init__(data=data, status=http_status, headers=headers,execption=execption)
在视图中,直接导入utils文件夹,返回APIResponse到前端即可
三. 视图家族
视图家族有四小家族,分别是: 1. views: 视图 2. generics: 工具视图 3.mixins: 视图工具集 4. viewsets: 视图集 视图一系列的工具放在一起
学习路线: APIView ==> GenericAPIView ==> mixins的五大工具类 ==> generics中的工具视图 ==> viewsets中的视图集
GenericAPIView基类
GenericAPIView是继承APIView的,使用完全兼容APIView 重点: GenericAPIView在APIview的基础上完成哪些事 1. get_queryset(): 从类属性queryset中获得model的queryset数据 2. get_object(): 从类属性queryset中获得model的queryset数据, 再通过有名分组pk确定唯一操作对象 3. get_serializer(): 从类属性serializer_class中获得serializer的序列化类
urls.py
urlpatterns = [ url(r'^v2/books/$', views.BookGenericAPIView.as_view()), url(r'^v2/books/(?P<pk>.*)/$', views.BookGenericAPIView.as_view()), ]
视图类: views.py
实例
# Genseric 类 from rest_framework.generics import GenericAPIView class BookGenericAPIView(GenericAPIView): # 因为我们继承的是GenericAPIView >>> 继承APIView # queryset = None 和serializer = None 初始值为空时需要我们进行重写的 queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer # 单查 pk get的方法 lookup_field = 'pk' # def get(self, request, *args, **kwargs): # book_query = self.get_object() # print(book_query, 55) # book_ser = self.get_serializer(book_query) # book_data = book_ser.data # return APIResponse(results=book_data) # 群查 def get(self, request, *args, **kwargs): book_query = self.get_queryset() book_ser = self.get_serializer(book_query,many=True) # 这里加上many=True book_data = book_ser.data return APIResponse(results=book_data)
get的方法单查和全查
# mixins 有五大工具六大方法 from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin class BookMixinGenericAPIView(ListModelMixin,CreateModelMixin,UpdateModelMixin,RetrieveModelMixin,GenericAPIView): # 先获取对象 queryset = models.Book.objects.filter(is_delete=False) # 重写序列化 serializer_class = serializers.BookModelSerializer def get(self,request,*args, **kwargs): # mixins 中的单查 pk if 'pk' in kwargs: response = self.retrieve(request,*args,**kwargs) else: # mixins提供的list方法的响应对象是Response,想将该对象格式化为APIResponse response = self.list(request, *args, **kwargs) # 数据都是封装在response return APIResponse(results=response.data)
post/put/putch
# 单增post 多增的操作 def post(self, request, *args, **kwargs): response = self.create(request, *args, **kwargs) return APIResponse(results=response.data) # =更新put # 注意必须在pk = 22 有值的情况 也必须是在url 中拼接pk 才能进行目前的修改 def put(self,request, *args, **kwargs): response = self.update(request, *args, **kwargs) return APIResponse(results=response.data) # patch修改 也会需要 pk url 中拼接 局部跟新和整体更新,partial=True def patch(self,request, *args, **kwargs): response = self.update(request, *args, **kwargs) return APIRsponse(response.data)
四. mixins视图工具集-辅助GenericAPIView
1. 工具视图都是GenericAPIView的子类,且不同的子类继承了不同的工具类,重写了请求方法 2. 工具视图的功能如果直接可以满足要求,只需要直接继承工具视图,提供queryset与serializer_class即可 # 群查 局部更新 from rest_framework.generics import ListCreateAPIView, UpdateAPIView class BookListCreateAPIView(ListCreateAPIView, UpdateAPIView): queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer
五. 视图集
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方法 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'})) ]
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)
六. GenericAPIView与APIView最为两大继承的区别
1. GenericViewSet和ViewSet都继承了ViewSetMixin, as_view都可以配置 请求-函数映射 2. GenericViewSet继承的是GenericAPIView视图类,用来完成model类的接口操作,GenericAPIView里面有标准的queryset和serializer,需要序列化的或者需要查model的走GenericAPIView,不需要序列化的或者不需要查model的就直接走APIView 3. ViewSet继承的是APIView视图类,用来完成不需要的model类参与,或是非标准的model类操作接口 # post请求在标准的model类操作下就是新增接口, 登录的post不满足 # post请求验证码的接口,不需要,model类的参与 案例: 登录的post请求, 并不是完成数据的新增,只是用post提交数据,得到的结果也不是登录的用户信息,而是登录的认证信息
七. 视图集子类分析
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'})), ]
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, '删除成功')