Django开发-中间件

第1章 中间件介绍

官方的说法中间件是一个用来处理Django的请求和响应的框架级别的钩子。它是一个轻量、低级别的插件系统,用于在全局范围内改变Django的输入和输出。每个中间件组件都负责做一些特定的功能。但是由于其影响的是全局,所以需要谨慎使用,使用不当会影响性能。

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

简单的说就是在wsgi之后urls.py之前在全局操作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配置项是一个列表,列表中是一个个字符串,这些字符串其实是一个个类,也就是一个个中间件。

第2章 自定义中间件

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

2.1 自定义一个中间件

from django.utils.deprecation import MiddlewareMixin

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

    def process_response(self, request, response):
        """
        :param request: 是浏览器发来的请求对象
        :param response: 是视图函数返回的响应对象
        :return:
        """
        print("MD1里面的 process_response")
        return response

2.2 process_request

2.2.1 参数

  1. request:这个request和视图函数中的request是一样的。

2.2.2 执行顺序

按照注册的顺序(在settings.py里面设置中 从上到下的顺序)

2.2.3 何时执行

请求从wsgi拿到之后

2.2.4 返回值

返回None,继续执行后续的中间件的process_request方法

返回response , 不执行后续的中间件的process_request方法

2.2.5 示例:多个中间件时Django执行其process_request方法顺序

  • my_middleware.py
from django.utils.deprecation import MiddlewareMixin

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

class MD2(MiddlewareMixin):
    def process_request(self, request):
        print("MD2里面的 process_request")
  • 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',
    'middlewares.MD1',  # 自定义中间件MD1
    'middlewares.MD2'  # 自定义中间件MD2
]

【运行结果】:

MD1里面的 process_request
MD2里面的 process_request
这是app01里面的index视图函数

【运行结果】:把MD1和MD2的位置调换

MD2里面的 process_request
MD1里面的 process_request
这是app01里面的index视图函数

看结果可以知道视图函数是最后执行的,MD2比MD1先执行自己的process_request方法,打印一下两个自定义中间件中process_request方法中的request参数,会发现它们是同一个对象。

由此总结一下:

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

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

2.3 process_response

2.3.1 参数

  1. request:request就是上述例子中一样的对象
  2. response

2.3.2 执行顺序

按照注册顺序的倒序(在settings.py里面设置中 从下到上的顺序)

2.3.3 何时执行

请求有响应的时候

2.3.4 返回值

必须返回一个response对象

2.3.5 示例:给M1和M2加上process_response方法

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

    def process_response(self, request, response):
        print("MD2里面的 process_response")
        return response

【运行结果】:

MD1里面的 process_request
MD2里面的 process_request
这是app01里面的index视图函数
MD2里面的 process_response
MD1里面的 process_response

通过结果可知process_response方法是在视图函数之后执行的,并且顺序是MD1比MD2先执行。(此时settings.py中 MD1比MD2先注册)

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

2.4 process_view

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

2.4.1 参数

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

2.4.2 执行顺序

按照注册的顺序(在settings.py里面设置中 从上到下的顺序)

2.4.3 何时执行

在urls.py中找到对应关系之后 在执行真正的视图函数之前

2.4.4 返回值

返回None,继续执行后续的中间件的process_view方法

返回response,将执行中间件的process_response方法并将应用到该HttpResponse并返回结果

2.4.5 示例:给MD1和MD2添加process_view方法

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):
        """
        :param request: 浏览器发来的请求对象
        :param view_func: 将要执行的视图函数的名字
        :param view_args: 将要执行的视图函数的位置参数
        :param view_kwargs: 将要执行的视图函数的关键字参数
        :return:
        """
        print("MD1 中的process_view")
        print(view_func, view_func.__name__)


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("MD2 中的process_view")
        print(view_func, view_func.__name__)

【运行结果】:

MD1里面的 process_request
MD2里面的 process_request
MD1 中的process_view
<function index at 0x039DF618> index
MD2里面的process_view
<function index at 0x039DF618> index
这是app01里面的index视图函数
MD2里面的 process_response
MD1里面的 process_response

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

2.5 process_exception

process_exception(self, request, exception)

2.5.1 参数

  1. HttpRequest对象;
  2. exception:是视图函数异常产生的Exception对象

2.5.2 执行顺序

按照注册顺序的倒序(在settings.py里面设置中 从下到上的顺序)

2.5.3 何时执行

视图函数中抛出异常的时候才执行

2.5.4 返回值

返回None,继续执行后续中间件的process_exception

返回response,将调用模板和中间件中的process_response方法并返回给浏览器,否则将默认处理异常

2.5.5 示例:给MD1和MD2添加process_exception方法

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("MD1 中的process_view")
        print(view_func, view_func.__name__)

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

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("MD2 中的process_view")
        print(view_func, view_func.__name__)

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

注意:如果视图函数中无异常,process_exception方法不执行。

在视图函数中抛出一个异常:

def index(request):
    print("这是app01里面的index视图函数")
    raise ValueError("异常测试")

在MD1的process_exception中返回一个响应对象:

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("MD1 中的process_view")
        print(view_func, view_func.__name__)

    def process_exception(self, request, exception):
        print(exception)
        print("MD1 中的process_exception")
        return HttpResponse(str(exception))     # 返回一个响应对象

【运行结果】:

MD1里面的 process_request
MD2里面的 process_request
MD1 中的process_view
<function index at 0x03C0F618> index
MD2里面的process_view
<function index at 0x03C0F618> index
这是app01里面的index视图函数
异常测试
MD2里面的process_exception
异常测试
MD1 中的process_exception
MD2里面的 process_response
MD1里面的 process_response

注意:没有执行MD2的process_exception方法是因为MD1中的process_exception方法直接返回了一个响应对象。

2.6 process_template_response

process_template_response(self, request, response)

2.6.1 参数

  1. HttpRequest对象;
  2. response是TemplateResponse对象(由视图函数或者中间件产生)。

2.6.2 执行顺序

按照注册顺序的倒序(在settings.py里面设置中 从下到上的顺序)

2.6.3 何时执行

视图函数执行完,在执行视图函数返回的响应对象的render方法之前

2.6.4 返回值

返回None,继续执行后续中间件的process_exception

返回response

2.6.5 示例

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("MD1 中的process_view")
        print(view_func, view_func.__name__)

    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("MD2 中的process_view")
        print(view_func, view_func.__name__)

    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视图函数")
    rep = HttpResponse("OK")
    def render():
        print("我是index视图函数内部的render方法")
        return redirect("index中的OK")
    return rep

【运行结果】:

MD1里面的 process_request
MD2里面的 process_request
MD1 中的process_view
<function index at 0x03C0F6A8> index
MD2里面的process_view
<function index at 0x03C0F6A8> index
这是app01里面的index视图函数
MD2里面的 process_response
MD1里面的 process_response

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

第3章 中间件的执行流程

请求到达中间件之后,先按照正序执行每个注册中间件的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方法。

图片[1]|Django开发-中间件|leon的博客

process_request方法都执行完后匹配路由,找到要执行的视图函数先不执行视图函数,先执行中间件中的process_view方法,process_view方法返回None继续按顺序执行,所有process_view方法执行完后执行视图函数。

加入中间件3 的process_view方法返回了HttpResponse对象,则4,5,6的process_view以及视图函数都不执行,直接从最后一个中间件也就是中间件6的process_response方法开始倒序执行。

图片[2]|Django开发-中间件|leon的博客

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

图片[3]|Django开发-中间件|leon的博客

3.1 总结

Django调用注册的中间件里面五个方法的顺序:

  1. process_request

urls.py

  1. process_view

view

  1. 有异常就执行 process_exception
  2. 如果视图函数返回的响应对象有render方法,就执行process_template_response
  3. process_response

图片[4]|Django开发-中间件|leon的博客

第4章 中间件版登录验证

中间件版的登录验证需要依靠session,所以数据库中要有django_session表。

4.1 代码示例

  • urls.py
from django.conf.urls import url
from app01 import views

urlpatterns = [
    url(r'^index/$', views.index),
    url(r'^login/$', views.login, name='login'),
]
  • views.py
from django.shortcuts import render, HttpResponse, redirect

def index(request):
    return HttpResponse('this is index')

def home(request):
    return HttpResponse('this is home')

def login(request):
    if request.method == "POST":
        user = request.POST.get("user")
        pwd = request.POST.get("pwd")

        if user == "leon" and pwd == "shadow":
            # 设置session
            request.session["user"] = user
            # 获取跳到登陆页面之前的URL
            next_url = request.GET.get("next")
            # 如果有,就跳转回登陆之前的URL
            if next_url:
                return redirect(next_url)
            # 否则默认跳转到index页面
            else:
                return redirect("/index/")
    return render(request, "login.html")
  • login.html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta http-equiv="x-ua-compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>登录页面</title>
</head>
<body>
<form action="{% url 'login' %}">
    <p>
        <label for="user">用户名:</label>
        <input type="text" name="user" id="user">
    </p>
    <p>
        <label for="pwd">密 码:</label>
        <input type="text" name="pwd" id="pwd">
    </p>
    <input type="submit" value="登录">
</form>
</body>
</html>
  • middlewares.py
class AuthMD(MiddlewareMixin):
    white_list = ['/login/', ]  # 白名单
    balck_list = ['/black/', ]  # 黑名单

    def process_request(self, request):
        from django.shortcuts import redirect, HttpResponse
        next_url = request.path_info
        print(request.path_info, request.get_full_path())

        if next_url in self.white_list or request.session.get("user"):
            return
        elif next_url in self.balck_list:
            return HttpResponse('This is an illegal URL')
        else:
            return redirect("/login/ next={}".format(next_url))
  • 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',
    'middlewares.AuthMD',
]

AuthMD中间件注册后所有的请求都要走AuthMD的process_request方法。

访问的URL在白名单内或者session中有user用户名,则不做阻拦走正常流程;

如果URL在黑名单中,则返回This is an illegal URL的字符串;

正常的URL但是需要登录后访问,让浏览器跳转到登录页面。

注意:AuthMD中间件中需要session,所以AuthMD注册的位置要在session中间的下方。

4.2 Django请求流程图

图片[5]|Django开发-中间件|leon的博客

第5章 参考资料

https://www.cnblogs.com/liwenzhou/p/8761803.html#autoid-0-0-0

温馨提示:本文最后更新于2022-12-20 20:57:43,已超过431天没有更新。某些文章具有时效性,若文章内容或图片资源有错误或已失效,请联系站长。谢谢!
转载请注明本文链接:https://blog.leonshadow.cn/763482/1726.html
© 版权声明
THE END
喜欢就支持一下吧
点赞0 分享