Django Rest Framework（二 认证源码流程）

一、CBV回顾

 

class TestView(APIView):
    def dispatch(self, request, *args, **kwargs):
        """
        请求到来之后，都要执行dispatch方法，dispatch方法根据请求方式不同触发 get/post/put等方法

        注意：APIView中的dispatch方法有好多好多的功能
        """
        return super().dispatch(request, *args, **kwargs)

    def get(self, request, *args, **kwargs):
        return Response('GET请求，响应内容')

    def post(self, request, *args, **kwargs):
        return Response('POST请求，响应内容')

    def put(self, request, *args, **kwargs):
        return Response('PUT请求，响应内容')

二、使用restful时流程

整体：自建类继承APIView ，APIView又继承View类

入口：CBV/FBV入口都是urls，由此出发

分发：urls 里边使用as_view方法，经过处理到达dispatch方法，在这做分发

终点：执行自定义的认证类

三、图示

 

四、执行详细流程

• url(r'^test/', TestView.as_view())

进入as_view方法 位置···\site-packages\rest_framework\views.py
　　super(APIView, cls).as_view(**initkwargs) 
　　调用父类View的as_view() 位置 \site-packages\django\views\generic\base.py
　　　　最终返回 return self.dispatch(request, *args, **kwargs)

• self.dispatch

self是TestView ，没有dispatch方法，继续向APIView找
APIView里边有

• def dispatch()

　　···/site-packages/rest_framework/views.py APIView  def dispatch()

    def dispatch(self, request, *args, **kwargs):
        ···
        # 在这对request做了一下加工
        request = self.initialize_request(request, *args, **kwargs) # -->> 对应步骤4、5  -->> 对应步骤4、5
        ···
        # request是丰富后的新request
        self.initial(request, *args, **kwargs) # -->> 对应步骤6、7、8、9  -->> 对应步骤6、7、8、9
        ···
        # 根据请求反射取属性，根据method做分发
        handler = getattr(self, request.method.lower(),
                                  self.http_method_not_allowed)
        response = handler(request, *args, **kwargs)

• initialize_request()

　　initialize_request() ···/site-packages/rest_framework/views.py

    def initialize_request(self, request, *args, **kwargs):
        """
        Returns the initial request object.
        原始request进来，出去是 含request在内的大元祖
        request基础上增加了parsers、authenticators、negotiator、parser_context四个属性
        四个属性又对应着四个方法，点击方法进入查看
        """
        parser_context = self.get_parser_context(request)
        
        # 把原始的request参数丰富了,利用的是Request类实例化        
        return Request(
            request,
            parsers=self.get_parsers(),
            authenticators=self.get_authenticators(), #获取用户认证类
            negotiator=self.get_content_negotiator(),
            parser_context=parser_context
        )

• Request()

　　Request() ···\site-packages\rest_framework\request.py

class Request(object):
    def __init__(self, request, parsers=None, authenticators=None,
                 negotiator=None, parser_context=None):
        ···
        self._request = request  #原始request的调用方式
        self.parsers = parsers or ()
        self.authenticators = authenticators or ()
        self.negotiator = negotiator or self._default_negotiator()
        self.parser_context = parser_context
        self._data = Empty
        self._files = Empty
        self._full_data = Empty
        self._content_type = Empty
        self._stream = Empty
    # 以上是封装的参数
    # 此外，还封装了很多方法，一些加了@property
    # 先看涉及到的parsers、authenticators、negotiator、parser_context 对应的方法

    def get_parsers(self):
        """
        Instantiates and returns the list of parsers that this view can use.
        """
        return [parser() for parser in self.parser_classes]

    def get_authenticators(self):
        """
        Instantiates and returns the list of authenticators that this view can use.
        在这把用户认证类(对象)娶到手了
        """
        return [auth() for auth in self.authentication_classes]


    def get_content_negotiator(self):
        """
        Instantiate and return the content negotiation class to use.
        """
        if not getattr(self, '_negotiator', None):
            self._negotiator = self.content_negotiation_class()
        return self._negotiator

    def get_parser_context(self, http_request):
        """
        Returns a dict that is passed through to Parser.parse(),
        as the `parser_context` keyword argument.
        """
        # Note: Additionally `request` and `encoding` will also be added
        #       to the context by the Request object.
        return {
            'view': self,
            'args': getattr(self, 'args', ()),
            'kwargs': getattr(self, 'kwargs', {})
        }

• dispatch()到 initial()

APIView类中：

    def initial(self, request, *args, **kwargs):
        self.perform_authentication(request) # 调用认证的方法

• initial()到perform_authentication()

APIView类中：

    def perform_authentication(self, request):
        # 只有这一句
        request.user

认证走到这了，只有一行request.user 说明是user方法里做的认证
此时request 是新的request 也就是Request() 实例化出来的对象
 进去 Request() 找user方法 看看干了啥
 从APIView() 跳到 Request() 里边了

• Request() -- user()方法

    @property
    def user(self):
        if not hasattr(self, '_user'):
            with wrap_attributeerrors():
                # 执行当前类的_authenticate() 方法
                self._authenticate()
        return self._user

• user() 跳到 _authenticate()

　　Request() -- _authenticate()方法

    def _authenticate(self):
        # 循环认证所有的类
        for authenticator in self.authenticators:
            try:
                # authenticators是上边4、5两步取出来的 用户认证类对象 列表
                # authenticator对象由用户认证类实例化而来，用户认证类肯定要支持authenticate()方法
                # 这个方法就是给我们留的钩子呀，藏得真TM深
                user_auth_tuple = authenticator.authenticate(self)
            except exceptions.APIException:
                self._not_authenticated()
                raise

            if user_auth_tuple is not None:
                self._authenticator = authenticator
                self.user, self.auth = user_auth_tuple
                return

        self._not_authenticated()

 

整个探索过程中最重要的是，搞清楚类之间的继承和引用关系，以及不同类包含相同方法时，到底要执行哪个类。

遇到实在分不清的，可以打断点看它到底走的哪。不过打断点的前提是对程序整体流程有所了解