django---ModelViewSet源码分析(rest-framework)

api请求实现方法

我们在请求api接口数据，可以通过以下方式来实现：
1、利用APIView

class BookView(APIView):
    def get(self,request,*args,**kwargs):
        book_list = Book.objects.all()
        bs = BookSerializers(book_list,many=True,context={'request': request})
        return Response(bs.data)

2、利用mixins多重复继承方式来实现

class BookView(mixins.ListModelMixin,
               mixins.CreateModelMixin,
               generics.GenericAPIView):

    queryset = Book.objects.all()
    serializer_class = BookSerializers

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

3、利用通用的generics模块来实现，例如下面的示例

 class BookView(generics.ListCreateAPIView):
     queryset = Book.objects.all()
     serializer_class = BookSerializers

4、还有其他方式，诸如仅继承View方式，和接下来要源码分析的ModelViewSet方式
以上几种方式的使用及其源码简要分析，可以参考我如下的博客笔记：
APIView、mixins、generics、HyperlinkedIdentityField示例

mixins模块及其GenericAPIView类源码分析

ModelViewSet简单实用

接下来我们就来了解，如何通过router配置，并且通过ModelViewSet来实现，

我在了解源码前，先用一个小例子来试验，
models类

class Book(models.Model):
    title=models.CharField(max_length=32)
    price=models.IntegerField()
    pub_date=models.DateField()
    publish=models.ForeignKey("Publish")
    authors=models.ManyToManyField("Author")
    def __str__(self):
        return self.title

class Publish(models.Model):
    name=models.CharField(max_length=32)
    email=models.EmailField()
    def __str__(self):
        return self.name

class Author(models.Model):
    name=models.CharField(max_length=32)
    age=models.IntegerField()
    def __str__(self):
        return self.name

router配置

url(r"bookset/$",views.BookSet.as_view({'get': 'list', 'post': 'create'})),
url(r"bookset/(?P<pk>\d+)/$",views.BookSet.as_view({'get': 'retrieve', 'put': 'update','delete': 'destroy'})),

view视图

class BookSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializers

ModelSerializer

class BookSerializers(serializers.ModelSerializer):
    class Meta:
        model=Book
        fields="__all__"

以上就是models实体类、路由、视图代码，最后利用postman进行测试，前几篇笔记有测试效果图，这里省略测试截图

ViewSetMixin累源码分析

我们主要是来看下为什么通过url配置和ModelViewSet几行代码，就能实现request的restful协议请求
ModelViewSet类继承关系比较复杂，我先抛出一张简陋的父子关系继承图

那我们首先就从viewsets.ModelViewSet开始跟踪代码，其实这个类只不过继承了CreateModelMixin、RetrieveModelMixin、UpdateModelMixin、DestroyModelMixin、ListModelMixin、GenericViewSet，然而并没有去扩充以上列举的多重继承类中的任何方法，以下是代码片段

class ModelViewSet(mixins.CreateModelMixin,
                   mixins.RetrieveModelMixin,
                   mixins.UpdateModelMixin,
                   mixins.DestroyModelMixin,
                   mixins.ListModelMixin,
                   GenericViewSet):
    pass

我们实现api接口数据请求时，可以利用mixins模块来实现，也就是ModelViewSet的4个继承父类，分别实现了增加、获取单条数据、更新数据、删除销毁数据、获取所有表数据的功能，之前的mixins源码简单分析过，这里就不在一一重复赘述，后续的分析中，会拿出一个来配合GenericViewSet类代码进行分析
那好，我们就看下GenericViewSet类，看看做什么操作？它是一个多重继承了ViewSetMixin、GenericAPIView类的空扩展类，以下是该类代码：

class GenericViewSet(ViewSetMixin, generics.GenericAPIView):
    pass

在class GenericViewSet(ViewSetMixin, generics.GenericAPIView):多重继承类中，我们先看ViewSetMixin类

接下来我们注意分析ViewSetMixin具体做了什么操作？列举出来该类中的方法

as_view
initialize_request
reverse_action

原来ViewSetMixin类也是封装了一套自己的as_view方法，后续的代码跟踪中，我们也会发现GenericAPIView的父类APIView和View均含有as_view方法逻辑，稍后分析，我们先看下ViewSetMixin类中的as_view方法，如下代码(代码省去了一些判断操作)

def as_view(cls, actions=None, **initkwargs):
"省略一些代码"
 def view(request, *args, **kwargs):
            self = cls(**initkwargs)
            # We also store the mapping of request methods to actions,
            # so that we can later set the action attribute.
            # eg. `self.action = 'list'` on an incoming GET request.
            self.action_map = actions

            for method, action in actions.items():
                handler = getattr(self, action)
                setattr(self, method, handler)

            if hasattr(self, 'get') and not hasattr(self, 'head'):
                self.head = self.get

            self.request = request
            self.args = args
            self.kwargs = kwargs

            return self.dispatch(request, *args, **kwargs)
"省略一些代码"
return csrf_exempt(view)

我们看到该方法最后返回一个view函数，并且通过csrf_exempt(view)进行取消当前函数防跨站请求伪造功能，对该View函数进行进一步装饰，当请求访问时候，我们在利用ModelViewSet进行api请求时候，会在url进行如下的配置操作

url(r"bookset/$",views.BookSet.as_view({'get': 'list', 'post': 'create'})),
url(r"bookset/(?P<pk>\d+)/$",views.BookSet.as_view({'get': 'retrieve', 'put': 'update','delete': 'destroy'})),

调用该view方法，我们就看下view方法做了什么操作处理？
我们会去遍历url配置中的as_view字典参数，然后拿到一个个元组类型的items()，
然后ModelViewSet子类class BookSet(viewsets.ModelViewSet)(也就是我们自己编写的视图函数)通过反射handler = getattr(self, action)，去获取看看有没有对应的action，也就是as_view参数字典retrieve、update、list、create、destroy操作，但是最后发现，我们构造的BookSet视图函数类没有所述的这些方法啊
，只有如下2行代码

class BookSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializers

因为ModelViewSet是多重继承父类的，以下是继承的父类，可以去参考之前的那张父子继承关系截图

class ModelViewSet(mixins.CreateModelMixin,
                   mixins.RetrieveModelMixin,
                   mixins.UpdateModelMixin,
                   mixins.DestroyModelMixin,
                   mixins.ListModelMixin,
                   GenericViewSet)

如果在ViewSetMixin中找不到对应的url对应的action,它就会去其他类父类中寻找，
例如我们进行http://127.0.0.1:8000/bookset/(get请求)会去ListModelMixin寻找有没有list方法
我们参看其源码，发现有list方法

class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        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)

我们回过头来继续看ViewSetMixin中的as_view方法中内置函数view
当handler = getattr(self, action)找到对应的action后，就紧接着setattr(self, method, handler)依然以http://127.0.0.1:8000/bookset/(get请求)为例子，会为get请求赋值方法handler，就类似如下的伪代码

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

最后执行return self.dispatch(request, *args, **kwargs)，这个dispatch方法，依然在本类ViewSetMixin找寻不到，最终会在APIView类中找到并且执行以下操作，稍后会对APIView中的dispatch进行分析

 if request.method.lower() in self.http_method_names:
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed

            response = handler(request, *args, **kwargs)

最后返回即可

self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response

以上就是ViewSetMixin的执行流程，接下来我们看下ModelViewSet的其他父类

APIView类分析

我们然后看下GenericAPIView继承父类，它是一个APIView的子类

class GenericAPIView(views.APIView):
 pass #暂时省略代码

前几篇已经分析过GenericAPIView及其父类APIView的代码，现在我仅贴出它的一些方法简单说明即可

GenericAPIView

get_queryset：获取QuerySet数据集合
get_object：获取单条数据对象
get_serializer：获取对应的model序列化器
get_serializer_class：获取序列化器对应的model实体类
get_serializer_context：提供给序列化程序类的额外上下文
filter_queryset：过滤QuerySet数据集合
paginator：分页器
paginate_queryset：对数据进行切片
get_paginated_response：获取分页返回的数据response

APIView(View)

APIView类中的as_view继承扩充View的父类方法：返回一个view函数，并且通过csrf_exempt(view)进行取消当前函数防跨站请求伪造功能，对该View函数进行进一步装饰，当请求访问时候，调用该函数，并且最终执行父类View方法中下面的一行代码，如下：
我们接着对ViewSetMixin类没有分析完毕的view方法中的return self.dispatch(request, *args, **kwargs)，它是调用了APIView类中的dispatch方法，我们来对APIView中的dispatch进行分析

return self.dispatch(request, *args, **kwargs)

由于APIView继承了View,在执行dispatch时候，不会去执行View类中，而是去执行自己类中的dispatch方法，该方法继承并且重写了父类dispatch的方法，代码如下：

 def dispatch(self, request, *args, **kwargs):
        """
        `.dispatch()` is pretty much the same as Django's regular dispatch,
        but with extra hooks for startup, finalize, and exception handling.
        """
        self.args = args
        self.kwargs = kwargs
        request = self.initialize_request(request, *args, **kwargs)
        self.request = request
        self.headers = self.default_response_headers  # deprecate?

        try:
            self.initial(request, *args, **kwargs)

            # Get the appropriate handler method
            if request.method.lower() in self.http_method_names:
                handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
            else:
                handler = self.http_method_not_allowed

            response = handler(request, *args, **kwargs)

        except Exception as exc:
            response = self.handle_exception(exc)

        self.response = self.finalize_response(request, response, *args, **kwargs)
        return self.response

在dispatch代码中，通过initialize_request封装请求request请求,构建自己的Request类，会添加一些auth验证，访问频率验证，权限校验等，这里的request请求细节，我会另开一篇博客笔记，分析api请求中如何进行诸如auth验证进行专门分析，这里简单分析即可
校验完毕，就通过反射的方法获取对应的请求，诸如get\post\put\delete等

handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)

然后拿到结果response = handler(request, *args, **kwargs)，等诸如get\post请求返回结果，就self.response = self.finalize_response(request, response, *args, **kwargs)对Response类进一步封装，然后return self.response返回完毕

GenericAPIView类分析

我们再次贴出我们编写的视图代码？

class BookSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializers

queryset、 serializer_class是在哪里使用的？

在GenericAPIView中get_queryset、get_serializer方法中有进行相关操作

 def get_queryset(self):

        assert self.queryset is not None, (
            "'%s' should either include a `queryset` attribute, "
            "or override the `get_queryset()` method."
            % self.__class__.__name__
        )

        queryset = self.queryset
        if isinstance(queryset, QuerySet):
            # Ensure queryset is re-evaluated on each request.
            queryset = queryset.all()
        return queryset

  def get_serializer(self, *args, **kwargs):

        serializer_class = self.get_serializer_class()
        kwargs['context'] = self.get_serializer_context()
        return serializer_class(*args, **kwargs)

以上就是GenericViewSet源码分析，接下来继续分析APIView如何实现Auth用户认证、权限校验的