Djiango 中间件
一、中间件
中间件是在request
和response
处理过程中的一个插件。比如在request
到达视图函数之前,我们可以使用中间件来做一些相关的事情,比如可以判断当前这个用户有没有登录,如果登录了,就绑定一个user
对象到request
上。也可以在response
到达浏览器之前,做一些相关的处理,比如想要统一在response
上设置一些cookie
信息等。
二、自定义中间件:
中间件所处的位置没有规定。只要是放到项目当中即可。一般分为两种情况,如果中间件是属于某个app
的,那么可以在这个app
下面创建一个python
文件用来存放这个中间件,也可以专门创建一个Python
包,用来存放本项目的所有中间件。创建中间件有两种方式,一种是使用函数,一种是使用类,接下来对这两种方式做个介绍:
1、使用函数的中间件:
def simple_middleware(get_response): # 这个中间件初始化的代码 def middleware(request): # request到达view的执行代码 response = get_response(request) # response到达浏览器的执行代码 return response return middleware # 在settings的中间件配置中需要加入app.存放中间件的文件.simple_middleware
示例:
from .models import User def front_user_middleware(get_response): # 执行一些初始化的代码 print('front_user_middleware中间件初始化的代码...') def middleware(request): print('request到达view之前执行的代码...') user_id = request.session.get('user_id') if user_id: try: user = User.objects.get(pk=user_id) request.front_user = user except: request.front_user = None else: request.front_user = None # 在这个代码执行之前的代码,是request到view之前的代码 response = get_response(request) print('response到达浏览器之前执行的代码...') # response对象到达浏览器之前执行的代码 return response return middleware
2、使用类的中间件:
class SimpleMiddleware(object): def __init__(self, get_response): self.get_response = get_response # 这个中间件初始化的代码 def __call__(self, request): # request到达view之前执行的代码 response = self.get_response(request) # response到达用户浏览器之前执行的代码 return response
示例:
class FrontUserMiddleware(object): def __init__(self,get_response): # 执行一些初始化的代码 print('front_user_middleware中间件初始化的代码...') self.get_response = get_response def __call__(self, request): print('request到达view之前执行的代码...') user_id = request.session.get('user_id') if user_id: try: user = User.objects.get(pk=user_id) request.front_user = user except: request.front_user = None else: request.front_user = None # 在这个代码执行之前的代码,是request到view之前的代码 response = self.get_response(request) print('response到达浏览器之前执行的代码...') # response对象到达浏览器之前执行的代码 return response
3、继承MiddlewareMixin覆盖process_request和process_response的方法:
# 可以对请求、响应...等功能完成过滤 # 自定义中间件 # 1. 在某一应用下(eg:app),建立某一py文件(eg: mymiddleware.py) # 2. 在文件中自定义类,继承django.utils.deprecation下的MiddlewareMixin类 # 3. 实现要过滤的方法,完成具体的过滤条件 from django.utils.deprecation import MiddlewareMixin class MyMiddleware1(MiddlewareMixin): def process_request(self, request): ''' 请求处理 :param request:请求对象 :return: 一般没有返回值,但可以返回HttpResponse对象 ''' def process_view(self, request, callback, callback_args, callback_kwargs): ''' 视图函数预处理 :param request: 请求对象 :param callback: 路由返回的视图函数地址 :param callback_args: 视图函数的位置参数(元组) :param callback_kwargs: 视图函数的关键字参数(字典) :return: 一般没有返回值,但可以返回HttpResponse对象 ''' def process_exception(self, request, exception): ''' 视图函数异常处理 :param request: 请求对象 :param exception: 视图函数的异常对象 :return: 一般没有返回值,但可以返回HttpResponse对象 ''' def process_template_response(self, request, response): ''' 视图函数返回值为拥有render方法的对象,该方法会执行 :param request: 请求对象 :param response: 响应对象 :return: 一定要返回response ''' return response def process_response(self, request, response): ''' 响应处理 :param request: 请求对象 :param response: 响应对象 :return: 一定要返回response ''' return response class MyMiddleware2(MiddlewareMixin): def process_request(self, request): pass
三、Django内置的中间件:
1、django.middleware.common.CommonMiddleware
:通用中间件。他的作用如下:
a、限制settings.DISALLOWED_USER_AGENTS
中指定的请求头来访问本网站。DISALLOWED_USER_AGENT
是一个正则表达式的列表。示例代码如下:
import re DISALLOWED_USER_AGENTS = [ re.compile(r'^\s$|^$'), re.compile(r'.*PhantomJS.*') ]
b、如果开发者在定义url
的时候,最后有一个斜杠。但是用户在访问url
的时候没有提交这个斜杠,那么CommonMiddleware
会自动的重定向到加了斜杠的url
上去。
2、django.middleware.gzip.GZipMiddleware
:将响应数据进行压缩。如果内容长度少于200个长度,那么就不会压缩。
3、django.contrib.messages.middleware.MessageMiddleware
:消息处理相关的中间件。
4、django.middleware.security.SecurityMiddleware
:做了一些安全处理的中间件。比如设置XSS
防御的请求头,比如做了http
协议转https
协议的工作等。
5、django.contrib.sessions.middleware.SessionMiddleware
:session
中间件。会给request
添加一个处理好的session
对象。
6、django.contrib.auth.middleware.AuthenticationMiddleware
:会给request
添加一个user
对象的中间件。
7、django.middleware.csrf.CsrfViewMiddleware
:CSRF
保护的中间件。
8、django.middleware.clickjacking.XFrameOptionsMiddleware
:做了clickjacking
攻击的保护。clickjacking
保护是攻击者在自己的病毒网站上,写一个诱惑用户点击的按钮,然后使用iframe
的方式将受攻击的网站(比如银行网站)加载到自己的网站上去,并将其设置为透明的,用户就看不到,然后再把受攻击的网站(比如银行网站)的转账按钮定位到病毒网站的按钮上,这样用户在点击病毒网站上按钮的时候,实际上点击的是受攻击的网站(比如银行网站)上的按钮,从而实现了在不知不觉中给攻击者转账的功能。
9、缓存中间件:用来缓存一些页面的。
a、django.middleware.cache.UpdateCacheMiddleware
。
b、django.middleware.cache.FetchFromCacheMiddleware
。
四、内置中间件的放置顺序:
1、SecurityMiddleware
:应该放到最前面。因为这个中间件并不需要依赖任何其他的中间件。如果你的网站同时支持http
协议和https
协议,并且你想让用户在使用http
协议的时候重定向到https
协议,那么就没有必要让他执行下面一大串中间件再重定向,这样效率更高。
2、UpdateCacheMiddleware
:应该在SessionMiddleware, GZipMiddleware, LocaleMiddleware
之前。
3、GZipMiddleware
。
4、ConditionalGetMiddleware
。
5、SessionMiddleware
。
6、LocaleMiddleware
。
7、CommonMiddleware
。
8、CsrfViewMiddleware
。
9、AuthenticationMiddleware
。
10、MessageMiddleware
。
11、FetchFromCacheMiddleware
。
12、FlatpageFallbackMiddleware
。
13、RedirectFallbackMiddleware
。