Django中的中间件详解

最新推荐文章于 2022-11-14 11:44:40 发布

stu_xujin

最新推荐文章于 2022-11-14 11:44:40 发布

阅读量666

点赞数

分类专栏： django

本文链接：https://blog.csdn.net/xujin0/article/details/84799436

版权

django 专栏收录该内容

45 篇文章 12 订阅

订阅专栏

什么是中间件

中间件是在request和response处理过程中的一个插件。比如在request到达视图函数之前，我们可以使用中间件来做一些相关的事情，比如可以判断当前这个用户有没有登录，如果登录了，就绑定一个user对象到request上。也可以在response到达浏览器之前，做一些相关的处理，比如想要统一在response上设置一些cookie信息等。

创建一个自定义的中间件

中间件所处的位置没有规定。只要是放到项目当中即可。一般分为两种情况，如果中间件是属于某个app的，那么可以在这个app下面创建一个python文件用来存放这个中间件，也可以专门创建一个Python包，用来存放本项目的所有中间件。创建中间件也有两种方式，一种是使用函数，一种是使用类，

在app下面新建一个middlewares.py的文件，然后里面写我们的中间件

1. 使用函数的中间件

一个函数的中间件大体结构时这样的

def front_user_middleware(get_response):
    # 执行一些初始代码
    print('front_user_middleware这个中间件初始化的代码...')
    def middleware(request):
        print('request到达views之前执行的代码...')
        # 在下面的代码执行之前的代码，是request到view之前的代码
        response = get_response(request)
        # 上面代码执行之后的代码，使response到达浏览器之前的代码
        print('response到达浏览器之前执行的代码...')
        return response

    return middleware

然后我们可以在里面添加一些我们想要执行的代码。
定义好了中间件之后，我们需要去settings.py中添加我们的中间件。

在settings.py中找到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',

    # 自定义的中间件
    'front.middlewares.front_user_middleware',
]

然后我们运行项目，查看控制台，就能看到效果了。然后继续访问网址。就能在控制台查看到打印的信息了。

接下来我们使用中间件来完成一个需求，在用户登录了之后，我们在session中设置一个user_id，值万恶哦当前登录的用户的id。然后我们在中间件中将登录的用户的信息绑定在request对象上，这样我们在每一个视图中都能够轻松的获取到当前登录的用户的所有信息了。

修改上面中间件的代码为：

# User为我自己定义的模型，需要改成自己的模型
from .models import User

def front_user_middleware(get_response):
    # 执行一些初始代码
    print('front_user_middleware这个中间件初始化的代码...')
    def middleware(request):
        print('request到达views之前执行的代码...')
        # 首先从session中获取当前登录用户的id，所以我们在用户登录成功的时候需要设置session中的user_id的值。
        user_id = request.session.get('user_id')
        # 如果有user_id,即用户登录了
        if user_id:
            try:
                user = User.objects.get(pk=user_id)
                # 绑定当前登录的用户到request中去
                request.front_user = user
            except:
                # 避免发生异常时front_user对象没有绑定成功，从而在视图中发生报错
                request.front_user = None
        else:
        	# 避免以后用户没有登录的情况下报错
            request.front_user = None
        # 在下面的代码执行之前的代码，是request到view之前的代码
        response = get_response(request)
        # 上面代码执行之后的代码，使response到达浏览器之前的代码
        print('response到达浏览器之前执行的代码...')
        return response

    return middleware

然后我们就可以在视图中直接使用我们绑定的front_user这个对象了，示例代码：

def index(request):
    print('view中的代码')
    if request.front_user:
        print(request.front_user.username)
    return HttpResponse('index')

然后将中间件添加到settings中。这样，我们就成功的实现上面的需求了。

至于完整的项目代码，我并没有写出来，我相信看到这里的读者都会按照自己的个性来自己进行个性化的使用。

2. 使用类的中间件

类的中间件大体结构为:

class FrontUserMiddleware(object):
    def __init__(self,get_response):
        # 执行一些初始代码
        print('front_user_middleware这个中间件初始化的代码...')
        self.get_response = get_response
        
    def __call__(self,request):
        print('request到达views之前执行的代码...')

        # 在下面的代码执行之前的代码，是request到view之前的代码
        response = self.get_response(request)
        # 上面代码执行之后的代码，使response到达浏览器之前的代码
        print('response到达浏览器之前执行的代码...')
        
        return response

然后我们使用类的中间件来实现我们上面的需求

class FrontUserMiddleware(object):
    def __init__(self,get_response):
        # 执行一些初始代码
        print('front_user_middleware这个中间件初始化的代码...')
        # 使用self.get_response将get_response保存下来，因为在下面将会使用到get_response
        self.get_response = get_response

    def __call__(self,request):
        print('request到达views之前执行的代码...')
        user_id = request.session.get('user_id')
        if user_id:
            try:
                user = User.objects.get(pk=user_id)
                # 绑定当前登录的用户到request中去
                request.front_user = user
            except:
                # 避免发生异常时front_user对象没有绑定成功，从而在视图中发生报错
                request.front_user = None
        else:
            # 避免以后用户没有登录的情况下报错
            request.front_user = None
        # 在下面的代码执行之前的代码，是request到view之前的代码
        response = self.get_response(request)
        # 上面代码执行之后的代码，使response到达浏览器之前的代码
        print('response到达浏览器之前执行的代码...')

        return response

这样我们就使用了

3. 即将被遗弃的一个中间件的定义方法。

因为这中方法将要被遗弃了，所以我们不介意大家使用这种方法来定义中间件，但是我们可以了解一下这种方法的原理，因为有一些Django中内置的中间件就是使用的这种方式定义的，这样我们查看Django的源码时才能理解这种定义方式。

这种方式需要继承一个类MiddlewareMixin，示例代码如下：

from django.utils.deprecation import MiddlewareMixin

class FrontUserMiddlewareMixin(MiddlewareMixin):
    def __init__(self,get_response):
        # 执行一些初始代码
        print('front_user_middleware这个中间件初始化的代码...')
        super(FrontUserMiddlewareMixin,self).__init__(get_response)

    # 这个方法时request到达view之前调用的
    def process_request(self,request):
        print('request到达views之前执行的代码...')
        user_id = request.session.get('user_id')
        if user_id:
            try:
                user = User.objects.get(pk=user_id)
                # 绑定当前登录的用户到request中去
                request.front_user = user
            except:
                # 避免发生异常时front_user对象没有绑定成功，从而在视图中发生报错
                request.front_user = None
        else:
            # 避免以后用户没有登录的情况下报错
            request.front_user = None
	
	# 这个方法时response到达浏览器之前使用的
    def process_response(self,request,response):
        print('response到达浏览器之前执行的代码...')
        return response

然后将这个中间件添加到settings中，就能够在我们的项目中生效了，但是，这种方法是即将被遗弃了的写法，所以不推介大家使用。使用最上面的两种方法就行了。

内置的中间件

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。

内置中间件放置的顺序：

中间件在settings中放置的位置是有顺序的，因为有些中间件是需要依赖于其他的一些中间件。

SecurityMiddleware：应该放到最前面。因为这个中间件并不需要依赖任何其他的中间件。如果你的网站同时支持http协议和https协议，并且你想让用户在使用http协议的时候重定向到https协议，那么就没有必要让他执行下面一大串中间件再重定向，这样效率更高。
UpdateCacheMiddleware：应该在SessionMiddleware, GZipMiddleware, LocaleMiddleware之前。
GZipMiddleware。
ConditionalGetMiddleware。
SessionMiddleware。
LocaleMiddleware。
CommonMiddleware。
CsrfViewMiddleware。
AuthenticationMiddleware。
MessageMiddleware。
FetchFromCacheMiddleware。
FlatpageFallbackMiddleware。
RedirectFallbackMiddleware。

以上就是使用中间件在settings中存放的顺序，如果我按照这种顺序来存放，那么可能会出现某些中间件使用不了的情况。

想深入学习django的可以看一下这个视频：超详细讲解Django打造大型企业官网

stu_xujin

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
Django中的中间件详解

什么是中间件中间件是在request和response处理过程中的一个插件。比如在request到达视图函数之前，我们可以使用中间件来做一些相关的事情，比如可以判断当前这个用户有没有登录，如果登录了，就绑定一个user对象到request上。也可以在response到达浏览器之前，做一些相关的处理，比如想要统一在response上设置一些cookie信息等。创建一个自定义的中间件中间件所处的...
复制链接

扫一扫