Django之中间件

发表于 | 分类于 | 热度: ℃
字数统计: 3,145 | 阅读时长 ≈ 14

Django中间件

中间件介绍

什么是中间件?

官方的说法：中间件是一个用来处理Django的请求和响应的框架级别的钩子。它是一个轻量、低级别的插件系统，用于在全局范围内改变Django的输入和输出。每个中间件组件都负责做一些特定的功能。

但是由于其影响的是全局，所以需要谨慎使用，使用不当会影响性能。

说的直白一点中间件是帮助我们在视图函数执行之前和执行之后都可以做一些额外的操作，它本质上就是一个自定义类，类中定义了几个方法，Django框架会在请求的特定的时间去执行这些方法。

我们一直都在使用中间件，只是没有注意到而已，打开Django项目的settings.py文件，看到下图的MIDDLEWARE配置项。

1
2
3
4
5
6
7
8
9
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

MIDDLEWARE配置项是一个列表，列表中是一个个字符串，这些字符串其实是一个个类，也就是一个个中间件。

我们之前已经接触过一个csrf相关的中间件了？我们一开始把他注释掉，再提交post请求的时候，就不会被forbidden了，后来学会使用csrf_token之后就不再注释这个中间件了。

那接下来就学习中间件中的方法以及这些方法什么时候被执行。

自定义中间件

中间件可以定义五个方法，分别是：（主要的是process_request和process_response）

  • process_request(self,request)
  • process_view(self, request, view_func, view_args, view_kwargs)
  • process_template_response(self,request,response)
  • process_exception(self, request, exception)
  • process_response(self, request, response)

以上方法的返回值可以是None或一个HttpResponse对象，如果是None，则继续按照django定义的规则向后继续执行，如果是HttpResponse对象，则直接将该对象返回给用户。

views.py中 :

1
2
3
def index(request):
    print('index视图')
    return HttpResponse('OK')

下面我们来一一说明中间件的五个方法:

process_request

先来撸一段代码

1
2
3
4
5
6
7
8
9
10
11
12
13
from django.utils.deprecation import MiddlewareMixin


class MD1(MiddlewareMixin):

    def process_request(self, request):
        print('MD1里面的 process_request')


class MD2(MiddlewareMixin):
    def process_request(self, request):
        print('MD2里面的 process_request')
        pass

在settings.py的MIDDLEWARE配置项中注册上述两个自定义中间件： 

1
2
3
4
5
6
7
8
9
10
11
MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    'middlewares.MD1',  # 自定义中间件MD1
    'middlewares.MD2'  # 自定义中间件MD2
]

完成以上操作后,我们运行一下项目并访问某个视图:

1
2
3
MD1里面的 process_request
MD2里面的 process_request
index视图

再把MD1和MD2在settings.py中的位置调换一下，再访问一个视图，会发现终端中打印的内容如下：

1
2
3
MD2里面的 process_request
MD1里面的 process_request
index视图

看结果我们知道：视图函数还是最后执行的，MD2比MD1先执行自己的process_request方法。

在打印一下两个自定义中间件中process_request方法中的request参数，会发现它们是同一个对象。

由此总结一下：

  1. 中间件的process_request方法是在执行视图函数之前执行的。
  2. 当配置多个中间件时，会按照MIDDLEWARE中的注册顺序，也就是列表的索引值，从前到后依次执行的。（在settings.py里面设置中 从上到下的顺序）
  3. 不同中间件之间传递的request都是同一个对象
  4. 返回None，继续执行后续的中间件的process_request方法，返回response , 不执行后续的中间件的process_request方法

process_response

process_response 有两个参数，一个是request，一个是response，request就是上述例子中一样的对象，response是视图函数返回的HttpResponse对象。该方法的返回值也必须是HttpResponse对象。

给上述的MD1和MD2加上process_response方法： 

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
from django.utils.deprecation import MiddlewareMixin


class MD1(MiddlewareMixin):

    def process_request(self, request):
        print('MD1里面的 process_request')

    def process_response(self, request, response):
        print('MD1里面的 process_response')
        return response


class MD2(MiddlewareMixin):
    def process_request(self, request):
        print('MD2里面的 process_request')
        pass

    def process_response(self, request, response):
        print('MD2里面的 process_response')
        return response

访问一个视图，看一下终端的输出：

1
2
3
4
5
MD2里面的 process_request
MD1里面的 process_request
index视图
MD1里面的 process_response
MD2里面的 process_response

看结果可知：process_response方法是在视图函数之后执行的，并且顺序是MD1比MD2先执行。(此时settings.py中 MD2比MD1先注册)

由此总结一下：

  1. 多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的（在settings.py里面设置中 从下到上的顺序）
  2. 在请求有响应的时候执行process_response方法
  3. 该方法的返回值也必须是HttpResponse对象

process_view

process_view(self, request, view_func, view_args, view_kwargs)

该方法有四个参数

request是HttpRequest对象。

view_func是Django即将使用的视图函数。 （它是实际的函数对象，而不是函数的名称作为字符串。）

view_args是将传递给视图的位置参数的列表.

view_kwargs是将传递给视图的关键字参数的字典。 view_args和view_kwargs都不包含第一个视图参数（request）。

Django会在调用视图函数之前调用process_view方法。

它应该返回None或一个HttpResponse对象。 如果返回None，Django将继续处理这个请求，执行任何其他中间件的process_view方法，然后在执行相应的视图。 如果它返回一个HttpResponse对象，Django不会调用适当的视图函数。 它将执行中间件的process_response方法并将应用到该HttpResponse并返回结果。

给MD1和MD2添加process_view方法:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
from django.utils.deprecation import MiddlewareMixin


class MD1(MiddlewareMixin):

    def process_request(self, request):
        print('MD1里面的 process_request')

    def process_response(self, request, response):
        print('MD1里面的 process_response')
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print('-' * 80)
        print('MD1 中的process_view')
        print(view_func, view_func.__name__)


class MD2(MiddlewareMixin):
    def process_request(self, request):
        print('MD2里面的 process_request')
        pass

    def process_response(self, request, response):
        print('MD2里面的 process_response')
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print('-' * 80)
        print('MD2 中的process_view')
        print(view_func, view_func.__name__)

访问index视图函数，看一下输出结果：

1
2
3
4
5
6
7
8
9
10
11
MD2里面的 process_request
MD1里面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x000001DE68317488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x000001DE68317488> index
index视图
MD1里面的 process_response
MD2里面的 process_response

process_view方法是在process_request之后，视图函数之前执行的，执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的，返回None，继续执行后续的中间件的process_view方法，返回response , 不执行后续的中间件的process_view方法。

process_exception

process_exception(self, request, exception)

该方法两个参数:

一个HttpRequest对象

一个exception是视图函数异常产生的Exception对象。

这个方法只有在视图函数中出现异常了才执行，它返回的值可以是一个None也可以是一个HttpResponse对象。如果是HttpResponse对象，Django将调用模板和中间件中的process_response方法，并返回给浏览器，否则将默认处理异常。如果返回一个None，则交给下一个中间件的process_exception方法来处理异常。它的执行顺序也是按照中间件注册顺序的倒序执行。

给MD1和MD2添加上这个方法：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
from django.utils.deprecation import MiddlewareMixin


class MD1(MiddlewareMixin):

    def process_request(self, request):
        print('MD1里面的 process_request')

    def process_response(self, request, response):
        print('MD1里面的 process_response')
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print('-' * 80)
        print('MD1 中的process_view')
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print('MD1 中的process_exception')


class MD2(MiddlewareMixin):
    def process_request(self, request):
        print('MD2里面的 process_request')
        pass

    def process_response(self, request, response):
        print('MD2里面的 process_response')
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print('-' * 80)
        print('MD2 中的process_view')
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print('MD2 中的process_exception')

如果视图函数中无异常，process_exception方法不执行。

想办法，在视图函数中抛出一个异常：

1
2
3
4
def index(request):
    print('index视图')
    raise ValueError('呵呵')
    return HttpResponse('OK')

在MD1的process_exception中返回一个响应对象：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class MD1(MiddlewareMixin):

    def process_request(self, request):
        print('MD1里面的 process_request')

    def process_response(self, request, response):
        print('MD1里面的 process_response')
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print('-' * 80)
        print('MD1 中的process_view')
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print('MD1 中的process_exception')
        return HttpResponse(str(exception))  # 返回一个响应对象

看输出结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
MD2里面的 process_request
MD1里面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x0000022C09727488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x0000022C09727488> index
index视图
呵呵
MD1 中的process_exception
MD1里面的 process_response
MD2里面的 process_response

注意，这里并没有执行MD2的process_exception方法，因为MD1中的process_exception方法直接返回了一个响应对象。

process_template_response

process_template_response(self, request, response)

它的参数，一个HttpRequest对象，response是TemplateResponse对象（由视图函数或者中间件产生）。

process_template_response是在视图函数执行完成后立即执行，但是它有一个前提条件，那就是视图函数返回的对象有一个render()方法（或者表明该对象是一个TemplateResponse对象或等价方法）。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
class MD1(MiddlewareMixin):

    def process_request(self, request):
        print('MD1里面的 process_request')

    def process_response(self, request, response):
        print('MD1里面的 process_response')
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print('-' * 80)
        print('MD1 中的process_view')
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print('MD1 中的process_exception')
        return HttpResponse(str(exception))

    def process_template_response(self, request, response):
        print('MD1 中的process_template_response')
        return response


class MD2(MiddlewareMixin):
    def process_request(self, request):
        print('MD2里面的 process_request')
        pass

    def process_response(self, request, response):
        print('MD2里面的 process_response')
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print('-' * 80)
        print('MD2 中的process_view')
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print('MD2 中的process_exception')

    def process_template_response(self, request, response):
        print('MD2 中的process_template_response')
        return response

修改views.py中代码 :

1
2
3
4
5
6
7
8
9
def index(request):
    print('index视图')

    def render():
        print('render')
        return HttpResponse('render')
    rep = HttpResponse('OK')
    rep.render = render
    return rep

访问index视图，终端输出的结果：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
MD2里面的 process_request
MD1里面的 process_request
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x000001C111B97488> index
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x000001C111B97488> index
index视图
MD1 中的process_template_response
MD2 中的process_template_response
render
MD1里面的 process_response
MD2里面的 process_response

从结果看出：

视图函数执行完之后，立即执行了中间件的process_template_response方法，顺序是倒序，先执行MD1的，在执行MD2的，接着执行了视图函数返回的HttpResponse对象的render方法，返回了一个新的HttpResponse对象，接着执行中间件的process_response方法。

中间件的执行流程

上面我们一一了解了中间件中的5个方法，它们的参数、返回值以及什么时候执行，现在总结一下中间件的执行流程。

请求到达中间件之后，先按照正序执行每个注册中间件的process_reques方法，process_request方法返回的值是None，就依次执行，如果返回的值是HttpResponse对象，不再执行后面的process_request方法，而是执行当前对应中间件的process_response方法，将HttpResponse对象返回给浏览器。也就是说：如果MIDDLEWARE中注册了6个中间件，执行过程中，第3个中间件返回了一个HttpResponse对象，那么第4,5,6中间件的process_request和process_response方法都不执行，顺序执行3,2,1中间件的process_response方法。

图一

process_request方法都执行完后，匹配路由，找到要执行的视图函数，先不执行视图函数，先执行中间件中的process_view方法，process_view方法返回None，继续按顺序执行，所有process_view方法执行完后执行视图函数。假如中间件3 的process_view方法返回了HttpResponse对象，则4,5,6的process_view以及视图函数都不执行，直接从最后一个中间件，也就是中间件6的process_response方法开始倒序执行。

图二

process_template_response和process_exception两个方法的触发是有条件的，执行顺序也是倒序。总结所有的执行流程如下：

图三

图四

Django请求流程图

图五

-------------本文结束感谢您的阅读-------------

本文标题:Django之中间件

文章作者:GavinLiu

发布时间:2018年01月06日 - 21:01

最后更新:2018年01月06日 - 21:01

原始链接:http://gavinliu4011.github.io/post/11a0df73.html

许可协议: 署名-非商业性使用-禁止演绎 4.0 国际 转载请保留原文链接及作者。

请博主吃个鸡腿吧
分享到： 收藏夹 复制网址 邮件 微信 QQ空间 腾讯微博 豆瓣 一键分享 更多
0%