Django之中间件

中间件介绍

中间件顾名思义，是介于request与response处理之间的一道处理过程，相对比较轻量级，并且在全局上改变django的输入与输出。因为改变的是全局，所以需要谨慎实用，用不好会影响到性能。并且在全局上改变django的输入与输出。中间件帮助我们在视图函数执行之前和执行之后都可以做一些额外的操作，它本质上就是一个自定义类，类中定义了一些方法，Django框架会在请求的特定的时间去执行这些方法。

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

中间件的process_response方法是在执行视图函数之后执行的。当配置了多个中间件时，按照MIDDLEWARE中的注册顺序（即索引顺序）倒序执行，也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，它的process_response方法是最先执行。

 

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配置项是一个列表，列表中是一个个字符串，这些字符串其实是一个个类，也就是一个个中间件。

Django请求生命周期

 

 

 

自定义中间件

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

自定义中间件事例

在项目中创建一个包，随便起名字，一般都放在一个叫做utils的包里面，表示一个公用的组件，创建一个py文件，随便起名字，例如叫做：mymiddleware.py，内容如下

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

 

在setting下的MIDDELWARE下

MIDDLEWARE = [
    'middlewares.MD1',               #第一种写法
    'app01.mymiddleware.MD1',  #第二种写法
]

# 自定义中间件MD1，这个写的是你项目路径下的一个路径，例如，如果你放在项目下，文件夹名成为utils，那么这里应该写utils.middlewares.MD1
View Code

 

process_request

process_request有一个参数，就是request，这个request和视图函数中的request是一样的（id相同）。

在settings下
MIDDLEWARE = [
    'app01.mymiddleware.MD1',
    'app01.mymiddleware.MD2',
]

在app01下的mymiddleware
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')

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

打印结果：
MD1 process_request
MD2 process_request
index                #index是views设置打印的，这里只是帮助看中间件的执行顺序
MD2 process_response
MD1 process_response
View Code

　　它的返回值可以是None也可以是HttpResponse对象。返回值是None的话，

　　按正常流程继续走，交给下一个中间件处理，如果是HttpResponse对象，

　　Django将不执行视图函数，而将相应对象返回给浏览器。

1. 中间件的process_request方法是在执行视图函数之前执行的。
2. 当配置多个中间件时，会按照MIDDLEWARE中的注册顺序，也就是列表的索引值，从前到后依次执行的。
3. 不同中间件之间传递的request都是同一个对象

 

process_response

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

 

多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的，
也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，
它的process_response方法是最先执行。

正常执行：

在settings下
MIDDLEWARE = [
    'app01.mymiddleware.MD1',
    'app01.mymiddleware.MD2',
]

在app01下的mymiddleware
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')

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

打印结果：
MD1 process_request
MD2 process_request
index                #index是views设置打印的，这里只是帮助看中间件的执行顺序
MD2 process_response
MD1 process_response
View Code

process_request遇到HttpResponse：

在settings下
MIDDLEWARE = [
    'app01.mymiddleware.MD1',
    'app01.mymiddleware.MD2',
]

在app01下的mymiddleware
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import render,HttpResponse

class MD1(MiddlewareMixin):
    def process_request(self,request):
        print('MD1 process_request')
        return HttpResponse('1')

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

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

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

打印结果：
MD1 process_request
MD1 process_response
View Code

如果当请求MD1遇到return HttpResponse时，将不再向下走执行MD1的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）。

 

正常执行：

在settings下
MIDDLEWARE = [
    'app01.mymiddleware.MD1',
    'app01.mymiddleware.MD2',
]

在app01下的mymiddleware
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import render,HttpResponse

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


    def process_view(self,request,view_func,view_args,view_kwargs):
        print('MD1 process_view')
        # print(view_func)       #<function index at 0x0000024BE9DF6510>
        # print(view_args)       #()
        # print(view_kwargs)     #{}

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



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

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

    def process_response(self, request,response):
        print('MD2 process_response')
        return response
打印结果：
MD1 process_request
MD2 process_request
MD1 process_view
MD2 process_view
index
MD2 process_response
MD1 process_response
View Code

process_view遇到HttpResponse：

在settings下
MIDDLEWARE = [
    'app01.mymiddleware.MD1',
    'app01.mymiddleware.MD2',
]

在app01下的mymiddleware
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import render,HttpResponse

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


    def process_view(self,request,view_func,view_args,view_kwargs):
        print('MD1 process_view')
        return HttpResponse('1')

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



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

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

    def process_response(self, request,response):
        print('MD2 process_response')
        return response
打印结果：
MD1 process_request
MD2 process_request
MD1 process_view
MD2 process_response
MD1 process_response
View Code

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

　流程图如下：

 

 

 

process_exception

process_exception(self, request, exception)

 该方法两个参数:

request     #HttpRequest对象
exception   #视图函数异常产生的Exception对象。

触发条件：视图层面有异常才执行

exception  时视图函数异常产生的Exception对象。没有错误时不显示的

所以，我们在这里给前端一个错误例如：int（‘aaa’）

exception  如果是None是倒序打印，None处理不了则进入下一个exception  

# 在settings下
# MIDDLEWARE = [
#     'app01.mymiddleware.MD1',
#     'app01.mymiddleware.MD2',
# ]

# 在app01下的mymiddleware
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import render,HttpResponse

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


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


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

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



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

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

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

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

# 打印结果：
MD1 process_request
MD2 process_request
MD1 process_view
MD2 process_view
index                    #视图
MD2 中的process_exception
MD1 中的process_exception 
MD2 process_response
MD1 process_response
View Code

我们在这里给exception  一个HttpResponse

# 在settings下
MIDDLEWARE = [
    'app01.mymiddleware.MD1',
    'app01.mymiddleware.MD2',
]

# 在app01下的mymiddleware
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import render,HttpResponse

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


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


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

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



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

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

    def process_exception(self, request, exception):
        print("MD2 中的process_exception")
        return HttpResponse('1')

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

# 打印结果：
MD1 process_request
MD2 process_request
MD1 process_view
MD2 process_view
index             #视图
MD2 中的process_exception    #HttpResponse不在执行下面的exception
MD2 process_response
MD1 process_response
View Code

 

 

 

process_template_response（用的比较少）

process_template_response(self, request, response)

request        #HttpRequest对象
response       #TemplateResponse对象（由视图函数或者中间件产生）。

触发条件：视图返回的response 是一个template_response对象

template_response和render的区别

template_response 的模板渲染在最后（{{字符串}}）

views下需要导入模块

from django.template.response import TemplateResponse

from django.shortcuts import render
from django.template.response import TemplateResponse
# Create your views here.

def index(request):
    print('index')
    return TemplateResponse(request,'index.html')
View Code
# 在settings下
MIDDLEWARE = [
    'app01.mymiddleware.MD1',
    'app01.mymiddleware.MD2',
]

# 在app01下的mymiddleware
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import render,HttpResponse

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


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

    def process_template_response(self, request, response):
        print('MD1 process_template_response')
        print(response.template_name)
        print(response.context_data)
        return response

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


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



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

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

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

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


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

# 打印结果：
MD1 process_request
MD2 process_request
MD1 process_view
MD2 process_view
index
MD2 process_template_response
MD1 process_template_response
index.html
{'name': 'alex'}
MD2 process_response
MD1 process_response
View Code

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

中间件的执行流程

请求到达中间件之后，先按照正序执行每个注册中间件的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两个方法的触发是有条件的，执行顺序也是倒序。总结所有的执行流程如下：

 

 

posted @ 2019-09-06 16:14  驰念  阅读(175)  评论(0)  编辑  收藏  举报