一、试图基类
# 我们之前学习的drf在编写视图类的时候 是继承了APIView 和 GenericAPIView
# GenericAPIView的属性和方法回顾:
-属性
-queryset # 要序列化的数据
-serializer_class # 序列化类
-lookup_field # 通过get_object 获取单个对象的查询key值，value值是路由中传进来的
-filter_backends # 过滤类
-pagination_class # 分页类
-方法
-get_queryset # 获取要序列化的数据
-get_object # 根据lookup_field配置的参数获取单个对象
-get_serializer # 获取序列化类，咱们直接用的
-get_serializer_class # 获取序列化类，不是咱们直接用的get_serializer调用了它
-filter_queryset # 跟过滤有关系
-paginate_xxx # 跟分页有关
1.1基于APIView写的五个接口
class UserView(APIView):
def get(self, request):
res_list = User.objects.all()
ser = UserSerializer(instance=res_list, many=True)
return Response(ser.data)
def post(self, request):
ser = UserSerializer(data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': "新增成功"}, status=201)
else:
return Response({'code': 101, 'msg': ser.errors})
class UserDetailView(APIView):
def get(self, request, pk):
obj = User.objects.filter(pk=pk).first()
ser = UserSerializer(instance=obj)
return Response(ser.data)
def put(self, request, pk):
obj = User.objects.filter(pk=pk).first()
ser = UserSerializer(instance=obj, data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': "修改成功"}, status=201)
else:
return Response({'code': 101, 'msg': ser.errors})
def delete(self, request, pk):
User.objects.filter(pk=pk).delete()
return Response('')
# 这个时候我们发现 有许多代码重复了 就可以继承GenericAPIView来解决
2.使用GenericAPIView来编写五个接口
class UserView(GenericAPIView):
# 配置两个 类属性
queryset = User.objects.all()
serializer_class = UserSerializer
def get(self, request):
res_list = self.get_queryset() # 提高扩展性
ser = self.get_serializer(instance=res_list, many=True)
return Response(ser.data)
def post(self, request):
ser = self.get_serializer(data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': "新增成功"}, status=201)
else:
return Response({'code': 101, 'msg': ser.errors})
class UserDetailView(GenericAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
def get(self, request, pk):
# obj = self.get_queryset().filter(pk=pk).first()
# queryset.get({'pk':'有名分组分出来的'}
obj = self.get_object() # 根据传入的pk，获取一条数据
ser = self.get_serializer(instance=obj)
return Response(ser.data)
def put(self, request, pk):
obj = self.get_object()
ser = self.get_serializer(instance=obj, data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': "修改成功"}, status=201)
else:
return Response({'code': 101, 'msg': ser.errors})
def delete(self, request, pk):
self.get_queryset().filter(pk=pk).delete()
return Response('')
# 我们可以把类中方法给单独写一个类 然后在视图类中继承即可 然后drf中有写好的五个试图扩展了 我们只需导入 继承即可
二、五个试图扩展类
# 必须配合GenericAPIView使用，不能配合APIView使用
from rest_framework.mixins import RetrieveModelMixin, CreateModelMixin, UpdateModelMixin, DestroyModelMixin, \
ListModelMixin
# CreateModelMixin:写了一个Create方法，就是原来咱们post 新增一个
# RetrieveModelMixin：写了一个retrieve，就是咱们原来的get 获取一个
# UpdateModelMixin：写了一个update方法，就是咱们原来的put 修改
# ListModelMixin：写了一个list方法，就是原来咱们的get 获取全部
# DestroyModelMixin：写了一个destroy方法，就是原来咱们的delete 删除一个
1.代码演示
class UserView(GenericAPIView, ListModelMixin, CreateModelMixin):
# 配置两个 类属性
queryset = User.objects.all()
serializer_class = UserSerializer
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 UserDetailView(GenericAPIView, RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin):
queryset = User.objects.all()
serializer_class = UserSerializer
def get(self,request, *args, **kwargs):
return self.retrieve(request, *args, **kwargs)
def put(self, request, *args,**kwargs):
return self.update(request,*args,**kwargs)
def delete(self, request, *args,**kwargs):
return self.destroy(request,*args,**kwargs)
# 因为继承的父类中写了对应的方法 所以我们在视图类中可以不用在写对应的方法了
三、九个试图子类
from rest_framework.generics import ListAPIView,CreateAPIView, RetrieveAPIView,DestroyAPIView,UpdateAPIView
from rest_framework.generics import ListCreateAPIView, RetrieveUpdateDestroyAPIView,RetrieveUpdateAPIView,RetrieveDestroyAPIView
ListAPIView # 获取全部
CreateAPIView # 新增一个
RetrieveAPIView # 获取一个
DestroyAPIView # 删除一个
UpdateAPIView # 修改
ListCreateAPIView # 获取全部和新增一个
RetrieveUpdateAPIView # 获取一个和修改
RetrieveDestroyAPIView #获取一个和删除一个
RetrieveUpdateDestroyAPIView # 获取一个和修改一个和删除一个
1.代码演示
# 正常来讲 Destroy+Update 应该有一个 ，作者没加
class UserView(ListCreateAPIView):
# 配置两个 类属性
queryset = User.objects.all()
serializer_class = UserSerializer
class UserDetailView(RetrieveUpdateDestroyAPIView):
queryset = User.objects.all()
serializer_class = UserSerializer
# 然后我们发现这个还是可以优化一下 所以drf也有这个写好的类 我们只需要导入继承即可
四、视图集
# 视图类
from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class UserView(ModelViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
# ModelViewSet 是有正常的五个接口 都有 只需要继承它 那么五个的功能就会都有了
# ReadOnlyModelViewSet 只有获取一个和获取全部
# 我们继承了ModelViewSet 或则 ReadOnlyModelViewSet 那么需要改变路由的编写 如果还是之前的路由 那么就会直接报错 所以需要修改路由
# 路由
path('user/', views.UserView.as_view({'get': 'list', 'post': 'create'})),
path('user/<int:pk>', views.UserView.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})), # 需要这样写才能不会报错
1.ModelViewSet的源码分析
# 我们现在看一下ModelViewSet的源码为什么路由需要这样写才可以不会报错
# 那么源码的入口还是从as_view入手
# 然后我们写的视图类中没有as_view的方法 所以去继承的ModelViewSet中查找 我们可以看到ModelViewSet中没有写方法 所以取它继承的类中查找
class ModelViewSet(mixins.CreateModelMixin,
mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
mixins.ListModelMixin,
GenericViewSet):
pass
# 然后根据名字的查找顺序 从左到右 我们可以知道前面的五个也是没有as_view的方法的
# 然后我们就去到了GenericViewSet类中查找 我们可以看到GenericViewSet类中也没有写什么方法 所以去它继承的类中查找
class GenericViewSet(ViewSetMixin, generics.GenericAPIView):
pass
# 所以我们需要先去ViewSetMixin中查找as_view方法 如果有就不用找后面的类了 我们可以看到是有这个方法的
2.ViewSetMixin的源码分析
@classonlymethod
def as_view(cls, actions=None, **initkwargs): # actions就是我们在路由中匹配的字典中的参数
if not actions: # 所以如果我们不参数就会抛出异常 所以这里规定我们一定要传参数 eg:{'get': 'list', 'post': 'create'}
raise TypeError("The `actions` argument must be provided when "
"calling `.as_view()` on a ViewSet. For example "
"`.as_view({'get': 'list'})`"
def view(request, *args, **kwargs): # 然后执行view函数
for method, action in actions.items(): # actions.items就是把我们传得字典的K:V
# 然后通过for循环把我们传得字典中一个一个循环出来 然后通过K赋值给method V赋值给action
# 所以现在method现在就是'get' action就是'list'
handler = getattr(self, action)
# 然后通过反射getattr获取self中的list方法 self就是我们写的视图类
# 因为我们视图类继承了ModelViewSet 然后这个类有继承了ListModelMixin 然后在这个类中有一个list方法
# 所以我们自己写的试图类 也可以使用这个list方法 所以现在handler就是这个list方法
setattr(self, method, handler)
# 然后在通过反射setattr 把list这个方法设置到我们自己写的试图类中 self.method=handler 就是等于 self.get=list
return self.dispatch(request, *args, **kwargs)
return csrf_exempt(view)
# 所以现在我们只要继承了ModelViewSet或则ReadOnlyModelViewSet 路由都需要变成views.UserView.as_view({'get': 'list', 'post': 'create'}))这样写
# 但是我们视图类中的方法名可以不需要在写post、get、put...
# 可以写我们自己想要的方法名 因为会先从对象本身开始找 所以不会报错
浙公网安备 33010602011771号