中间件
中间件介绍
什么是中间件?
官方的说法: 中间件是一个用来处理Django的请求和响应的框架级别的钩子.它的一个轻量,低级别的插件系统,用于在全局范围内改变Django的输入和输出.每个中间件组件都负责做一些特定的功能.但是由于影响的是全局,所以需要谨慎使用,使用不当会影响性能,
说的直白一点,中间件是帮助我们在视图函数执行之前和执行之后都可以做一些额外的操作,它本质上是一个自定义类,类中定义了几个方法,Django框架会在处理请求的特定时间去执行这些方法.
我们一直在使用中间件,只是一直没有注意而已,打开Django中的Setting文件,会看到下面的配置文件.
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配置项是一个列表,列表是一个个字符串,这些字符串其实是一个个类,也就是一个个中间件.
自定义中间件
中间件可以定义五个方法,分别是:(主要是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或者一个Response对象,如果是None,则继续按照Django定义的规则向后继续执行,如果是HttpResponse对象,则直接将对象返回给用户.
自定义一个中间件示例
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
process_request
pricess_request有一个参数,就是request,这个request和视图函数中的request是一样的.
他的返回值可以是None,也可以是HttpResponse对象,返回值是None,按正常的流程走,交给下一个中间件处理,如果是HttpResponse对象,Django将不执行视图函数,而将响应对象返回给浏览器.
我们来看看多个中间件时,Django是如何执行其中的process_request方法的.
from django.utils.deprecation import MiddlewareMixin class MD1(MiddlewareMixin): def process_request(self,request): print("MD1里面的 process_request") def MD2(MiddlewareMixin): print("MD2里面的 process_request")
在setting.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', '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参数,会发现它们是同一个对象.
由此总结:
- 中间件的process_request方法是在执行视图函数之前执行的.
- 当配置多个中间件时,会按照MIDDLEWARE中的注册顺序,也就是列表的索引值,从前到后依次执行的.
- 不同中间件之间传递的request都是同一个对象.
process_response
它有两个参数,一个是request,一个是response,request就是上述例子中一样的对象.
response是视图函数返回的HttpResponse对象,该方法的返回值也必须是HttpResponse对象.
综上所述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") def process_reponse(self,request,response): print("MD2里面的process_response") return response
访问一下视图,看一下终端的输出:
MD2里面的 process_request
MD1里面的 process_request
app01 中的 index视图
MD1里面的 process_response
MD2里面的 process_response
看结果可知:
process_response方法是在视图函数之后执行的,并且顺序是MD1比MD2先执行.(此时setting.py中MD2比MD1先注册)
多个中间件的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).
Django会在调用视图韩式之前调用process_view方法.
它应该返回None或一个HttpResponse对象.如果返回None,Django将继续处理这个请求,执行任何其他中间件的process_view方法,然后再执行相应的视图.如果它返回一个HttpResponse对象,Django不会调用适当的视图函数.它将执行中间件的process_response方法并将应用到该HttpResponse并返回结果.
给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): print("-" * 80) print("MD1 中的process_view") print(view_func, view_func.__name__) class MD2(MiddlewareMixin): def process_request(self, request): print("MD2里面的 process_request") 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__)
访问index视图函数,看一下输出结果:
MD2里面的 process_request MD1里面的 process_request -------------------------------------------------------------------------------- MD2 中的process_view <function index at 0x000001DE68317488> index -------------------------------------------------------------------------------- MD1 中的process_view <function index at 0x000001DE68317488> index app01 中的 index视图 MD1里面的 process_response MD2里面的 process_response
process_view方法是在rocess_request之后,视图函数之前执行的,执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的.
process_exception
process_exception(self,request,exception)
该方法两个参数:
一个HttpRequest对象
一个exception是视图函数异常产生的Exception对象.
这个方法只有在视图函数中出现异常才执行,它返回的值可以是一个None,也可以是一个HttpResponse对象.如果是HttpResponse对象,Django将调用模板和中间件中的process_response方法.并返回给浏览器,否则将默认处理异常.如果返回一个None,则交给下一个中间件的process_exception方法来处理异常.它的执行顺序也是按照中间价注册顺序的倒叙执行.
给MD1和MD2添加上这个方法:
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__) def process_exception(self, request, exception): print(exception) print("MD1 中的process_exception") class MD2(MiddlewareMixin): def process_request(self, request): print("MD2里面的 process_request") 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__) def process_exception(self, request, exception): print(exception) print("MD2 中的process_exception")
如果视图函数中无异常,process_exception方法不执行.
想办法在视图函数中抛出一个异常:
def index(request): print("app01 中的 index视图") raise ValueError("呵呵") return HttpResponse("O98K")
在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("-" * 80) 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)) # 返回一个响应对象
看输出结果:
MD2里面的 process_request MD1里面的 process_request -------------------------------------------------------------------------------- MD2 中的process_view <function index at 0x0000022C09727488> index -------------------------------------------------------------------------------- MD1 中的process_view <function index at 0x0000022C09727488> index app01 中的 index视图 呵呵 MD1 中的process_exception MD1里面的 process_response MD2里面的 process_response
注意,这里并没有执行MD2的process_exception方法,因为MD1中的process_exception方法直接返回一个响应对象.