django系列8.1--django的中间件01 自定义中间件的5个方法

一.Django中的中间件

Django中间件定义:

Middleware is a framework of hooks into Django’s request/response processing. It’s a light, 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配置项是一个列表，列表中是一个个字符串，这些字符串其实是一个个类，也就是一个个中间件。

二.自定义中间件

在开源中国的网站中有很多关于中间件的详细解释,django的中间件可以定义五个方法,主要用到process_request和process_response

1.中间件可以自定义的五个方法

• process_request(self, request)
• process_view(self, request, view_func, view_args, view_kwargs) 在视图函数执行之前执行
• process_template_response(self, request, response) 在view函数执行后执行,返回对象必须有render方法
• process_exception(self, request, exception) 在视图函数异常时执行
• process_response(self, request, response)

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

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

图中的中间件都是django中的, 我们也可以自己定义一个中间件.自己定义一个类,一定要继承MiddlewareMixin

2.自定义一个中间件示例

1.目录：

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

from django.utils.deprecation import MiddlewareMixin

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

    def process_response(self, request, response):
        print("中间件1里面的 process_response")
        return response

2.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',
    'utils.middlewares.MD1',  # 自定义中间件MD1，这个写的是你项目路径下的一个路径，例如，如果你放在项目下，文件夹名成为utils，那么这里应该写utils.middlewares.MD1
    'utils.middlewares.MD2'  # 自定义中间件MD2
]

三.中间件五种方法详解

1.process_request

按注册顺序从上到下执行,第一个process_request方法首先执行

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

2.process_response

按注册顺序倒序执行,使用时要返回response,如果返回HttpResponse(“消息”)会将视图函数中断

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

流程图:

测试示例1(中间件return response)

这里测试一下多个中间件时,Django是如何执行其中的process_request和process_response方法的

utils/middlewares.py

from django.utils.deprecation import MiddlewareMixin

class MD1(MiddlewareMixin):
    def process_request(self, request):
        print("中间件1里面的 process_request")

    def process_response(self, request, response):
        print("中间件1里面的 process_response")
        return response  # 必须有返回值,return response, response就像接力棒一样,传向下一层
    	#return HttpResponse("ok")  # 如果这样写,那么视图返回过来的内容就会被它替代
        
class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("中间件2里面的 process_request")

    def process_response(self, request, response):
        print("中间件2里面的 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',
    'utils.middlewares.MD1',  # 这里注册MD1
    'utils.middlewares.MD2',
]

访问一个视图,控制台结果为

中间件1里面的 process_request
中间件2里面的 process_request
app中的视图函数
[08/Mar/2019 16:17:25] "GET /login/ HTTP/1.1" 200 528
中间件2里面的 process_response
中间件1里面的 process_response

由此可以得出结论:

process_response方法是在视图函数之后执行的，并且顺序是MD1比MD2先执行。(此时settings.py中 MD2比MD1先注册). 多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的，也就是说第一个中间件的process_request方法首先执行，而它的process_response方法最后执行，最后一个中间件的process_request方法最后一个执行，它的process_response方法是最先执行。

测试示例2(中间件return HttpResponse(‘ok’))

process_request方法里面不写返回值，默认也是返回None，如果自己写了return None，也是一样的效果，不会中断你的请求，但是如果return 一个httpresponse对象，那么就会在这个方法中断你的请求，直接返回给用户，这就成了非正常的流程了

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

class Md1(MiddlewareMixin):
    
    def process_request(self,request):
        print("中间件1请求") 
        return HttpResponse("Md2中断")  # 注意这里,这个例子就是为了测试这样返回的效果

    def process_response(self,request,response):
        print("中间件1返回")
        return response

class Md2(MiddlewareMixin):

    def process_request(self,request):
        print("中间件2请求")
        
    def process_response(self,request,response):
        print("中间件2返回")
        return response

结果如下:

中间件1里面的 process_request
中间件1里面的 process_response

process_request方法里面不写返回值，默认也是返回None，如果你写了return None，也是一样的效果，不会中断请求，但是如果return一个httpresponse对象，那么就会在这个方法中断请求，直接返回给用户，这就成了非正常的流程了. 并且，如果你在这里return了httpresponse对象，那么会从你这个中间件类中的process_response方法开始执行返回操作，所以这个类里面只要有process_response方法，肯定会执行

3.process_view

process_view方法是在process_request之后，reprocess_response之前，视图函数之前执行的，执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的。它应该返回None或一个HttpResponse对象。 如果返回None，Django将继续处理这个请求，执行任何其他中间件的process_view方法，然后在执行相应的视图。 如果它返回一个HttpResponse对象，Django不会调用对应的视图函数。 它将执行中间件的process_response方法并将应用到该HttpResponse并返回结果。

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

该方法有四个参数
　　

• request是HttpRequest对象.　　
• view_func是Django即将使用的视图函数。 （它是实际的函数对象，而不是函数的名称作为字符串
• view_args是将传递给视图的位置参数的列表.
  　　
• view_kwargs是将传递给视图的关键字参数的字典。 view_args和view_kwargs都不包含第一个视图参数(request).

测试示例

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__) #就是url映射到的那个视图函数，也就是说每个中间件的这个process_view已经提前拿到了要执行的那个视图函数
        #ret = view_func(request) #提前执行视图函数，不用到了上图的试图函数的位置再执行，如果你视图函数有参数的话，可以这么写 view_func(request,view_args,view_kwargs) 
        #return ret  #直接就在MD1中间件这里这个类的process_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__)

访问视图函数的结果:

MD1里面的 process_request
MD2里面的 process_request
--------------------------------------------------------------------------------
MD1 中的process_view
<function index at 0x000001DE68317488> index
--------------------------------------------------------------------------------
MD2 中的process_view
<function index at 0x000001DE68317488> index
app01 中的 index视图
MD2里面的 process_response
MD1里面的 process_response

4.process_excepiton

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

process_exception(self, request, exception)

该方法两个参数:

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

测试示例:

from django.utils.deprecation import MiddlewareMixin


class MD1(MiddlewareMixin):

    def process_request(self, request):
        print("中间件1里面的 process_request")

    def process_response(self, request, response):
        print("中间件1里面的 process_response")
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print("-" * 80)
        print("中间件1中的process_view")
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print("中间件1 中的process_exception")


class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("中间件2里面的 process_request")
        pass

    def process_response(self, request, response):
        print("中间件2里面的 process_response")
        return response

    def process_view(self, request, view_func, view_args, view_kwargs):
        print("-" * 80)
        print("中间件2 中的process_view")
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print("中间件2 中的process_exception")

在视图函数中抛出一个自定义异常

def index(request):
    print("app 中的 index视图")
    raise ValueError("异常")

结果

中间件1里面的 process_request
中间件2里面的 process_request
--------------------------------------------------------------------------------
中间件1中的process_view
<function index at 0x00000258A097AB70> index
--------------------------------------------------------------------------------
中间件2 中的process_view
<function index at 0x00000258A097AB70> index
中间件2 中的process_exception
中间件1 中的process_exception
ValueError: 异常
中间件2里面的 process_response
中间件1里面的 process_response

5.process_template_response

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

process_template_response(self, request, response)

参数: 一个HttpRequest对象，response是TemplateResponse对象（由视图函数或者中间件产生)

测试示例

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")

    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")

    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

def index(request):
    print("app01 中的 index视图")

    def render():
        print("in index/render")
        return HttpResponse("OK")
    rep = HttpResponse("OK")
    rep.render = render  # 返回的对象要有一个render方法,process_template_response才会执行
    return rep

访问视图之后的结果

MD1里面的 process_request
MD2里面的 process_request
--------------------------------------------------------------------------------
MD1 中的process_view
--------------------------------------------------------------------------------
MD2 中的process_view
app01 中的 index视图
MD2 中的process_template_response
MD1 中的process_template_response
in index/render
MD2里面的 process_response
MD1里面的 process_response

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