前言
在Django中,中间件是一个非常重要的东西,你的任何Django项目都会用到中间件,在没接触到它之前,你可能对此一无所知,但请看一下如下的代码,是不是感觉很熟悉:
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',
]
没错,这是setting.py文件的一部分代码,它声明的正是该项目用到的中间件,以上的这些都是Django默认就会启动的一些中间件。Django官方定义:中间件是一个轻量级的、低级别的“插件系统”,它通过介入Django的请求与响应流程中,进而可以在全局范围内改变Django的输入与输出。每个中间件都具有某种特定的功能,比如AuthenticationMiddleware
,它通过会话将用户与用户请求关联起来,比如CsrfViewMiddleware
,它为CSRF攻击提供了防范措施。
自定义中间件
一、用函数的方式编写中间件需要你定义一个可以接受get_response
参数的中间件工厂函数,该函数返回一个中间件,中间件和视图函数很像,它们接受request参数并返回response响应。
如下:
def simple_middleware(get_response):
# 这里的代码只会在Django初始化的时候执行一次
def middle(request):
#这里的代码将在调用视图函数之前被执行,且对于每次request请求都会执行
response = get_response(request)
#这里的代码将在处理完视图函数之后被调用,且对于每个request/response都会执行
return response
return middle
看一个例子:
在随便一个app中新建一个middleware.py文件,在其中定义如下中间件:
def mymiddleware(get_response):
print('init ...')
def middle(request):
print('before view function')
response = get_response(request)
print('after view function')
return response
return middle
在视图函数中新建一个测试用的视图函数:
from django.http import HttpResponse
def testmiddleware(request):
print('view function')
return HttpResponse("OK")
之后编写相应的urlconf,然后将该中间件注册:
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',
'user.middleware.mymiddleware', #自定义的中间件
]
运行,得到如下输出:
init ...
before view function
view function
after view function
另外还有一点就是:中间件在执行视图函数之前,是按照MIDDLEWARE中注册的中间件顺序从上往下
依次执行的,而在视图函数被执行了之后,是按照MIDDLEWARE中注册的顺序从下往上
逆着执行的。这个可以编写测试用例验证,因为很显然就不再占用篇幅。但需要提醒一下,有的中间件可能存在着依赖关系,因此并不是说注册顺序可以任意更改。
【注意】这个get_response参数的值可能有两个方向,一种情况下,它的值是下一个中间件,另一种情况下(当中间件为最后一个时),它的值为一个包装器方法,该方法通过使用view middleware
来调用视图,这个过程中还可能会用到template-response
和exception
中间件。
二、也可以用编写类的方式自定义中间件,如下:
class mymiddleware:
def __init__(self, get_response):
self.get_response = get_response
def __call__(self, request):
#...
response = self.get_response(request)
#...
return response
__init__(get_response)
中间件工厂函数必须接受一个get_response作为参数,你还可以通过__init__为中间件初始化一些中间状态,但请注意:
- Django只会使用get_response参数来初始化中间件,因此你不能在__init__()中定义其它的参数。
- __ init__ ()方法不同于__call__()方法,对于每次请求都会去执行,它只会在Web服务器初始化的时候执行一次。
MiddlewareNotUsed
有时,在Web服务启动时确定是否应该使用有的中间件是很有用的。在这些情况下,您的中间件的__init__()方法可以抛出 MiddlewareNotUsed
,之后Django将从中间件进程中删除该中间件,并将调试消息记录下来(DEBUG=True)。
多个中间件下的执行流程
图片借用于这篇博客:https://blog.csdn.net/lh_hebine/article/details/99655388
向类中添加更多方法
在用类编写中间件时,还可以添加如下几种方法:
process_view(request, view_func, view_args, view_kwargs)
request是一个HttpRequest对象,view_func是一个将会被调用的Python函数,view_args是向视图传递的参数列表,view_kwargs是向视图传递的参数字典。
该方法将在执行视图函数之前被调用,它将返回None或者HttpResponse,如果返回的是None,则继续执行下一个process_view(),如果返回的是HttpResponse,则不再执行后续操作,直接将该HttpResponse返回。
process_exception(request, exception)
request是一个HttpRequest对象,exception是由视图函数引起的异常对象。
当视图函数引发异常时,process_exception()将会被调用,它返回None或者HttpResponse,如果返回的是HttpResponse,Django将配合模板响应和响应中间件将该response返回到浏览器上,如果返回的是None,则默认的异常处理将会被执行。
注意,由于中间件在响应阶段是逆序执行,这也包括precess_exception()。
process_template_response(request, response)
request是一个HttpRequest对象,response是由视图函数返回的或者是中间件返回的TemplateResponse对象。
该方法将在视图函数执行完毕之后立即被调用。
异常处理
Django会自动将视图或中间件引发的异常转换为具有错误状态代码的适当HTTP响应。确切异常被转换为4xx状态代码,而未知异常被转换为500状态代码。
这种转换将在当前中间件结束之后,下一个中间件执行之前的间隔里发生,这样做的好处就是保证中间件接受的始终是reponse响应,而不需要在中间件中再通过try/except来判断。
使用MiddlewareMixin
Django提供了django.utils.deprecation.MiddlewareMixin类用于创建同时兼容中间件与旧的中间件类的一种中间件。
Mixin提供了一个__init__()方法,该方法接受一个可选的get_response参数,并把它存储在self.get_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)
具体的使用和执行流程可以参阅下面的博客,写的已经非常详细:
Django 中间件使用