欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Django-restframework 源码分析之认证

程序员文章站 2022-05-14 09:33:01
Django restframework 源码分析之认证 前言 最近学习了 django 的一个 restframework 框架,对于里面的执行流程产生了兴趣,经过昨天一晚上初步搞清楚了执行流程(部分方法还不太清楚),于是想详细的总结一下当来一个请求时,在该框架里面是如何执行的? 启动项目时 昨天 ......

django-restframework 源码分析之认证

前言

最近学习了 django 的一个 restframework 框架,对于里面的执行流程产生了兴趣,经过昨天一晚上初步搞清楚了执行流程(部分方法还不太清楚),于是想详细的总结一下当来一个请求时,在该框架里面是如何执行的?

启动项目时

昨天在调试django时,发现在 apiview 中打的断点没有断下来,而是打在 view 中的断点断下来了,调试了很多次,最后发现,在 django 项目启动时,会首先加载 urls 中的文件,执行 views 中类的 as_view方法,其实是继承自 apiview 的,apiview 继承自 django 原生 view 的as_view 方法。

里面一个参数叫 pattern_name,对应的值是admin:auth_group_change,如下图所示:

Django-restframework 源码分析之认证

目前还不清楚这里面的具体流程是什么,但是并不妨碍阅读之后的源码,在这只要清楚一点,在 django 项目启动时,路由所对应的cbv里面的相关方法的内存地址已经获取到。这样做的好处就是提高效率,坏处可能有一点点,会提升性能的消耗。

具体路由和逻辑代码

在这里假设来一个 get 请求,urls 和 views里面的代码如下:

# urls.py

url(r'^book/(?p<id>\d+)/', views.book.as_view()),
# views.py
class book(apiview):

    def dispatch(self, request, *args, **kwargs):
        return super().dispatch(request, *args, **kwargs)

    def get(self, request, id):

        response = {'status': 100, 'msg': none}

        book = models.book.objects.filter(pk=id).first()
        book_ser = bookserib(book, many=false)
        print('book_ser.data', book_ser.data)
        response['books'] = book_ser.data
        response['msg'] = '获取图书成功'
        print('response', response)
        return response(response)

urls 里面就是一个典型的 cbv 的路由配置,在 views 中一个是路由分发方法,一个是获取单本图书信息(通过 id)。

as_view 具体执行流程

在项目启动时,相应的函数内存地址已经获取到,那么具体是怎么获取到的呢?

在上面的代码中可以看到 book类是继承自apiview类的,所以在路由配置里面执行的as_view方法如果book类没有重写,那么执行的就是按照mro列表顺序查找到的第一个方法,在这里执行的是apiview类中的as_view方法。

查看该源码如下:

Django-restframework 源码分析之认证

apiview类的父类是view类,查看该类的as_view方法,源码如下:

Django-restframework 源码分析之认证

具体as_view就是将view函数的内存地址返回,以便请求来时直接调用。

initkwargs这个参数应该是由 django 内部传的一些参数,如下所示:

Django-restframework 源码分析之认证

请求到来时

因为经过 django 先执行了as_view返回view的内存地址,所以会直接执行view函数,如下:

Django-restframework 源码分析之认证

在这里该 self 由于是 继承自apiview类的book类的对象,所以dispatch方法首先去自身找,之后去父类找,在apiview类中找到dispatch方法,源码如下:

Django-restframework 源码分析之认证

initialize_request方法:

源码如下:

Django-restframework 源码分析之认证

在实例化request对象时,authenticators参数需要在认证时使用,所以先把这个参数的值找出来。步骤如下:

  • 调用 self.get_authenticators

Django-restframework 源码分析之认证

  • 找到 self.authentication_classes

Django-restframework 源码分析之认证

  • 找到 api_settings,才能找到default_authentication_classes

Django-restframework 源码分析之认证

  • default和import_strings参数
  1. default参数

Django-restframework 源码分析之认证

  1. import_strings参数

Django-restframework 源码分析之认证

  • 实例化 apisettings 对象

Django-restframework 源码分析之认证

  • 通过__getattr__方法获取值

Django-restframework 源码分析之认证

  • 执行perform_import方法

Django-restframework 源码分析之认证

  • 执行import_from_string

Django-restframework 源码分析之认证

  • 执行import_module

Django-restframework 源码分析之认证

  • 执行_bootstrap._gcd_import

Django-restframework 源码分析之认证

  • 执行_sanity_check

Django-restframework 源码分析之认证

  • _sanity_check返回,执行_find_and_load方法

Django-restframework 源码分析之认证

  • 所以通过__getattr__的到的是一个列表,里面是两个类,分别是[rest_framework_authentication_sessionauthentication, rest_framework_authentication_basicauthentication]

到这里,initialize_request方法执行结束,得到一个经过 request 类实例化的 request 对象,该对象里面含有原生 request 对象,可以通过request._request取到。

initial 方法:

源码如下:

Django-restframework 源码分析之认证

这里传入的request参数是经过request封装后的参数

  • 执行get_format_suffix

Django-restframework 源码分析之认证

执行完这个方法,self_format_kwarg = none

  • 执行perform_content_negotiation

Django-restframework 源码分析之认证

  1. 执行self.get_renders

Django-restframework 源码分析之认证

  1. 执行self.get_content_negotiator

Django-restframework 源码分析之认证

  1. 执行 conneg.select_renderer方法

Django-restframework 源码分析之认证

未完待续…...