Django中间件的加载原理

假设我们有如下中间件:

setting.py文件

MIDDLEWARE = [
    'django.middleware.A',
    'django.middleware.B',
    'django.middleware.C',
    'django.middleware.D',
]

Django中间件的五个方法调用顺序如下:

  • process_request(request)

    • process_view(request, view_func, args, kwargs)

      • if has exception process_exception(request, e)
    • process_template_response(request, response)

      • if has exception process_exception(request, e)
  • process_response(request, response)

需要注意的是,process_response之前的4个方法中返回了任何的HTTPResponse对象,都不会触发process_response

Django的中间件都必须继承MiddlewareMixin

class MiddlewareMixin:
    # middleware_instance = A(B(C(D(_get_response))))
    # self.get_respons = B(C(D(_get_response))
    def __init__(self, get_response=None):
        self.get_response = get_response
        super().__init__()

    # 通过__call__实现一种类似递归调用的方式
    def __call__(self, request):
        response = None
        if hasattr(self, 'process_request'):
            # A(B(C(D(_get_response))))(request)会调用__call__(request)中的逻辑执行
            # 1. A(B(C(D(_get_response)))).process_request(request)  中间件A的process_request()方法被执行返回none
            response = self.process_request(request)
        if not response:
            # 2. response为None self.get_response 指的是A的B(C(D(_get_response)),B(C(D(_get_response))(request) 又会去调用
            #  __call__(request) ——> B(C(D(_get_response)).process_request(request)  中间件B的process_request()方法被执行返回none
            #  再次进入if not response分支 C(D(_get_response)(request)直到最后执行 _get_response(request)方法
            response = self.get_response(request)
        if hasattr(self, 'process_response'):
            response = self.process_response(request, response)
        return response

父类的__call__()方法中只处理了中间件的process_requestprocess_response这个两个一头一尾的方法,中间的几个方法其实都封装在了get_response这个变量中。

在Django启动时会初始化WSGIHandler类,会把ABCD四个中间件的对象实例化出来

class WSGIHandler(base.BaseHandler):
    ...
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)

        # 加载中间件实例到内存中,此时中间件实例的各种方法已经被包裹在 _get_response() 方法的前后了
        self.load_middleware()

    # __call__方法会在一个新的子线程中被调用
    def __call__(self, environ, start_response):
        ...
        request = self.request_class(environ)
        # get_response是父类的方法,调用此方法触发self._middleware_chain()的递归调用
        response = self.get_response(request)
        ..
        return response

中间件的加载由父类BaseHandlerload_middleware()方法实现

首先看load_middleware()方法:

class BaseHandler:
    ...
    def load_middleware(self):

        self._request_middleware = []
        self._view_middleware = []
        self._template_response_middleware = []
        self._response_middleware = []
        self._exception_middleware = []

        # 这里可以直接把handler看做是self._get_response方法
        handler = convert_exception_to_response(self._get_response)
        # 通过for循环,按照逆序依次实例化要加载的中间件
        for middleware_path in reversed(settings.MIDDLEWARE):
            # 通过中间件的类全命加载他们的类对象
            middleware = import_string(middleware_path)
            try:
                # 然后把handler作为参数,实例化中间件
                mw_instance = middleware(handler)
            except MiddlewareNotUsed as exc:
                if settings.DEBUG:
                    if str(exc):
                        logger.debug('MiddlewareNotUsed(%r): %s', middleware_path, exc)
                    else:
                        logger.debug('MiddlewareNotUsed: %r', middleware_path)
                continue

            if mw_instance is None:
                raise ImproperlyConfigured(
                    'Middleware factory %s returned None.' % middleware_path
                )

            # 把含有'process_view'方法的中间件对象放入到self._view_middleware列表[]中
            if hasattr(mw_instance, 'process_view'):
                self._view_middleware.insert(0, mw_instance.process_view)
            # 把含有'process_template_response'方法的中间件对象放入到self._template_response_middleware列表[]中
            if hasattr(mw_instance, 'process_template_response'):
                self._template_response_middleware.append(mw_instance.process_template_response)
            # 把含有'process_exception'方法的中间件对象放入到self._exception_middleware列表[]中
            if hasattr(mw_instance, 'process_exception'):
                self._exception_middleware.append(mw_instance.process_exception)
            # 这里的hanler可以直接看做是mw_instance,即一个中间件实例对象
            handler = convert_exception_to_response(mw_instance)

        # We only assign to this when initialization is complete as it is used
        # as a flag for initialization being complete.
        # 循环结束时handler是第一个中间件实例对象A(B(C(D(_get_response))))
        self._middleware_chain = handler

可以从for循环开始分析,看看ABCD这4个中间件时如何被实例化加载到内存中的

第一次:

  • handler = _get_response
  • 实例化中间件D(handler)
  • 依次查看D中是否有process_viewprocess_exceptionprocess_template_response有就放入响应的列表中去。
  • 赋值 handler = D(_get_response)

第二次:

  • handler = D(_get_response)
  • 实例化中间件C(handler)
  • 依次查看C中是否有process_viewprocess_exceptionprocess_template_response有就放入响应的列表中去。
  • 赋值 handler = C(D(_get_response))

第三次:

  • handler = C(D(_get_response))
  • 实例化中间件B(handler)
  • 依次查看B中是否有process_viewprocess_exceptionprocess_template_response有就放入响应的列表中去。
  • 赋值 handler = B(C(D(_get_response)))

第四次:

  • handler = B(C(D(_get_response)))
  • 实例化中间件A(handler)
  • 依次查看A中是否有process_viewprocess_exceptionprocess_template_response有就放入响应的列表中去。
  • 赋值 handler = A(B(C(D(_get_response))))

到此为止for循环结束,handler = A(B(C(D(_get_response)))),也就是这四个中间件的实例都加载到内存了,同时把他们的process_viewprocess_exceptionprocess_template_response这3个方法分别放到了对应的3个列表中。最后self._middleware_chain = handler,也就是把handler赋值给了WSGIHandler对象的实例属性self._middleware_chain。然后self._middleware_chain会在BaseHandlerget_response方法中被调用。

class BaseHandler:
    def get_response(self, request):

        set_urlconf(settings.ROOT_URLCONF)

        # 此函数完成对中间件的各个函数调用已经视图函数的调用
        # 首先依次调用中间件A,B,C,D的process_request

        # 之后调用_get_respones()方法,_get_respones()方法又会调用在load_middleware()方法中从中间件中添加的process_view函数,
        # process_template_response和 process_exception函数

        # 最后依次调用中间件的process_response方法
        response = self._middleware_chain(request)

        response._closable_objects.append(request)
        ...
        return response

    def _get_response(self, request):
        ...
        return response

self._middleware_chain(request)被调用时,即A(B(C(D(_get_response))))(request)

  • A-CALL-1 response = A.process_request(request)
  • A-CALL-2 response is None, response = B(C(D(_get_response)))(request)
    • B-CALL-1 response = B.process_request(request)
    • B-CALL-2 response is None, response = C(D(_get_response))(request)
      • C-CALL-1 response = C.process_request(request)
      • C-CALL-2 response is None, response = D(_get_response)(request)
        • D-CALL-1 response = D.process_request(request)
        • D-CALL-2 response is None, response = _get_response(request)
        • D-CALL-3 response is not None response = D.process_response(request, response) retrun C-CALL-2
      • C- CALL-3 response is not None, response = C.process_response(request, response) retrun B-CALL-2
    • B-CALL-3 response is not None, response = B.process_response(request, response) retrun A-CALL-2
  • A-CALL-3 response is not None, response = A.process_response(request, response) retrun response

MiddlewareMixin的__call__方法中分为三步:

  1. response = self.process_request(request)
  2. response = self.get_response(request)
  3. response = self.process_response(request, response)

最后 return response

解释下这个调用层级图:

A-CALL-1: 代表执行 中间件A实例对象的__call__的第一步

A-CALL-2: 代表执行 中间件A实例对象的__call__的第二步

A-CALL-3: 代表执行 中间件A实例对象的__call__的第三步

最终_get_response函数在被调用前依次会调用A,B,C,Dprocess_request方法,然后再执行_get_response函数,最后再依次调用它们的process_response方法。

在D-CALL-2 response is None, response = _get_response(request)这一步中,会调用_get_response方法,我们再来看一下这个方法:

class BaseHandler:
    
        def _get_response(self, request):
            # 调用视图函数和process_view函数, process_exception函数,process_template_response函数

            response = None
            ...
            # 1. 找通过url匹配找到视图函数callback
            resolver_match = resolver.resolve(request.path_info)
            callback, callback_args, callback_kwargs = resolver_match
            ...

            # 2. 调用_view_middleware列表中的所有中间件的proces_view
            for middleware_method in self._view_middleware:
                response = middleware_method(request, callback, callback_args, callback_kwargs)
                if response:
                    break

            # 3. 调用视图函数
            if response is None:
                wrapped_callback = self.make_view_atomic(callback)
                try:
                    response = wrapped_callback(request, *callback_args, **callback_kwargs)
                except Exception as e:
                    response = self.process_exception_by_middleware(e, request)
            ...
    
            # 4. 调用_template_response_middleware列表中保存的中间件的process__template_response方法,如果有异常则会调用_exception_middleware列表中的process_exception方法
            elif hasattr(response, 'render') and callable(response.render):
                for middleware_method in self._template_response_middleware:
                    response = middleware_method(request, response)
                    # Complain if the template response middleware returned None (a common error).
                    if response is None:
                        raise ValueError(
                            "%s.process_template_response didn't return an "
                            "HttpResponse object. It returned None instead."
                            % (middleware_method.__self__.__class__.__name__)
                        )
    
                try:
                    response = response.render()
                except Exception as e:
                    response = self.process_exception_by_middleware(e, request)
    
            return response

这个方法的主要逻辑:

  1. 找通过url匹配找到视图函数callback

  2. 调用_view_middleware列表中的所有中间件的proces_view

  3. 调用视图函数callback

  4. 调用_template_response_middleware列表中保存的中间件的

  5. process__template_response方法,如果有异常则会调用_exception_middleware列表中的process_exception方法

总结

通过继承MiddlewareMixin类的__call__方法实现了一种类似递归的调用。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,294评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,493评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,790评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,595评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,718评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,906评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,053评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,797评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,250评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,388评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,018评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2 350

推荐阅读更多精彩内容

  • 参考:django中间件官方文档:https://docs.djangoproject.com/en/dev/to...
    发热的小火炉阅读 1,890评论 0 2
  • 中间件是一个钩子框架,它们可以介入Django 的请求和响应处理过程。它是一个轻量级、底层的“插件”系统,用于在全...
    低吟浅唱1990阅读 514评论 0 0
  • 英文文档,一开始我也是抗拒的,边翻译边看,也就花费了1个小时基本就阅读过了,我的英文基础其实很差。附上链接:链接:...
    lonecolonel阅读 9,875评论 3 1
  • 参考:Django 源码学习(3)——中间件Django Middleware官方文档Django==2.0.4源...
    顾慎为阅读 566评论 0 2
  • Django中间件 概念:Django中一个轻量级、底层的插件系统,可以介入Django的请求和响应处理过程,修改...
    梦醒家先生阅读 1,059评论 0 0