Django 之上下文处理器和中间件
一、上下文处理器
上下文处理器是可以返回一些数据,在全局模板中都可以使用。比如登录后的用户信息,在很多页面中都需要使用,那么我们可以放在上下文处理器中,就没有必要在每个视图函数中都返回这个对象。
在settings.TEMPLATES.OPTIONS.context_processors
中,有许多内置的上下文处理器。这些上下文处理器的作用如下:
django.template.context_processors.debug
:增加一个debug
和sql_queries
变量。在模板中可以通过他来查看到一些数据库查询。django.template.context_processors.request
:增加一个request
变量。这个request
变量也就是在视图函数的第一个参数。django.contrib.auth.context_processors.auth
:Django
有内置的用户系统,这个上下文处理器会增加一个user
对象。django.contrib.messages.context_processors.messages
:增加一个messages
变量。django.template.context_processors.media
:在模板中可以读取MEDIA_URL
。比如想要在模板中使用上传的文件,那么这时候就需要使用settings.py
中设置的MEDIA_URL
来拼接url
。示例代码如下:<img src="" />
django.template.context_processors.static
:在模板中可以使用STATIC_URL
。django.template.context_processors.csrf
:在模板中可以使用csrf_token
变量来生成一个csrf token
。
自定义上下文处理器:
有时候我们想要返回自己的数据。那么这时候我们可以自定义上下文处理器。自定义上下文处理器的步骤如下:
- 你可以根据这个上下文处理器是属于哪个
app
,然后在这个app
中创建一个文件专门用来存储上下文处理器。比如context_processors.py
。或者是你也可以专门创建一个Python包
,用来存储所有的上下文处理器。 - 在你定义的上下文处理器文件中,定义一个函数,这个函数只有一个
request
参数。这个函数中处理完自己的逻辑后,把需要返回给模板的数据,通过字典的形式返回。如果不需要返回任何数据,那么也必须返回一个空的字典。示例代码如下:def frontuser(request): userid = request.session.get("userid") userModel = models.FrontendUser.objects.filter(pk=userid).first() if userModel: return {'frontuser':userModel} else: return {}
二、中间件
中间件是在request
和response
处理过程中的一个插件。比如在request
到达视图函数之前,我们可以使用中间件来做一些相关的事情,比如可以判断当前这个用户有没有登录,如果登录了,就绑定一个user
对象到request
上。也可以在response
到达浏览器之前,做一些相关的处理,比如想要统一在response
上设置一些cookie
信息等。
自定义中间件:
中间件所处的位置没有规定。只要是放到项目当中即可。一般分为两种情况,如果中间件是属于某个app
的,那么可以在这个app
下面创建一个python
文件用来存放这个中间件,也可以专门创建一个Python
包,用来存放本项目的所有中间件。创建中间件有两种方式,一种是使用函数,一种是使用类,接下来对这两种方式做个介绍:
使用函数的中间件:
def simple_middleware(get_response):
# 这个中间件初始化的代码
def middleware(request):
# request到达view的执行代码
response = get_response(request)
# response到达浏览器的执行代码
return response
return middleware
使用类的中间件:
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
在写完中间件后,还需要在settings.MIDDLEWARES
中配置写好的中间件才可以使用。比如我们写了一个在request
到达视图函数之前,判断这个用户是否登录,如果已经登录就绑定一个user
对象到request
上的中间件,这个中间件放在当前项目的middlewares.users
下:
def user_middleware(get_response):
# 这个中间件初始化的代码
def middleware(request):
# request到达view的执行代码
userid = request.session.get("userid")
userModel = FrontUser.objects.filter(pk=userid).first()
if userModel:
setattr(request,'frontuser',userModel)
response = get_response(request)
# response到达浏览器的执行代码
return response
return middleware
那么就可以在settings.MIDDLEWARES
下做以下配置:
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',
'middlewares.users.user_middleware'
]
中间件的执行是有顺序的,他会根据在MIDDLEWARE
中存放的顺序来执行。因此如果有些中间件是需要基于其他中间件的,那么就需要放在其他中间件的后面来执行。
Django内置的中间件:
django.middleware.common.CommonMiddleware
:通用中间件。他的作用如下:- 限制
settings.DISALLOWED_USER_AGENTS
中指定的请求头来访问本网站。DISALLOWED_USER_AGENT
是一个正则表达式的列表。示例代码如下:import re DISALLOWED_USER_AGENTS = [ re.compile(r'^\s$|^$'), re.compile(r'.*PhantomJS.*') ]
- 如果开发者在定义
url
的时候,最后有一个斜杠。但是用户在访问url
的时候没有提交这个斜杠,那么CommonMiddleware
会自动的重定向到加了斜杠的url
上去。
- 限制
django.middleware.gzip.GZipMiddleware
:将响应数据进行压缩。如果内容长度少于200个长度,那么就不会压缩。django.contrib.messages.middleware.MessageMiddleware
:消息处理相关的中间件。django.middleware.security.SecurityMiddleware
:做了一些安全处理的中间件。比如设置XSS
防御的请求头,比如做了http
协议转https
协议的工作等。django.contrib.sessions.middleware.SessionMiddleware
:session
中间件。会给request
添加一个处理好的session
对象。django.contrib.auth.middleware.AuthenticationMiddleware
:会给request
添加一个user
对象的中间件。django.middleware.csrf.CsrfViewMiddleware
:CSRF
保护的中间件。django.middleware.clickjacking.XFrameOptionsMiddleware
:做了clickjacking
攻击的保护。clickjacking
保护是攻击者在自己的病毒网站上,写一个诱惑用户点击的按钮,然后使用iframe
的方式将受攻击的网站(比如银行网站)加载到自己的网站上去,并将其设置为透明的,用户就看不到,然后再把受攻击的网站(比如银行网站)的转账按钮定位到病毒网站的按钮上,这样用户在点击病毒网站上按钮的时候,实际上点击的是受攻击的网站(比如银行网站)上的按钮,从而实现了在不知不觉中给攻击者转账的功能。- 缓存中间件:用来缓存一些页面的。
django.middleware.cache.UpdateCacheMiddleware
。django.middleware.cache.FetchFromCacheMiddleware
。
内置中间件放置的顺序:
SecurityMiddleware
:应该放到最前面。因为这个中间件并不需要依赖任何其他的中间件。如果你的网站同时支持http
协议和https
协议,并且你想让用户在使用http
协议的时候重定向到https
协议,那么就没有必要让他执行下面一大串中间件再重定向,这样效率更高。UpdateCacheMiddleware
:应该在SessionMiddleware, GZipMiddleware, LocaleMiddleware
之前。GZipMiddleware
。ConditionalGetMiddleware
。SessionMiddleware
。LocaleMiddleware
。CommonMiddleware
。CsrfViewMiddleware
。AuthenticationMiddleware
。MessageMiddleware
。FetchFromCacheMiddleware
。FlatpageFallbackMiddleware
。RedirectFallbackMiddleware
。