中间件
中间件
django中的中间件(middleware),其实就是一个类,在全局范围内处理django的输入和输出.在请求到来和结束后,django会根据自己的规则在合适的时机执行中间件中相应的方法.
在django项目的settings模块中,有一个MIDDLEWARE变量,其中每一个元素就是一个中间件,如图:
自定义中间件有五种方法,分别是:
- process_request(self,request)
- process_view(self,request,callback,callback_args,callback_kwargs)
- process_template_response(self,request,response)
- process_exception(self,request,exception)
- process_response(self,request,response)
以上方法的返回值可以是None和HttpResponse对象,如果是None,则继续按照django定义的规则向下执行,如果是HttpResponse对象,则直接将该对象返回给用户.
自定义中间件
1. 创建中间件类
from django.http import HttpResponse from django.utils.deprecation import MiddlewareMixin class MD(MiddlewareMixin): def process_request(self, request): print('MD1 process_request') return HttpResponse('MD1 process_request') def process_view(self, request, view_func, view_args, view_kwargs): print('MD1 process_view') # print(view_func,type(view_func)) # print(view_args,type(view_args)) # print(view_kwargs,type(view_kwargs)) # return HttpResponse('MD1 process_view') def process_exception(self, request, exception): print('MD1 process_exception') return ('11111111') def process_response(self, request, response): print('MD1 process_response') return response def process_template_response(self, request, response): print('MD1 process_template_response') response.context_data = {'index': '真的别想了！！'} return response
2. 注册中间件
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.mymiddleware.MD', ]
process_request
process_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") class MD2(MiddlewareMixin): def process_request(self, request): print("MD2里面的 process_request")
此时，我们访问一个视图，会发现终端中打印如下内容：
MD1里面的 process_request
MD2里面的 process_request
app01 中的 index视图
在打印一下两个自定义中间件中process_request方法中的request参数，会发现它们是同一个对象。
总结:
执行时间： 在视图函数之前
参数：request request对象，跟视图函数中的是同一个
执行顺序：按照注册的顺序顺序执行
返回值：
None：正常流程
HttpResponse对象：不执行下一个中间中的process_request方法，也不执行视图函数，直接执行当前中间件中的process_response方法
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_response(self, request, response): print("MD2里面的 process_response") return response
访问一个视图，看一下终端的输出：
MD1里面的 process_request
MD2里面的 process_request
app01 中的 index视图
MD2里面的 process_response
MD1里面的 process_response
总结:
执行时间： 在视图函数之后 参数： request request对象，跟视图函数中的是同一个 response： HttpResponse对象 执行顺序：按照注册的顺序倒叙执行 返回值： HttpResponse对象：正常流程
process_view
该方法有四个参数
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_view方法。 直接执行中间件的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视图函数，看一下输出结果：
MD1里面的 process_request MD2里面的 process_request -------------------------------------------------------------------------------- MD1 中的process_view <function index at 0x000001DE68317488> index -------------------------------------------------------------------------------- MD2 中的process_view <function index at 0x000001DE68317488> index app01 中的 index视图 MD2里面的 process_response MD1里面的 process_response
总结:
执行时间： 在process_request之后，在视图函数之前
参数：
request request对象，跟视图函数中的是同一个
view_func： 要执行的视图函数
view_args： 视图函数的位置参数
view_kwargs： 视图函数的关键字参数
执行顺序：按照注册的顺序顺序执行
返回值：
None：正常流程
HttpResponse对象：之后中间件中的process_view方法不执行，视图函数不执行，执行所有中间件的process_response方法
process_exception
该方法两个参数:
一个HttpRequest对象
一个exception是视图函数异常产生的Exception对象。
这个方法只有在视图函数中出现异常了才执行，它返回的值可以是一个None也可以是一个HttpResponse对象。如果是HttpResponse对象，之后的process_exception不执行,执行所有中间件中的process_response方法，并返回给浏览器。如果返回一个None，则交给下一个中间件的process_exception方法来处理异常,如果所有的process_exception都没有处理异常,则交给django来处理,返回大黄页.
给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)) # 返回一个响应对象
看输出结果：
MD1里面的 process_request MD2里面的 process_request -------------------------------------------------------------------------------- MD1 中的process_view <function index at 0x0000022C09727488> index -------------------------------------------------------------------------------- MD2 中的process_view <function index at 0x0000022C09727488> index app01 中的 index视图 呵呵 MD1 中的process_exception MD2里面的 process_response MD1里面的 process_response
注意，这里并没有执行MD2的process_exception方法，因为MD1中的process_exception方法直接返回了一个响应对象。
总结:
执行时间： 有异常才触发执行 在视图函数之后
参数：
request request对象，跟视图函数中的是同一个
exception 错误对象
执行顺序：按照注册的顺序倒叙执行
返回值：
None：正常流程，错误交给django处理
HttpResponse对象：之后所有中间件中的process_exception方法不执行，，执行所有中间件的process_response方法
process_template_response(用的比较少)
process_template_response(self, request, response)
它有两个参数:
一个HttpRequest对象，
一个是response对象, 注意: response是TemplateResponse对象（由视图函数或者中间件产生）或者是一个HttpResponse对象,但是含有render()方法.
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)) 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") 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") def process_template_response(self, request, response): print("MD2 中的process_template_response") return response
views.py中：
def index(request): print("app01 中的 index视图") def render(): print("in index/render") return HttpResponse("O98K") rep = HttpResponse("OK") rep.render = render return rep
# TemplateResponse(request,'index.html',{'index':"o98k"})
结果:
MD1里面的 process_request MD2里面的 process_request -------------------------------------------------------------------------------- MD1 中的process_view <function index at 0x000001C111B97488> index -------------------------------------------------------------------------------- MD2 中的process_view <function index at 0x000001C111B97488> index app01 中的 index视图 MD2 中的process_template_response MD1 中的process_template_response in index/render MD2里面的 process_response MD1里面的 process_response
视图函数执行完之后，立即执行了中间件的process_template_response方法，顺序是倒序，先执行MD2的，在执行MD1的，接着执行了视图函数返回的HttpResponse对象的render方法，返回了一个新的HttpResponse对象，接着执行中间件的process_response方法。
总结:
执行时间： 视图返回的是TemplateResponse对象才执行，或者对象有一个render的方法,在视图函数执行完后立即执行
参数：
request request对象，跟视图函数中的是同一个
response 响应对象
执行顺序：按照注册的顺序倒叙执行
返回值：
HttpResponse对象：正常流程
中间件的执行流程
上一部分，我们了解了中间件中的5个方法，它们的参数、返回值以及什么时候执行，现在总结一下中间件的执行流程。
请求到达中间件之后，先按照正序执行每个注册中间件的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两个方法的触发是有条件的，执行顺序也是倒序。总结所有的执行流程如下：
附:Django请求流程图
