Django之中间件
中间件
中间件的概念
中间件顾名思义,是介于request与response处理之间的一道处理过程,相对比较轻量级,并且在全局
上改变django的输入与输出。因为改变的是全局,所以需要谨慎实用,用不好会影响到性能。
Django的中间件的定义:
Middleware
is` `a framework of hooks into Django’s request
/response processing.
It’s a light, low
-level “plugin” system
forglobally altering Django’sinput
or
output
.
中间件是一个用来处理Django的请求和响应的框架级别的钩子。它是一个轻量、低级别的插件系统,用于在全局范围内改变Django的输入和输出。每个中间件组件都负责做一些特定的功能。
钩子:在某个位置预留了位置,没有挂钩子函数的话继续执行,如果写了钩子函数就执行完后继续执行。
应用:
如果想修改请求,例如被传送到view中的HttpRequest对象。 或者想修改view返回的HttpResponse对象,这些都可以通过中间件来实现。
可能还想在view执行之前做一些操作,这种情况就可以用 middleware来实现。
我们可能频繁在view使用
request.user
吧。 Django想在每个view执行之前把user设置request的属性,于是就用了一个中间件来实现这个目标。所以Django提供了可以修改request 对象的中间
件
AuthenticationMiddleware
。- 中间件可以用来干什么?
- 用户登录
日志记录
crsf:对所有的post请求做了一个验证
session
权限管理- 注意:
对于所有请求的批量做处理的时候用中间件
单独对某几个函数做处理的时候用装饰器Django默认的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',
]每一个中间件都有具体的功能
- 使用步骤
中间件使用步骤步骤: 1、、先建一个文件夹,里面写一个py文件 2、、然后开始写类 1.中间件就是一个类,类里面写几个方法 class M1(MiddlewareMixin): 必须继承 def process_request(self,request): request:请求里面的所有的东西 print("m1.request_request") 这个方法里面别轻易返回值,要是有返回值就不再继续执行后面的了,执行自己的process_response和上边的response 一般是无返回值的:继续执行后续的中间件和视图函数 def process_response(self,request,response): return response 2.在settings中的MIDDLEWARE加上路径 文件夹名称.py文件名称.类名 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)
以上方法的返回值可以是None或一个HttpResponse对象,
如果是None,则继续按照django定义的规则向后继续执行,
如果是HttpResponse对象,则直接将该对象返回给用户。
- 总结:
五个方法总结五个方法 - 参数,执行时间,执行顺序 - 1、process_request(self, request) - 执行时间:在视图函数执行之前 - 参数: - request:视图函数用到中用到的request - 执行顺序:按照注册顺序执行 - 返回值: - None:正常流程 - HttpResponse对象:当前中间件后面的中间件的process_request方法 process_Response方法和视图的Http_Response对象不执行,执行当前 中间件的process_Response方法以及之前的process_reques方法 - 2、process_response(self, request, response) - 执行时间:在视图函数执行之后 - 参数: - request:视图函数用到中用到的request - response:视图函数中返回的response对象,如果中间件返回response对象,就不走 视图函数了 - 执行顺序:按照注册顺序倒序执行 - 返回值: - 不能为None,否则会报错 - 必须是response对象 - 3、process_view(self, request, view_func, view_args, view_kwargs) - 执行时间:在视图函数之前,在process_reques方法之后,以及路由匹配之后 - 参数: - request:视图函数用到中用到的request - view_func:要执行的视图函数 - view_args:视图函数的位置参数 - view_kwargs:视图函数的关键字参数 - 返回值: - None:正常流程 - HttpResponse对象: - 执行属性:按照注册顺序执行 - 4、process_exception(self, request, exception) - 执行时间: - 触发条件:有异常才执行 - 在视图函数之后,在process_response之前 - 参数: - request:视图函数用到中用到的request - exception:错误信息对象 - 返回值:HttpResponse对象: - None:正常执行 - HttpResponse对象: - 注册顺序之前的所有中间件的process_exception方法不走了 - 执行所有中间件的的process_response - 执行顺序:按照注册顺序倒序执行 - 5、process_template_response(self, request, response) - 执行时间: - 触发条件:返回的response对象要有一个render方法 - 在视图函数之后,在process_response方法之前 - 参数“ - request:视图函数用到中用到的request - response:视图函数中返回的response对象 - 返回值: - 不能为None,否则会报错 - 必须是response对象 - 执行顺序:按照注册顺序倒序执行(不会截断,能够重写)- process_request(self,request) 1、中间件的process_request方法是在执行视图函数之前执行的。 2、当配置多个中间件时,会按照MIDDLEWARE中的注册顺序,也就是列表的索引值,从前到后依次执行的。 3、不同中间件之间传递的request都是同一个对象 - process_response(self, request, response) 1、process_response方法是在视图函数之后执行的,并且顺序是MD1比MD2先执行。(此时settings.py中 MD2比MD1先注册) 2、多个中间件中的process_response方法是按照MIDDLEWARE中的注册顺序倒序执行的,也就是说第一个中间件的process_request方法首先执行,而它的process_response方法最后执行,最后一个中间件的process_request方法最后一个执行,它的process_response方法是最先执行。 - process_view(self, request, view_func, view_args, view_kwargs) 1、Django会在调用视图函数之前调用process_view方法。 2、它应该返回None或一个HttpResponse对象。 如果返回None,Django将继续处理这个请求,执行任何其他中间件的process_view方法,然后在执行相应的视图。 如果它返回一个HttpResponse对象,Django不会调用适当的视图函数。 它将执行中间件的process_response方法并将应用到该HttpResponse并返回结果。 3、process_view方法是在process_request之后,视图函数之前执行的,执行顺序按照MIDDLEWARE中的注册顺序从前到后顺序执行的。 - process_exception(self, request, exception) 1、这个方法只有在视图函数中出现异常了才执行,它返回的值可以是一个None也可以是一个HttpResponse对象。如果是HttpResponse对象,Django将调用模板和中间件中的process_response方法,并返回给浏览器,否则将默认处理异常。如果返回一个None,则交给下一个中间件的process_exception方法来处理异常。它的执行顺序也是按照中间件注册顺序的倒序执行。 - process_template_response(self,request,response) 1、process_template_response是在视图函数执行完成后立即执行,但是它有一个前提条件,那就是视图函数返回的对象有一个render()方法(或者表明该对象是一个TemplateResponse对象或等价方法)。 2、视图函数执行完之后,立即执行了中间件的process_template_response方法,顺序是倒序,先执行MD1的,在执行MD2的,接着执行了视图函数返回的HttpResponse对象的render方法,返回了一个新的HttpResponse对象,接着执行中间件的process_response方法。
process_request,process_response
当用户发起请求的时候会依次经过所有的的中间件,这个时候的请求时process_request,最后到达views的函数中,views函数处理后,在依次穿过中间件,这个时候是process_response,最后返回给请求者。
我们也可以自己定义一个中间件,我们可以自己写一个类,但是必须继承MiddlewareMixin
需要导入
from django.utils.deprecation import MiddlewareMixin
in views:
def index(request):
print("view函数...")
return HttpResponse("OK")in Mymiddlewares.py:
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse
class Md1(MiddlewareMixin):
def process_request(self,request):
print("Md1请求")
def process_response(self,request,response):
print("Md1返回")
return response
class Md2(MiddlewareMixin):
def process_request(self,request):
print("Md2请求")
#return HttpResponse("Md2中断")
def process_response(self,request,response):
print("Md2返回")
return response结果:
Md1请求
Md2请求
view函数...
Md2返回
Md1返回注意:如果当请求到达请求2的时候直接不符合条件返回,即return HttpResponse("Md2中断"),程序将把请求直接发给中间件2返回,然后依次返回到请求者,结果如下:
返回Md2中断的页面,后台打印如下:
Md1请求
Md2请求
Md2返回
Md1返回流程图如下:
process_view
process_view(self, request, callback, callback_args, callback_kwargs)
Mymiddlewares.py修改如下
from django.utils.deprecation import MiddlewareMixin
from django.shortcuts import HttpResponse
class Md1(MiddlewareMixin):
def process_request(self,request):
print("Md1请求")
#return HttpResponse("Md1中断")
def process_response(self,request,response):
print("Md1返回")
return response
def process_view(self, request, callback, callback_args, callback_kwargs):
print("Md1view")
class Md2(MiddlewareMixin):
def process_request(self,request):
print("Md2请求")
return HttpResponse("Md2中断")
def process_response(self,request,response):
print("Md2返回")
return response
def process_view(self, request, callback, callback_args, callback_kwargs):
print("Md2view")结果如下:
Md1请求
Md2请求
Md1view
Md2view
view函数...
Md2返回
Md1返回下图进行分析上面的过程:
当最后一个中间的process_request到达路由关系映射之后,返回到中间件1的process_view,然后
依次往下,到达views函数,最后通过process_response依次返回到达用户。
process_view可以用来调用视图函数:
class Md1(MiddlewareMixin):
def process_request(self,request):
print("Md1请求")
#return HttpResponse("Md1中断")
def process_response(self,request,response):
print("Md1返回")
return response
def process_view(self, request, callback, callback_args, callback_kwargs):
# return HttpResponse("hello")
response=callback(request,*callback_args,**callback_kwargs)
return response结果如下:
Md1请求
Md2请求
view函数...
Md2返回
Md1返回注意:process_view如果有返回值,会越过其他的process_view以及视图函数,但是所有的
process_response都还会执行。
process_exception
process_exception(self, request, exception)
示例修改如下:
class Md1(MiddlewareMixin):
def process_request(self,request):
print("Md1请求")
#return HttpResponse("Md1中断")
def process_response(self,request,response):
print("Md1返回")
return response
def process_view(self, request, callback, callback_args, callback_kwargs):
# return HttpResponse("hello")
# response=callback(request,*callback_args,**callback_kwargs)
# return response
print("md1 process_view...")
def process_exception(self):
print("md1 process_exception...")
class Md2(MiddlewareMixin):
def process_request(self,request):
print("Md2请求")
# return HttpResponse("Md2中断")
def process_response(self,request,response):
print("Md2返回")
return response
def process_view(self, request, callback, callback_args, callback_kwargs):
print("md2 process_view...")
def process_exception(self):
print("md1 process_exception...")结果如下:
Md1请求
Md2请求
md1 process_view...
md2 process_view...
view函数...
Md2返回
Md1返回流程图如下:
当views出现错误时:
将md2的process_exception修改如下:
def process_exception(self,request,exception):
print("md2 process_exception...")
return HttpResponse("error")结果如下:
Md1请求
Md2请求
md1 process_view...
md2 process_view...
view函数...
md2 process_exception...
Md2返回
Md1返回process_template_response(用的比较少)
process_template_response(self, request, response)
它的参数,一个HttpRequest对象,response是TemplateResponse对象(由视图函数或者中间件产生)。
process_template_response是在视图函数执行完成后立即执行,但是它有一个前提条件,那就是视图函数返回的对象有一个render()方法(或者表明该对象是一个TemplateResponse对象或等价方法)。
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 responseviews.py中:
def index(request): print("app01 中的 index视图") def render(): print("in index/render") return HttpResponse("O98K") rep = HttpResponse("OK") rep.render = render return rep访问index视图,终端输出的结果:
MD2里面的 process_request MD1里面的 process_request -------------------------------------------------------------------------------- MD2 中的process_view <function index at 0x000001C111B97488> index -------------------------------------------------------------------------------- MD1 中的process_view <function index at 0x000001C111B97488> index app01 中的 index视图 MD1 中的process_template_response MD2 中的process_template_response in index/render MD1里面的 process_response MD2里面的 process_response从结果看出:
视图函数执行完之后,立即执行了中间件的process_template_response方法,顺序是倒序,先执行MD1的,在执行MD2的,接着执行了视图函数返回的HttpResponse对象的render方法,返回了一个新的HttpResponse对象,接着执行中间件的process_response方法。