Django 中间件
Django 中间件
中间件介绍
官方的说法:中间件是一个用来处理Django的请求和响应的框架级别的钩子。它是一个轻量、低级别的插件系统,用于在全局范围内改变Django的输入和输出。每个中间件组件都负责做一些特定的功能。
但是由于其影响的是全局,所以需要谨慎使用,使用不当会影响性能。
说人话就是,在Django中有一个类,Django框架会在,在请求响应的过程中(视图函数前后)会做一些额外的操作,改变全局的输入、输出。
Django项目的中间件设置在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',
]
MIDDLEWARE配置项是一个列表,列表中是一个个字符串,这些字符串其实是一个个类,也就是一个个中间件。
自定义中间件
中间件可以定义五个方法,分别是:(主要的是process_request和process_response)
- process_request(self,request)
- process_view(self, request, view_func, view_args, view_kwargs)
- process_exception(self, request, exception)
- process_template_response(self,request,response)
- process_response(self, request, response)
自定义一个中间件示例
from django.utils.deprecation import MiddlewareMixin
class MD1(MiddlewareMixin):
def process_request(self, request):
print('from MD1 process_request')
def process_response(self, request, response):
print('from MD1 process_response')
return response
process_request(self,request)
- 执行时间:在视图函数执行之前
- 参数:request,与视图函数中的request同一个
- 执行顺序:按照注册表,顺序执行
- 返回值:
- None:正常流程
- HttpResponse对象:不执行后面中间中的process_request方法,不执行视图函数,直接执行当前中间件中的process_response方法,后面正常走
process_view(self, request, view_func, view_args, view_kwargs)
- 执行时间:在process_request函数执行后,路由匹配之后,在函数视图执行之前
- 参数:request,与视图函数中的request同一个,view_func视图函数,view_args, view_kwargs调用的视图函数参数
- 执行顺序:按照注册表,顺序执行
- 返回值:
- None:正常流程
- HttpResponse对象:不执行后面中间中的process_view方法,不执行视图函数,直接执行当前中间件中的process_response方法,后面正常走
process_exception(self, request, exception)
- 执行时间:在视图函数中出现异常时执行
- 参数:request,与视图函数中的request同一个,exception,异常对象
- 执行顺序:按照注册表,倒叙执行
- 返回值:
- None:正常流程
- HttpResponse对象:不执行后面中间中的process_exception方法,直接执行注册表中最后一个中间件中的process_response方法,后面正常走
process_template_response(self,request,response)
- 执行时间:在视图函数返回后,返回对象里有一个render的方法
- 参数:request,与视图函数中的request同一个,视图返回的HttpResponse对象
- 执行顺序:按照注册表,倒叙执行
- 返回值:必须返回HttpResponse对象
process_response(self, request, response)
- 执行时间:在视图函数执行后
- 参数:request,与视图函数中的request同一个,视图返回的response对象
- 执行顺序:按照注册表,倒叙执行
- 返回值:必须返回HttpResponse对象
middleware
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse
class MD1(MiddlewareMixin):
def process_request(self, request):
print('from MD1 process_request')
def process_response(self, request, response):
print('frmo MD1 process_response')
return response
def process_view(self, request, view_func, view_args, view_kwargs):
print('from MD1 process_view')
# return HttpResponse('from MD1 process_view')
def process_exception(self, request, exception):
print('from MD1 process_exception')
# return HttpResponse('from MD1 process_exception')
def process_template_response(self, request, response):
print('from MD1 process_template_response')
return response
class MD2(MiddlewareMixin):
def process_request(self, request):
print('from MD2 process_request')
def process_response(self, request, response):
print('frmo MD2 process_response')
return response
def process_view(self, request, view_func, view_args, view_kwargs):
print('from MD2 process_view')
# return HttpResponse('from MD2 process_view')
def process_exception(self, request, exception):
print('from MD2 process_exception')
# return HttpResponse('from MD2 process_exception')
def process_template_response(self, request, response):
print('from MD2 process_template_response')
return response
view
from django.shortcuts import HttpResponse
def index(request):
print('index')
# raise Exception
def render():
print('render')
return HttpResponse('render')
rep = HttpResponse('index')
# rep.render = render
return rep
中间件的执行流程
请求到达中间件之后,先按照正序执行每个注册中间件的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方法执行完后执行视图函数。假如中间件3 的process_view方法返回了HttpResponse对象,则4,5,6的process_view以及视图函数都不执行,直接从最后一个中间件,也就是中间件6的process_response方法开始倒序执行。
process_template_response和process_exception两个方法的触发是有条件的,执行顺序也是倒序。总结所有的执行流程如下: