自定义 django 中间件
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',
]
1、django.middleware.security.SecurityMiddleware:
这个中间件负责提供一些与安全相关的功能,例如设置HTTP头部中的安全策略、强制使用HTTPS等。
2、django.contrib.sessions.middleware.SessionMiddleware:
这个中间件处理会话数据。它为每个请求提供了一个会话对象,可以用于在请求之间存储和检索数据。
3、django.middleware.common.CommonMiddleware:
这个中间件提供了一些常见的Web开发功能,如URL重写、缓存控制等。
4、django.middleware.csrf.CsrfViewMiddleware:
这个中间件用于处理跨站请求伪造(CSRF)保护。它在提交表单数据时验证CSRF令牌,以防止恶意站点利用用户的身份执行恶意操作。
5、django.contrib.auth.middleware.AuthenticationMiddleware:
这个中间件处理用户身份验证。它在请求过程中检查用户是否已通过身份验证,并将用户对象添加到请求的上下文中。
6、django.contrib.messages.middleware.MessageMiddleware:
这个中间件处理闪存消息。闪存消息是一种在请求之间传递的临时消息,通常用于显示一次性的成功消息、错误消息或其他通知。
7、django.middleware.clickjacking.XFrameOptionsMiddleware:
这个中间件提供了点击劫持(clickjacking)保护。它通过设置X-Frame-Options响应头来防止将网站嵌入到其他网页的iframe中,从而防止点击劫持攻击。
自定义中间件
这是一个中间件的生效阶段图:
其实,不难看出,对于中间件,基本上就那几个阶段,不同的阶段,对应不同的方法。
process_request(self, request):
process_view()
它只在 Django 执行url前被调用。
应用:我们可以定义合适的限流或权限啥的
它只能返回 None 或 HttpResponse 对象。如果它返回 None,Django 将继续处理这个请求,如果返回 HttpResponse 对象,那就是说,被拦截了,直接走 HttpResponse 给前端返回相应了就。
process_view(self, request, view_func, view_func_args, view_func_kwargs):
process_view()
只在 Django 调用视图前被调用
应用:一样,可以在这里做鉴权啥都
它只能返回 None 或 HttpResponse 对象。如果它返回 None,Django 将继续处理这个请求,执行任何其他的 process_view()
,然后执行相应的视图(request里的url指向的视图)。如果返回 HttpResponse 对象,就是说,直接就不再执行视图函数的逻辑了,直接等于被拦截了,然后就返回了。
process_exception(self, request, exception):
在视图执行期间,出现异常而被抛出时,就会执行该方法。
它只能返回 None 或 HttpResponse 对象。当视图引发异常时,Django 会调用 process_exception()
。process_exception()
应该返回 None 或 HttpResponse 对象。如果它返回一个 HttpResponse 对象,模板响应和响应中间件将被应用且会将结果响应返回浏览器。否则,就会开始默认异常处理。
process_response(self, request, response):
它只能返回 None 或 HttpResponse 对象。所有的响应返回给浏览器之前被调用,返回HttpResponse,一定会走这个逻辑,即使view里面代码错了,先走错的process_exception()
,再走这个。
应用:用于规范响应输出格式啥的
process_template_response(self, request, response):
它只能返回 None 或 TemplateResponse对象,request 是一个 HttpRequest 对象。response 是 TemplateResponse 对象(或者等效对象),它通过 Django 视图或中间件返回
process_template_response() 在视图被完全执行后调用,且视图返回的是 render() 方法,是一个 TemplateResponse 或等效对象 就会执行到该方法。(因此该方法并不常用)
=========================================
自定义的中间件,有2中模式,一种是需要继承 MiddlewareMixin 类的模式,一种是不需要继承 MiddlewareMixin 的模式。
看第一种,不继承 MiddlewareMixin 类:
class SimpleMiddleware:def __init__(self, get_response):self.get_response = get_response# One-time configuration and initialization.def __call__(self, request):# 在请求之前执行的代码逻辑,在这里实现response = self.get_response(request)# 在请求之后执行的代码逻辑,在这实现 return responsdef process_view(request, view_func, view_args, view_kwargs)return None or HttpResponse(xx)def process_exception(self, request, exception):return None or HttpResponse(xx)def process_template_response(self, request, response)return
这里面:
__init__
方法在服务器启动时被调用,用于中间件的初始化。__call__
方法在每次请求时被调用,可以在此处添加自定义逻辑
第二种,继承 MiddlewareMixin 类:
from django.http import HttpResponse
from django.utils.deprecation import MiddlewareMixinclass SimpleMiddleware(MiddlewareMixin):def process_request(self, request):# 执行路由之前被调用,返回None就是通过,返回HttpResponse 就是拦截成功print("收到请求,但还没执行 url 路由")return Nonedef process_view(self, request, view_func, view_func_args, view_func_kwargs):# 调用视图函数之前被调用,返回None就是通过,返回HttpResponse 就是拦截成功print("以运行了url指向, 但还没开始执行视图")return Nonedef process_exception(self, request, exception):# 视图里面出错了,就会自动到这个里面执行,返回HttpResponse# 抓异常,发日志/邮件print("视图执行出错了")return Nonedef process_response(self, request, response):# 所有的响应返回给浏览器之前被调用,返回HttpResponse# 一定会走这个逻辑,即使view里面代码错了,先走错的,再走这个print("视图执行出错了")return None# def process_template_response(self, request, response):# # 很少用# # 只有我们的视图里面返回了render渲染的,才会走这个# print("视图返回了render函数")# return None
然后,自定义的中间件就完成了。
接下来只需将其注册到setting里就行:
MIDDLEWARE = [# ...'myapp.middleware.SimpleMiddleware',# ...
]
这里需要注意,中间件的注册表里,是有序的,所以注意自定义中间件放的位置。