title: Django中间件 #标题tags: #标签
date: 2022-01-13
categories: python # 分类

django之cookie和session文章中，我们给视图函数加装饰器来判断是用户是否登录，把没有登录的用户请求跳转到登录页面。通过给几个特定视图函数加装饰器实现了这个需求。但是以后添加的视图函数可能也需要加上装饰器，这样是不是稍微有点繁琐。

这个所谓的中间件（这里的中间件，不是我们常见的各种消息中间件哦，比如kafka、rabbitmq等），可以让我们用更适宜的方式来实现类似给所有请求都做相同操作的功能了。

本文章的项目地址

中间件介绍

中间件顾名思义，是介于request与response处理之间的一道处理过程，相对比较轻量级，并且在全局上改变django的输入与输出。因为改变的是全局，所以需要谨慎实用，用不好会影响到性能。

Django的中间件的定义：

  1. Middleware is a framework of hooks into Django’s request/response processing. <br>It’s a light, 
  2. low-level “plugin” system for globally altering Django’s input or output.

如果想修改请求，例如被传送到view中的HttpRequest对象。 或者你想修改view返回的HttpResponse对象，这些都可以通过中间件来实现。可能你还想在view执行之前做一些操作，这种情况就可以用 middleware来实现。

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

我们一直都在使用中间件，只是没有注意到而已，打开Django项目的Settings.py文件，看到下面的MIDDLEWARE配置项，django默认自带的一些中间件：

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请求的时候，注释掉django.middleware.csrf.CsrfViewMiddleware这个中间件，请求就不会被forbidden了。

下图是django的一个完整的请求生命周期：

Django中间件 - 图1

自定义中间件

中间件可以定义五个方法，分别是：（主要的是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对象，则直接将该对象返回给用户。

以上的五个中间件中，只有process_request和process_response比较常用一些，其他的了解即可。

当用户发起请求的时候会依次经过所有的的中间件，这个时候的请求时process_request,最后到达views的函数中，views函数处理后，在依次穿过中间件，这个时候是process_response,最后返回给请求者。

Django中间件 - 图2

上述的中间件都是django中的，我们也可以自己定义一个中间件，我们可以自己写一个类，但是必须继承MiddlewareMixin。

中间件的process_request方法是在执行视图函数之前执行的。当配置多个中间件时，会按照MIDDLEWARE中的注册顺序，也就是列表的索引值，从前到后依次执行的。

不同中间件之间传递的request都是同一个对象，多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的，也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，它的process_response方法是最先执行。

中间件中的五个方法

demo示例

先来自定义个中间件，看看效果。

在自定义一个中间件的时候，我们一般会在项目中创建一个utils目录，表示一个公用的组件，创建一个.py文件，名字随便起，如下：

Django中间件 - 图3

middlewares.py文件中的代码如下：

from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse


class MD1(MiddlewareMixin):
    '''
    自定义中间件，不是必须要有下面这两个方法，
    有request方法说明请求来了要处理，有response方法说明响应出去时需要处理，
    不是非要写这两个方法，如果你没写process_response方法，那么会一层一层的往上找，
    哪个中间件有process_response方法就将返回对象给哪个中间件
    '''

    def process_request(self, request):
        print("MD1类里面的process_request！")
        return None  # return None可以省略

    def process_response(self, request, response):  # request和response两个参数必须有
        print("MD1类里面的process_response！")
        '''
        print(response.__dict__['_container'][0].decode('utf-8')) 
        查看响应体里面的内容的方法，或者直接使用response.content也可以看到响应体里面的内容，
        由于response是个变量，直接点击看源码是看不到的，你打印type(response)发现是HttpResponse对象，
        查看这个对象的源码就知道有什么方法可以用了。
        '''
        # return HttpResponse('瞎搞')  # 如果写了这个，那么视图函数返回过来的内容就被它给替代了
        return response  # 必须返回response，不然上层的中间件就拿不到httpresponse对象，就会报错

现在我们来给项目加上这个中间件，来看看效果。

首先项目的settings.py文件中需要先引入这个自定义中间件：

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',
    'app01.utils.middlewares.MD1'      # 添加我们自定义的中间件
]

要访问的视图函数如下：

def request_to_convert(request):
    # print(request.headers)
    print('视图函数里的代码执行了！')
    return HttpResponse('请求过来了，successed！！！')

当我们访问上面的视图函数时，控制台会打印如下：

MD1类里面的process_request！
视图函数里的代码执行了！
MD1类里面的process_response！

好，现在我们来看看关于中间件的五个方法。

process_request

process_request有一个参数，就是request，这个request和视图函数中的request是一样的。

它的返回值可以是None也可以是HttpResponse对象。返回值是None的话，按正常流程继续走，交给下一个中间件处理，如果是HttpResponse对象，Django将不执行视图函数，而将相应HttpResponse对象返回给浏览器。

如下，我们将上面的示例中间件代码修改如下：

    def process_request(self, request):
        print("MD1类里面的process_request！")
        ret = HttpResponse('你这个请求有问题，不让你走了')
        return ret

    def process_response(self, request, response):
        print("MD1类里面的process_response！")
        return response

那么现在再次访问页面，就会返回：

Django中间件 - 图4

对应的控制台输出如下：

MD1类里面的process_request！
MD1类里面的process_response！

process_response

它有两个参数，一个是request，一个是response，request就是一个对象，response是视图函数返回的HttpResponse对象。该方法的返回值也必须是HttpResponse对象。

我们可以自定义一个HttpResponse对象，来覆盖视图函数返回的HttpResponse对象，将代码改为如下：

    def process_request(self, request):
        print("MD1类里面的process_request！")
        return None  # return None可以省略

    def process_response(self, request, response):  # request和response两个参数必须有，方法名字随便取
        print("MD1类里面的process_response！")
        return HttpResponse('瞎搞')  # 如果写了这个，那么视图函数返回过来的内容就被它给替代了
        # return response  # 必须返回response，不然上层的中间件就拿不到httpresponse对象，就会报错

此时在访问，看到的页面就是下面这样了：

Django中间件 - 图5

对应的，控制台输出如下：

MD1类里面的process_request！
视图函数里的代码执行了！
MD1类里面的process_response！

后面要三个方法不常用，但是最好也要知道。

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并返回结果。

Django中间件 - 图6

现在我们来给middleware.py文件中添加process_view方法，如下：

    def process_view(self, request, view_func, view_args, view_kwargs):
        print("-" * 80)
        print("MD1 中的process_view")
        print(view_func, view_func.__name__)
        '''
        就是url映射到的那个视图函数，也就是说每个中间件的这个process_view已经提前拿到了要执行的那个视图函数
        ret = view_func(request) #提前执行视图函数，不用到了上图的试图函数的位置再执行，如果你视图函数有参数的话，可以这么写 view_func(request,view_args,view_kwargs) 
        return ret  #直接就在MD1中间件这里这个类的process_response给返回了，就不会去找到视图函数里面的这个函数去执行了。
        '''

那么再次请求页面时，控制台就会输出如下：

MD1类里面的process_request！
--------------------------------------------------------------------------------
MD1 中的process_view
<function request_to_convert at 0x000001E74ABCB0D0> request_to_convert
视图函数里的代码执行了！
MD1类里面的process_response！

process_view方法是在process_request之后，reprocess_response之前，视图函数之前执行的，执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的，图示如下：

Django中间件 - 图7

process_exception
process_exception(self, request, exception)

该方法两个参数:

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

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

Django中间件 - 图8

现在我们来给middleware.py文件中添加process_view方法，如下：

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

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

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

def request_to_convert(request):
    print('视图函数中模拟的异常！')
    raise ValueError("报错了大哥")
    return HttpResponse("O98K")

    # print(request.headers)
    print('视图函数里的代码执行了！')
    return HttpResponse('请求过来了，successed！！！')

现在再访问页面，页面显示如下：

Django中间件 - 图9

对应的，控制台输出如下：

MD1类里面的process_request！
--------------------------------------------------------------------------------
MD1 中的process_view
<function request_to_convert at 0x000002194D9CEF70> request_to_convert
视图函数中模拟的异常！
报错了大哥
MD1 中的process_exception
MD1类里面的process_response！

process_exception方法执行流程如下：

Django中间件 - 图10

process_template_response（用的比较少）
process_template_response(self, request, response)

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

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

现在我们来给middleware.py文件中添加process_view方法，如下：

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

views.py中：

def indextest(request):
    print('来视图函数了')
    def render():
        print("in index/render")
        # raise ValueError('出错啦') 
        '''
        至于render函数中报错了，那么会先执行process_template_response方法，然后执行process_exception方法，
        如果是在render方法外面报错了，那么就不会执行这个process_template_response方法了。
        '''
        return HttpResponse("O98Kaabbc")  # 返回的将是这个新的对象

    rep = HttpResponse("OK")
    rep.render = render
    return rep

此时访问页面，返回如下：

Django中间件 - 图11

对应的控制台输出如下：

MD1类里面的process_request！
--------------------------------------------------------------------------------
MD1 中的process_view
<function indextest at 0x000001FFF140EEE0> indextest
来视图函数了
MD1 中的process_template_response
in index/render
MD1类里面的process_response！

从结果看出：

视图函数执行完之后，立即执行了中间件的process_template_response方法，顺序是倒序(如果定义了多个process_template_response方法)，接着执行了视图函数返回的HttpResponse对象的render方法，返回了一个新的HttpResponse对象，接着执行中间件的process_response方法。

通过中间件做session认证

之前做的session认证，都是通过在函数上面加装饰器搞的，比较麻烦，看看中间件怎么搞，session认证必须放在django自带的session中间件的下面，所以自定义中间之后，需要注意你的中间件的摆放顺序。

项目地址

自定义中间件authentication.py
# 文件内容如下：
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse, redirect, reverse


class Login_Auth(MiddlewareMixin):
    '''
    通过white_list定义url的白名单，确保在没有携带session过来的请求可以访问到白名单中的页面
    比如登录页面
    通过balck_list定义url的黑名单
    '''
    white_list = [
        reverse('session_login'),
    ]
    balck_list = [
        '/black/'
    ]

    def process_request(self, request):

        req_uri = request.path
        _is_login = request.session.get('is_login')
        # print(_is_login, type(_is_login))

        # 如果用户已登录或者请求的路径在白名单中，则放行
        if _is_login or req_uri in self.white_list:
            return None
        elif req_uri in self.balck_list:
            return HttpResponse('This is an illegal URL')
        else:
            return redirect('session_login')

    def process_response(self, request, response):
        print('Login_Auth中的process_response')
        return response

views.py
# views.py文件内容如下
from django.shortcuts import render, redirect, HttpResponse
from django.views import View
from django.http import JsonResponse


# Create your views here.

def index(request):
    return render(request, 'index.html')
    return ret


def session_home(request):
    # print('session_home')
    return render(request, 'home.html')


def logout(request):
    request.session.flush()
    return redirect('session_login')


class Session_Login(View):
    def get(self, request):
        return render(request, 'session_login.html')

    def post(self, request):
        _username = request.POST.get('uname')
        _passwd = request.POST.get('pwd')

        if _username == 'ljz' and _passwd == '123.com':
            request.session['is_login'] = True
            request.session['username'] = 'lvjianzhao'
            return redirect('session_home')
        else:
            return HttpResponse('登录失败!!!')

urls.py文件
# urls.py文件内容如下
from django.urls import path
from app01 import views

urlpatterns = [
    path('index/', views.index, name='index'),
    path('session_home/', views.session_home, name='session_home'),
    path('session_login/', views.Session_Login.as_view(), name='session_login'),
    path('logout/', views.logout, name='logout'),
]

Django请求相关流程图

自定义多个中间件的请求流程

如果我们自定义了多个中间件，那么它的请求流程如下：

Django中间件 - 图12

中间件执行流程

上面说了下中间件中的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方法。

Django中间件 - 图13

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

Django中间件 - 图14

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

Django中间件 - 图15

Django中间件 - 图16

Django请求流程图

Django中间件 - 图17