drf视图类

213 阅读3分钟

2个视图基类

APIView 和 GenericAPIView

GenericAPIView的属性和方法
    -属性
        -queryset: 要序列化的数据
        -serializer_class: 序列化类(我们自己写的)
        -lookup_field  # 通过get_object  获取单个对象的查询key值,value值是路由中传进来的
    -方法
        -get_queryset: 获取要序列化得数据
        -get_object: 获取单个对象
        -get_serializer: 获取序列化类(推荐使用)
        -get_serializer_class: 获取序列化类

基于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写五个接口

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(ser.data)
        else:
            return Response(ser.errors)


class UserDetailView(GenericAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

    def get(self, request, pk):
        obj = self.get_object()
        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.dta)
        if ser.is_valid():
            return Response(ser.data)
        else:
            return Response(ser.errors)

    def delete(self, request, pk):
        self.get_queryset().filter(pk=pk).delete()
        return Response('')

5个视图扩展类

# 必须配合GenericAPIView使用,不能配合APIView使用
# 五个视图扩展类是独立的类  没有继承任何父类

from rest_framework.mixins import ListModelMixin, CreateModelMixin
from rest_framework.mixins import UpdateModelMixin, DestroyModelMixin, RetrieveModelMixin

# RetrieveModelMixin:写了一个Create方法,就是原来咱们post中的代码
# RetrieveModelMixin:retrieve,就是咱们原来的get
# UpdateModelMixin:update方法,就是咱们原来的put
# ListModelMixin:list方法,就是原来咱们的get
# DestroyModelMixin:destroy方法,就是原来咱们的delete

基于GenericAPIView+5个视图扩展类写接口

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, UpdateModelMixin, RetrieveModelMixin, 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)

9个视图子类

本质就是GenericAPIView+一个或几个视图扩展类

from rest_framework.generics import ListAPIView, CreateAPIView, UpdateAPIView, DestroyAPIView, RetrieveAPIView
from rest_framework.generics import ListCreateAPIView, RetrieveUpdateDestroyAPIView
from rest_framework.generics import RetrieveDestroyAPIView, RetrieveUpdateAPIView

# 单个组合
ListAPIView = mixins.ListModelMixin + GenericAPIView
CreateAPIView = mixins.CreateModelMixin + GenericAPIView
UpdateAPIView = mixins.UpdateModelMixin + GenericAPIView
DestroyAPIView = mixins.DestroyModelMixin + GenericAPIView
RetrieveAPIView = mixins.RetrieveModelMixin + GenericAPIView
# 多个组合
ListCreateAPIView = ListAPIView + CreateAPIView
RetrieveUpdateDestroyAPIView = UpdateAPIView + DestroyAPIView + RetrieveAPIView
RetrieveDestroyAPIView = RetrieveAPIView + DestroyAPIView
RetrieveUpdateAPIView = RetrieveAPIView + UpdateAPIView

基于9个视图子类写接口

class UserView(ListCreateAPIView):
	# 只需配置两个类属性
    queryset = User.objects.all()
    serializer_class = UserSerializer


class UserDetailView(RetrieveUpdateDestroyAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

视图集

基于ModelViewSet编写5个接口

from rest_framework.viewsets import ModelViewSet
# 只要继承了ModelViewSet 路由的写法就变了

# views.py
class UserView(ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer
# urls.py
    path('user/', UserView.as_view({'get': 'list', 'post': 'create'})),
    path('user/<int:pk>/', UserView.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})),
ModelViewSet继承了GenericViewSet
GenericViewSet又继承了ViewSetMixin

源码分析ViewSetMixin

class ViewSetMixin:
    @classonlymethod
    def as_view(cls, actions=None, **initkwargs):
        # 路由中as_view中必须传参数,必须传字典:{'get': 'list', 'post': 'create'}
        if not actions:
            raise TypeError("The `actions` argument must be provided when "
                            "calling `.as_view()` on a ViewSet. For example "
                            "`.as_view({'get': 'list'})`")
        # 路由匹配成功,执行view(request),request是老的request
        def view(request, *args, **kwargs):
            # actions={'get': 'list', 'post': 'create'}
            for method, action in actions.items():
                # method:get      action:list
                # self 是视图类的对象中通过反射,查找list,
                # handler视图类中的list方法
                handler = getattr(self, action)
                # 向视图类的对象中,反射 method:get,handler:list方法
            	# self.get=list
                setattr(self, method, handler)
            return self.dispatch(request, *args, **kwargs)
        return csrf_exempt(view)

总结

#两个基类
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