Django 学习之中间件Middleware

Posted 2022-04-17 hszstudypy

一.中间件介绍

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

Django的中间件官方的定义：

Middleware is a framework of hooks into Django’s request/response processing. <br>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：

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

注意：

　　对于所有请求的批量做处理的时候用中间件

　　单独对某几个函数做处理的时候用装饰器

二.自定义中间件

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,最后到达views的函数中，views函数处理后，在依次穿过中间件，这个时候是process_response,最后返回给请求者。

 

2.使用步骤

(1)先建一个文件夹，里面写一个py文件

(2)然后开始写类

1.中间件就是一个类，类里面写几个方法

class M1(MiddlewareMixin):  必须继承

     def process_request(self,request):  request:请求里面的所有的东西

         print("m1.request_request")

         #这个方法里面别轻易返回值，要是有返回值就不再继续执行后面的了，

#执行自己的process_response和上边的response

        # 一般是无返回值的：继续执行后续的中间件和视图函数

     def process_response(self,request,response):

         return response

    

2.在settings中的MIDDLEWARE加上路径    

文件夹名称.py文件名称.类名

注意注册的书写格式为：app名.写自定义中间件的文件名.类名

如例子MIDDLEWARE注册截图所示：

相应的项目目录截图为：

3.找到继承的那个类，把那个类拿过来

   一般不要用导入的方法，不然有时候更新了就没有这个类了，你就把它继承的那个类拿过来。

3.process_request方法

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

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

我们来看看多个中间件时，Django是如何执行其中的process_request方法的。

(1)首先是写一个视图函数及相应的路由配置，这边就不做多讲解，前面内容都有相关步骤。

视图函数内容为：

def index(request):

    print("运行了index视图函数。。。")

return HttpResponse("ok")

没有自定义中间件的时候，访问index可以返回ok,并且后端打印print的内容。

(2)注册自动中间件

  详见上面截图

(3)自定义中间件内容：

from django.utils.deprecation import MiddlewareMixin

from django.shortcuts import render, HttpResponse

class mid1(MiddlewareMixin):

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,

# 并且会直接返回当前类下的process_response方法.

        print("mid1里面的 process_request")

# return HttpResponse("md1__request方法")

class mid2(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid1里面的 process_request")

(4)运行访问没有返回值的打印情况

(5)运行访问有返回值的时候

如上自定义中间件内容将process_request的函数的返回值的注释去掉，则后端如下打印：

前端打印：

(6)得出中间件运行的过程如下图箭头走势

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

4.process_response方法

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

给3中的例子中都加上process_response方法如下代码：

from django.utils.deprecation import MiddlewareMixin

from django.shortcuts import render, HttpResponse

 

 

class mid1(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid1里面的 process_request")

        # return HttpResponse("mId1__request方法")

 

    def process_response(self, request, response):

        print("mid1里面的 process_response")

        return response

 

 

class mid2(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid2里面的 process_request")

 

    def process_response(self, request, response):

        print("mid2里面的 process_response")

        return response

 

正常运行为后端打印为：

如果将process_request中的返回注释去掉打印为：

只走了mid1类的process_request和process_response的函数，mid2的不运行，且视图函数不运行。

可知得到的流程为：

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

 

例：

from django.utils.deprecation import MiddlewareMixin

from django.shortcuts import render, HttpResponse

 

 

class mid1(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid1里面的 process_request")

        # return HttpResponse("mId1__request方法")

 

    def process_response(self, request, response):

        print("mid1里面的 process_response")

        return response

 

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

        print("mid1 中的process_view")

        # return view_func(request)

 

 

class mid2(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid2里面的 process_request")

 

    def process_response(self, request, response):

        print("mid2里面的 process_response")

        return response

 

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

        print("mid2 中的process_view")

 

正常运行打印为：

如果在process_view处的注释的返回值去掉注释得：

从正常的分析得出，process_view方法是运行在视图函数之前的，如果将

 return view_func(request) 加到mid1类process_view方法中时，process_view直接调用视图函数执行，并返回结果，紧接着直接执行process_response的方法，跳过了mid2中的process_view方法。

得到流程图为：

6.process_exception方法

process_exception(self, request, exception)

该方法两个参数:

HttpRequest对象

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

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

例：

中间件内容代码变为：

from django.utils.deprecation import MiddlewareMixin

from django.shortcuts import render, HttpResponse

 

 

class mid1(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid1里面的 process_request")

        # return HttpResponse("mId1__request方法")

 

    def process_response(self, request, response):

        print("mid1里面的 process_response")

        return response

 

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

        print("mid1 中的process_view")

        # return view_func(request)

 

    def process_exception(self, request, exception):

        print(exception)

        print("mid1 中的process_exception")

# return HttpResponse(exception)

 

 

class mid2(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid2里面的 process_request")

 

    def process_response(self, request, response):

        print("mid2里面的 process_response")

        return response

 

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

        print("mid2 中的process_view")

 

    def process_exception(self, request, exception):

        print(exception)

        print("mid2 中的process_exception")

 

视图函数没有报错的情况，运行后的截图为：(process_exception方法没有被触发)

视图函数有报错的情况：

页面报错，状态码为500

如果去掉return HttpResponse(exception) 的注释运行的到的状态码为500，前端页面返回不是报错页面，而是process_exception的返回值信息。

得到运行流程图为：

7.process_template_response方法（了解）

process_template_response(self, request, response)

该方法参数：

HttpRequest对象

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

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

 

例子：

#!/usr/bin/env python

# -*- coding:utf-8 -*-

# by hsz

from django.utils.deprecation import MiddlewareMixin

from django.shortcuts import render, HttpResponse

 

 

class mid1(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid1里面的 process_request")

        # return HttpResponse("mId1__request方法")

 

    def process_response(self, request, response):

        print("mid1里面的 process_response")

        return response

 

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

        print("mid1 中的process_view")

        # return view_func(request)

 

    def process_exception(self, request, exception):

        print(exception)

        print("mid1 中的process_exception")

        # return HttpResponse(exception)

 

    def process_template_response(self, request, response):

        print("mid1 中的process_template_response")

        return response

 

 

class mid2(MiddlewareMixin):

 

    def process_request(self, request):

        # 默认没有返回值, 如果有返回值,会终止后面的中间件的执行,并且会直接返回当前类下的process_response方法.

        print("mid2里面的 process_request")

 

    def process_response(self, request, response):

        print("mid2里面的 process_response")

        return response

 

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

        print("mid2 中的process_view")

 

    def process_exception(self, request, exception):

        print(exception)

        print("mid2 中的process_exception")

 

    def process_template_response(self, request, response):

        print("mid2 中的process_template_response")

        return response

 

views.py内容为：

from django.shortcuts import render, HttpResponse

# Create your views here.

def index(request):

    # int("aaa")

    print("运行了index视图函数。。。")

 

    def render():

        print("in index/render")

        return HttpResponse("O98K")

 

    rep = HttpResponse("OK")

    rep.render = render

    return rep

 

正常运行后端打印为：

结果得到：

视图函数执行完之后，立即执行了中间件的process_template_response方法。