中间件MiddleWare
中间件MiddleWare
什么是中间件?
官方的说法:中间件是一个用来处理Django的请求和响应的框架级别的钩子。它是一个轻量、低级别的插件系统,用于在全局范围内改变Django的输入和输出。每个中间件组件都负责做一些特定的功能。
但是由于其影响的是全局,所以需要谨慎使用,使用不当会影响性能。
中间件是帮助我们在视图函数执行之前和执行之后都可以做一些额外的操作,它本质上就是一个自定义类,类中定义了几个方法,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', ]
wsgi之后,urls.py之前,在全局操作django请求和响应。
MIDDLEWARE配置项是一个列表,列表中是一个个字符串,这些字符串其实是一个个类,也就是一个个中间件。前面已接触过的csrf_token的使用,其实这就是中间件。
自定义中间件
中间件可以定义五个方法,分别是:(主要的是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对象,则直接将该对象返回给用户。
将中间件建在根目录下
from django.utils.deprecation import MiddlewareMixin #引入模块 class MidWare(MiddlewareMixin):#注意要继承这个类 def process_request(self, request): print("MidWare里面的 process_request") def process_response(self, request, response): print("MidWare里面的 process_response") return response
关于字符串如何实现类方法的使用
process_request
process_request有一个参数,就是request,这个request和视图函数中的request是一样的。
它的返回值可以是None也可以是HttpResponse对象。返回值是None的话,按正常流程继续走,交给下一个中间件处理,如果是HttpResponse对象,Django将不执行视图函数,而将相应对象直接返回给浏览器。
- 中间件的process_request方法是在执行视图函数之前执行的。
- 当配置多个中间件时,会按照MIDDLEWARE中的注册顺序,也就是列表的索引值,从前到后依次执行的。
- 不同中间件之间传递的request都是同一个对象。
process_response
它有两个参数,一个是request,一个是response,request就是上述例子中一样的对象,response是视图函数返回的HttpResponse对象。该方法的返回值也必须是HttpResponse对象。
process_response方法是在视图函数之后执行的
多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的,也就是说第一个中间件的process_request方法首先执行,而它的process_response方法最后执行,最后一个中间件的process_request方法最后一个执行,它的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)。
process_exception
process_exception(self, request, exception)
该方法两个参数:
- request:HttpRequest对象
- exception:是视图函数异常产生的Exception对象。
只有在视图函数中出现异常了才执行.
process_template_response(用的比较少)
process_template_response(self, request, response)
- request:HttpRequest对象.
- response:response是TemplateResponse对象(由视图函数或者中间件产生)。
process_template_response是在视图函数执行完成后立即执行,但是它有一个前提条件,那就是视图函数返回的对象有一个render()方法(或者表明该对象是一个TemplateResponse对象或等价方法)。
视图函数执行完之后,立即执行了中间件的process_template_response方法,顺序是倒序,先执行MD1的,在执行MD2的,接着执行了视图函数返回的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方法执行完后执行views.func(即所谓的视图函数)。加入中间件3 的process_view方法返回了HttpResponse对象,则4,5,6的process_view以及视图函数都不执行,直接从最后一个中间件,也就是中间件6的process_response方法开始倒序执行。
process_template_response和process_exception两个方法的触发是有条件的,执行顺序也是倒序。
所有的执行流程如下:
中间件中5个固定的方法:
process_request(self, request)
- 执行顺序: 按照注册的顺序(在settings.py里面设置中 从上到下的顺序)
- 何时执行: 请求从wsgi拿到之后
- 返 回 值: 返回None,继续执行后续的中间件的process_request方法, 返回response , 不执行后续的中间件的process_request方法
process_response
- 执行顺序: 按照注册顺序的倒序(在settings.py里面设置中 从下到上的顺序)
- 何时执行: 请求有响应的时候
- 返 回 值: 必须返回一个response对象
process_view(self, request, view_func, view_args, view_kwargs):
- 执行顺序: 按照注册的顺序(在settings.py里面设置中 从上到下的顺序)
- 何时执行: 在urls.py中找到对应关系之后 在执行真正的视图函数之前
- 返 回 值: 返回None,继续执行后续的中间件的process_view方法, 返回response。
process_exception(self, request, exception)
- 执行顺序: 按照注册顺序的倒序(在settings.py里面设置中 从下到上的顺序)
- 何时执行: 视图函数中抛出异常的时候才执行
- 返 回 值: 返回None,继续执行后续中间件的process_exception, 返回response。
process_template_response(self, request, response)
- 执行顺序: 按照注册顺序的倒序(在settings.py里面设置中 从下到上的顺序)
- 何时执行: 视图函数执行完,在执行视图函数返回的响应对象的render方法之前
- 返 回 值: 返回None,继续执行后续中间件的process_exception, 返回response。
各函数执行位置标示
注意:中间件版的登录验证需要依靠session,所以数据库中要有django_session表。