django中间件

目录

• 一、django中间件
  • 什么是中间件？
  • 如何自定义中间件
• 二、django中间件三个了解的方法
• 三、django中间件五个方法的执行流程详解
• 四、基于django中间件的功能设计
  • 功能设计介绍
  • 如何利用字符串导入模块
  • 功能模拟

一、django中间件

什么是中间件？

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

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

说的直白一点中间件是帮助我们在视图函数执行之前和执行之后都可以做一些额外的操作，它本质上就是一个自定义类，类中定义了几个方法，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',
]

如何自定义中间件

1.创建存储自定义中间件代码的py文件或者目录(如果中间件很多)

2.参考自带中间件的代码编写类并继承

3.在类中编写五个可以自定义的方法(主要的是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)

需要掌握的

process_request

	process_request有一个参数，就是request，这个request和视图函数中的request是一样的(在交给Django后面的路由之前，对这个request对象可以进行一系列的操作)。

	由于request对象是一样的，所以我们可以对request对象进行一系列的操作，包括request.变量名=变量值,这样的操作，我们可以在后续的视图函数中通过相同的方式即可获取到我们在中间件中设置的值。

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

总结：

1. 中间件的process_request方法是在执行视图函数之前执行的。
2. 当配置多个中间件时，会按照MIDDLEWARE中的注册顺序，也就是列表的索引值，从前到后依次执行的。
3. 不同中间件之间传递的request都是同一个对象
4. 如果该方法自己返回了HttpResponse对象那么不再往后执行而是直接原路返回

process_response

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

定义process_response方法时，必须给方法传入两个形参，request和response。request就是上述例子中一样的对象，response是视图函数返回的HttpResponse对象(也就是说这是Django后台处理完之后给出一个的一个具体的视图)。该方法的返回值(必须要有返回值)也必须是HttpResponse对象。如果不返回response而返回其他对象，则浏览器不会拿到Django后台给他的视图，而是我的中间件中返回的对象

总结：

1.响应走的时候会从下往上依次经过每一个注册了的中间件里面的该方法 如果没有则直接跳过

2.该方法有两个先request和response 形参response指代的就是后端想要返回给前端浏览器的数据 该方法必须返回该形参 也可以替换

3.process_response方法在视图函数执行之后执行。

ps：如果在执行process_request方法的时候直接返回了HttpResponse对象那么会原路返回执行process_response 不是执行所有后续中间件的process_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）。

Django会在调用视图函数之前调用process_view方法。

它应该返回None或一个HttpResponse对象。 如果返回None，Django将继续处理这个请求，执行任何其他中间件的process_view方法，然后在执行相应的视图。 如果它返回一个HttpResponse对象，那么将不会执行Django的视图函数，而是直接在中间件中掉头，倒叙执行一个个process_response方法，最后返回给浏览器

ps：process_view方法是在Django路由系统之后，视图系统之前执行的，执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的

process_exception

process_exception(self, request, exception)

该方法两个参数:

一个HttpRequest对象

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

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

process_template_response

process_template_response(self, request, response)

它的参数，一个HttpRequest对象，response是TemplateResponse对象（由视图函数或者中间件产生）。

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

4.一定要在配置文件中注册后中间件才可以生效。

二、django中间件三个了解的方法

1.process_view

process_view方法是在Django路由系统之后（路由匹配成功之后），视图系统之前（执行视图函数/类之前）执行的，执行顺序按照MIDDLEWARE中的注册顺序**从前到后顺序**执行的

2.process_exception

视图函数/类执行报错自动触发(触发顺序是根据注册顺序**从后往前**执行)

3.process_template_response

视图函数/类返回的HttpResponse对象含有render属性(需要在内部定义一个render函数，并且要把这个函数名称绑定给render属性)并且对应一个方法的时候自动触发(触发顺序是根据注册顺序**从后往前**执行)

代码如下（用的不多不用深究）：

views.py

from django.shortcuts import render, HttpResponse, redirect


# Create your views here.
def index_func(request):
    print('from index view')

    def render():
        return HttpResponse('我是一个大奇葩')

    obj = HttpResponse('index view')
    obj.render = render
    return obj

这里是自定义的中间件的代码

from django.utils.deprecation import MiddlewareMixin


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

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

    def process_view(self, request, view_func, view_args, view_kwargs):
        # print(view_func,view_args,view_kwargs)
        print('from MyMiddleWare01 process_view')

    def process_exception(self, request, exception):
        print(exception)
        print('from MyMiddleWare01 process_exception')

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


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

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

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

    def process_exception(self, request, exception):
        print(exception)
        print('from MyMiddleWare02 process_exception')

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

结果如图：

三、django中间件五个方法的执行流程详解

上一部分，我们了解了中间件中的5个方法，它们的参数、返回值以及什么时候执行，现在总结一下中间件的执行流程。

请求到达中间件之后，先按照正序执行每个注册中间件的process_request方法，process_request方法返回的值是None，就依次执行，如果返回的值是HttpResponse对象，不再执行后面的process_request方法，而是执行当前对应中间件的process_response方法(注意不是掉头执行所有的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中间件的功能设计

功能设计介绍

在使用自定义中间件的时候我们体会到了通过注册来启动或关闭一个功能的方便,我们称为功能的插拔式设计.

使用方式介绍:

• 将各个功能制作成配置文件的字符串形式
• 如果想拥有该功能就编写对应的字符串
• 如果不想有该功能则注释掉对应的字符串

如何利用字符串导入模块

这里我们使用importlib模块来模仿django中间件的调用功能的方式.

代码演示如下:

import importlib
s1 = 'bbb.b'  # aaa.bbb.ccc.b
res = importlib.import_module(s1)  # 相当于from aaa.bbb.ccc import b
print(res)  # <module 'bbb.b' from 'D:\\pythonProject03\\djangomiddle\\bbb\\b.py'>
'''注意字符串的结尾最小单位只能是py文件 不能是py文件里面的变量名'''
思考django中间件是如何处理的(最小单位是类名)

功能模拟

需求分析

模拟编写一个消息通知功能(微信、qq、邮箱)

实现方式1:基于函数封装的版本

使用函数封装三个发送消息的应用(其实就写简单一些直接上print打印一句话即可)

然后再类似之前写atm的时候一样用一个启动函数给他运行

如果我们不想执行某个应用的消息通知功能,就把这个功能在启动函数中对应的调用代码注释掉即可.

但是这种使用使用方式没有眼前一亮的感觉,很一般.

实现方式2:基于django中间件的功能设计

首先是使用软件开发目录规范创建文件,将功能分到不同的接口层中去然后写上对应的代码(都是简单模拟)

接下去我们在配置文件settings中模仿这写注册表,同时具体到py文件内部的类名(django也是具体到类名)

在配置文件中注册后我们想到在软件开发目录中我们是把这些接口层的文件当模块导入调用的,而当我们把这个接口层的文件夹当成包导入的时候会更加方便(调包的时候其实就是在掉他内部的双下init文件)

这时候我们通过查看Django模块的配置文件导入中间件的方式,可以看到他在配置文件中注册的信息其实是具体到类的,但是importlib只能具体到py文件,这时候我们想到用split方法切割字符串.

基于上面的这些思考,我们在双下init文件中定义函数设置调用的模块的函数,然后导入配置文件中的配置信息,通过配置信息获取要执行的应用做代表的功能,然后通过切割字符串获取需要执行的功能类,然后创建对象执行功能,这时候我们就实现了通过更改配置信息中的注册表修改功能的执行与否.

评价:眼前一亮,回味无穷!