python-django之中间件

前戏

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

学完今天的内容之后呢，我们就可以用更适宜的方式来实现类似给所有请求都做相同操作的功能了。

中间件

中间件介绍

什么是中间件？

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

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

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

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

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对象，则直接将该对象返回给用户。

自定义一个中间件示例

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

中间件执行

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

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.middlewares.mymiddleware.MD',  # 自定义中间件
    'app01.middlewares.mymiddleware.MD2',  # 自定义中间件
]

process_request

参数: request 请求对象

执行时间: 视图执行之前

执行顺序: 按照注册的顺序 顺序执行

返回值:

• None: 正常流程
• HttpResponse: 后面的中间件的process_request 、路由、视图都不执行。执行当前中间的process_response方法

from django.utils.deprecation import MiddlewareMixin

# 5个方法，4个特点
class MD(MiddlewareMixin):
    def process_request(self,request):
        print(request,id(request))
        print('MD1 procecss_request')
        return HttpResponse('MD1')
        
class MD2(MiddlewareMixin):
    def process_request(self,request):
        print(request,id(request))
        print('MD2 procecss_request')

返回

<WSGIRequest: GET '/index/'> 1843046868488
MD1 procecss_request
<WSGIRequest: GET '/index/'> 1843046868488
MD2 procecss_request
<WSGIRequest: GET '/index/'> 1843046868488
index

# return HttpResponse('MD1')  MD1返回添加了HttpResponse后面的中间件..都不执行
<WSGIRequest: GET '/index/'> 1832722255368
MD1 procecss_request

process_response

参数:

• request 请求对象
• response 响应对象

执行时间: 视图执行之后

执行顺序: 按照注册的顺序 倒序执行

返回值:

• HttpResponse : 必须返回

class MD(MiddlewareMixin):
    def process_request(self,request):
        print('MD1 procecss_request')

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

class MD2(MiddlewareMixin):
    def process_request(self,request):
        print('MD2 procecss_request')

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

返回

MD1 procecss_request
MD2 procecss_request
index
MD2 process_response
MD1 process_response

process_view

参数:

• request 请求对象
• view_func 视图函数
• view_args 视图函数的位置参数
• view_kwargs 视图函数的关键字参数

执行时间: 视图执行之前,路由匹配之后的

执行顺序: 按照注册的顺序 顺序执行

返回值:

• None: 正常流程
• HttpResponse : 后面的中间件的process_view、视图都不执行,执行最后一个中间件的process_response方法

class MD(MiddlewareMixin):
    def process_request(self,request):
        print('MD1 procecss_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('MD1 process_view')
        # return HttpResponse('MD1 process_view') 

class MD2(MiddlewareMixin):
    def process_request(self,request):
        print('MD2 procecss_request')

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

    def process_view(self,request,view_func,view_args,view_kwargs):
        print('MD2 process_view')

返回

MD1 procecss_request
MD2 procecss_request
MD1 process_view
MD2 process_view
index
MD2 process_response
MD1 process_response

# return HttpResponse('MD1')  MD1后面的中间件的process_view、视图都不执行,执行最后一个中间件的process_response方法
MD1 procecss_request
MD2 procecss_request
MD1 process_view
MD2 process_response
MD1 process_response

process_exception

参数:

• request 请求对象
• exception 错误对象

执行时间（触发条件）: 视图函数报错的时候

执行顺序: 按照注册的顺序 倒序执行

返回值:

• None: 当前中间件没有处理异常,交由下一个中间件处理.如果所有的中间件都没有处理,Django处理异常
• HttpResponse : 已经处理好异常,后续的中间件的process_exception不用执行了,执行所有中间件的process_response

# 5个方法，4个特点
class MD(MiddlewareMixin):
    def process_request(self,request):
        print('MD1 procecss_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('MD1 process_view')

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

class MD2(MiddlewareMixin):
    def process_request(self,request):
        print('MD2 procecss_request')

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

    def process_view(self,request,view_func,view_args,view_kwargs):
        print('MD2 process_view')

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

返回

MD1 procecss_request
MD2 procecss_request
MD1 process_view
MD2 process_view
index
invalid literal for int() with base 10: 'abc'
MD2 procecss_exception
invalid literal for int() with base 10: 'abc'
MD1 procecss_exception
MD2 process_response
MD1 process_response

process_template_response

参数:

• request 请求对象
• response TemplateResponse对象

执行时间（触发条件）: 视图函数返回TemplateResponse对象

执行顺序: 按照注册的顺序 倒序执行

返回值:

• Response : 必须返回

views.py

from django.template.response import TemplateResponse

def index(request,*args,**kwargs):
    # 必须返回TemplateResponse
    return TemplateResponse(request,'index.html',{'name':'mhy','age':'18'})

中间件

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

# 5个方法，4个特点
class MD(MiddlewareMixin):
    def process_request(self,request):
        print('MD1 procecss_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('MD1 process_view')

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

    def process_template_response(self,request,response):
        print('MD1 process_template_response')
        response.template_name = 'index1.html'
        response.context_data['age'] = 20
        return response


class MD2(MiddlewareMixin):
    def process_request(self,request):
        print('MD2 procecss_request')

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

    def process_view(self,request,view_func,view_args,view_kwargs):
        print('MD2 process_view')

    def process_exception(self,request,exception):
        print(exception)
        print('MD2 procecss_exception')
        return HttpResponse(exception)

返回

MD1 procecss_request
MD2 procecss_request
MD1 process_view
MD2 process_view
index
MD1 process_template_response
MD2 process_response
MD1 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请求流程图