第23天,Django之中间件

目录

一、中间件简介
    Django官方文档描述
二、激活中间件
三、中间件包含的钩子方法和应用的顺序
    1. 钩子方法的调用
        1.1 process_request
        1.2 process_view
        1.3 process_template_response
        1.4 process_response
        1.5 process_exception
四、编写自己的中间件
    1. 正常流程
    2. process_request返回HttpResponse
    3. 加入process_view()方法
        3.1 将上述中间件代码中M3.process_request()返回一个HttpResponse(其余代码不变):
        3.2 M2.process_view()返回HttpResponse,M3.process_request()返回None,其余代码不变:
    4. 加入process_exception()方法
        4.1 将上述中间件代码中的M2.process_response()返回HttpResponse
五、中间件应用场景
    1、做IP限制
    2、URL访问过滤
    3、缓存(还记得CDN吗?)

一、中间件简介

在django中,中间件其实就是一个类,在请求到来和结束后,django会根据自己的规则在合适的时机执行中间件中相应的方法。

Django官方文档描述

中间件是一个钩子框架,它们可以介入Django 的请求和响应处理过程。它是一个轻量级、底层的“插件”系统,用于在全局修改Django 的输入或输出。

每个中间件组件负责完成某个特定的功能。例如,Django 包含的一个中间件组件AuthenticationMiddleware ,它使用会话将用户和请求关联起来。

这篇文档讲解中间件如何工作、如何激活中间件以及如何编写你自己的中间件。Django集成了一些内置的中间件可以直接开箱即用。它们被归档在 .内置中间件参考

二、激活中间件

要激活一个中间件组件,需要把它添加到Django项目的配置文件settings.py中的MIDDLEWARE列表中。

MIDDLEWARE中,每一个中间件组件用字符串的方式描述:一个完整的Python全路径加上中间件的类名称。例如,使用django-admin startproject创建项目的时候生成的默认值:

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',
    'django.middleware.locale.LocaleMiddleware',    # admin界面默认是显示英语,如果要显示中文,就添加这一行中间件
]

Django的程序中,中间件不是必需的---只要你喜欢,MIDDLEWARE列表可以为空,但是强烈推荐你至少使用CommonMiddleware这个中间件。

MIDDLEWARE中的顺序非常重要,因为一个中间件可能依赖于另外一个。因为一个中间件可能依赖于另外一个。例如,AuthenticationMiddleware在会话中储存已认证的用户。所以它必须在SessionMiddleware之后运行。一些关于Django中间件类的顺序的常见提示,请见中间件排序

三、中间件包含的钩子方法和应用的顺序

在请求阶段中,调用视图之前,Django会按照MIDDLEWARE中定义的顺序自顶向下应用中间件。会用到两个钩子:

  • process_request(request)
  • process_view(request, view_func, view_args, view_kwargs)

在响应阶段中,调用视图之后,中间件会按照相反的顺序应用,自底向上。会用到三个钩子:

  • process_exception(request, exception
  • process_template_response(request, response)
  • process_response(request, response)
中间件钩子方法应用顺序

上面5种钩子方法,你可以在自己写的中间件类中定义其中一种或多种。

1. 钩子方法的调用

1.1 process_request

process_request(request)
request是一个HttpRequest 对象。

Django在执行视图函数前,先从上往下调用每个中间件的process_request()方法。它应该返回一个None或一个HttpResponse对象。如果返回None(不写返回值相当于返回None),Django会继续调用下一个中间件的process_request()方法,当所有中间件的process_request()方法全部调用完毕且没有返回HttpResponse对象时,再从第一个中间件开始依次调用每个中间件的process_view()方法,最后执行对应的视图函数。如果它返回一个HttpResponse对象,Django就不用再去调用其它中间件的process_request()、process_view()或process_exception()和视图函数了,它将对HttpResponse 运用响应阶段的中间件,并返回结果。

1.2 process_view

process_view(request, view_func, view_args, view_kwargs)

request是一个HttpRequest对象。view_func是个视图函数, view_args是一个会被传递到视图的位置参数列表,而view_kwargs 是一个会被传递到视图的关键字参数字典。 view_args和 view_kwargs 都不包括第一个视图参数(request)。

process_view()会在Django 调用视图之前被调用。

它将返回None 或一个HttpResponse 对象。如果返回None,Django 将会继续执行其它的process_view() 中间件,然后调用对应的视图。如果返回一个HttpResponse对象,Django 就不用再去调用其它的view 或exception 中间件,或对应的视图;它将对HttpResponse 运用响应阶段的中间件,并返回结果。

注意:在中间件内部,从process_request 或process_view 中访问request.POST 或request.REQUEST 将阻碍该中间件之后的所有视图无法修改请求的上传处理程序,一般情况下要避免这样使用。

类CsrfViewMiddleware可以被认为是个例外,因为它提供csrf_exempt() 和csrf_protect()两个装饰器,允许视图显式控制在哪个点需要开启CSRF验证。

1.3 process_template_response

这个钩子实际中使用的较少

process_template_response(request, response)
request是一个HttpRequest对象。response是一个TemplateResponse对象(或等价的对象),由Django视图或者中间件返回。

如果响应的实例有render()方法,process_template_response()在视图刚好执行完毕之后被调用,这表明了它是一个TemplateResponse对象(或等价的对象)。

这个方法必须返回一个实现了render方法的响应对象。它可以修改给定的response对象,通过修改 response.template_name和response.context_data或者它可以创建一个全新的 TemplateResponse或等价的对象。

你不需要显式渲染响应 —— 一旦所有的模板响应中间件被调用,响应会自动被渲染。

在一个响应的处理期间,中间件以相反的顺序运行,这包括process_template_response()。

1.4 process_response

process_response(request, response)

process_response()在所有响应返回浏览器之前被调用。

request是一个HttpRequest对象。response是Django视图或者中间件返回的HttpResponse或者StreamingHttpResponse对象。

这个方法必须返回HttpResponse或者StreamingHttpResponse对象。它可以改变已有的response,或者创建并返回新的HttpResponse或StreamingHttpResponse对象。

不像 process_request()和process_view()方法,即使同一个中间件类中的process_request()和process_view()方法会因为前面的一个中间件返回HttpResponse而被跳过,process_response()方法总是会被调用。特别是,这意味着你的process_response()方法不能依赖于process_request()方法中的设置。

注意:最后,记住在响应阶段中,中间件以相反的顺序被应用,自底向上。意思是定义在MIDDLEWARE最底下的类的process_response()会最先被运行。

1.5 process_exception

process_exception(request, exception)

当一个视图抛出异常时,Django会调用process_exception()来处理。

request是一个HttpRequest对象。exception是一个被视图中的方法抛出来的 Exception对象。

process_exception()应该返回一个None 或者一个HttpResponse对象。如果它返回一个HttpResponse对象,模型响应和响应中间件会被应用,响应结果会返回给浏览器。否则, 默认的异常处理机制将会被触发。

再次提醒,在处理响应期间,中间件的执行顺序是倒序执行的,这包括process_exception。如果一个异常处理的中间件返回了一个响应,那这个中间件上面的中间件都将不会被调用。

四、编写自己的中间件

Django版本

>> django-admin version
1.11.7

自己写的中间件(类)必须继承MiddlewareMixin

1. 正常流程

只有process_request和process_response时

from django.shortcuts import HttpResponse
from django.utils.deprecation import MiddlewareMixin

class M1(MiddlewareMixin):
    def process_request(self,request):
        print('中间件: M1.process_request')

    def process_response(self,request,response):
        print('中间件:M1.process_response')
        return response

class M2(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M2.process_request')

    def process_response(self,request,response):
        print('中间件:M2.process_response')
        return response
        
class M3(MiddlewareMixin):

    def process_request(self,request):
        print('中间件:M3.process_request')

    def process_response(self,request,response):
        print('中间件:M3.process_response')
        return response

在settings.py中注册自己编写的中间件:

MIDDLEWARE = [
    ...
    'middleware.testMiddleWare.M1',
    'middleware.testMiddleWare.M2',
    'middleware.testMiddleWare.M3',
    ...
]

写一个简单的视图test

def test(request):
    print('views.test')
    return HttpResponse('ok')

urls.py中添加一条url

urlpatterns = [
    ...
    url(r'test/', views.test),
]

访问http://127.0.0.1:8000/test/后,后端打印结果如下:

中间件: M1.process_request
中间件:M2.process_request
中间件:M3.process_request
视图函数:views.test
中间件:M3.process_response
中间件:M2.process_response
中间件:M1.process_response

从输出结果,可以得出执行流程如下图:


执行流程1

2. process_request返回HttpResponse

将上述中间件代码中的M2.process_request()返回HttpResponse(其余代码不变):

class M2(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M2.process_request')
        return HttpResponse('前端显示:中间件:M2.process_request')

    def process_response(self,request,response):
        print('中间件:M2.process_response')
        return response

前端显示结果:

前端显示:中间件:M2.process_request

后端输入结果:

中间件: M1.process_request
中间件:M2.process_request
中间件:M2.process_response
中间件:M1.process_response

从输出结果,可以得出执行流程如下图:

执行流程2

M2.process_request()返回HttpResponse后,不再执行后面中间件的process_request()方法和视图函数,直接依次往上(倒序)执行M2和M1的process_response()方法。

3. 加入process_view()方法

from django.shortcuts import HttpResponse
from django.utils.deprecation import MiddlewareMixin

class M1(MiddlewareMixin):
    def process_request(self,request):
        print('中间件: M1.process_request')

    def process_response(self,request,response):
        print('中间件:M1.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M1.process_view')

class M2(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M2.process_request')

    def process_response(self,request,response):
        print('中间件:M2.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M2.process_view')
        print('callback:',callback)

class M3(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M3.process_request')

    def process_response(self,request,response):
        print('中间件:M3.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M3.process_view')

前端显示视图函数test返回的:ok

后端输出结果如下:

中间件: M1.process_request
中间件:M2.process_request
中间件:M3.process_request
中间件:M1.process_view
中间件:M2.process_view
callback: <function test at 0x00000000045A8A60>
中间件:M3.process_view
视图函数:views.test
中间件:M3.process_response
中间件:M2.process_response
中间件:M1.process_response

依结果得出执行流程如下:

执行流程3

3.1 将上述中间件代码中M3.process_request()返回一个HttpResponse(其余代码不变):

class M3(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M3.process_request')
        return HttpResponse('前端显示:中间件:M3.process_request')

    def process_response(self,request,response):
        print('中间件:M3.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M3.process_view')

前端页面显示:

前端显示:中间件:M3.process_request

后端输出结果如下:

中间件: M1.process_request
中间件:M2.process_request
中间件:M3.process_request
中间件:M3.process_response
中间件:M2.process_response
中间件:M1.process_response

从输入结果,可以得到如下执行流程:


执行流程4

从上述结果中可以看出,当process_request()返回HttpResponse时,就不再执行process_view()了。process_view()的callback参数是被执行的视图函数对象。

3.2 M2.process_view()返回HttpResponse,M3.process_request()返回None,其余代码不变:

注意:函数没有返回值时,默认返回None。

class M2(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M2.process_request')

    def process_response(self,request,response):
        print('中间件:M2.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M2.process_view')
        return HttpResponse('前端显示:中间件:M2.process_view')

前端页面显示:

前端显示:中间件:M2.process_view

后端输出结果如下:

中间件: M1.process_request
中间件:M2.process_request
中间件:M3.process_request
中间件:M1.process_view
中间件:M2.process_view
中间件:M3.process_response
中间件:M2.process_response
中间件:M1.process_response

从上述结果可以得出如下执行流程:

执行流程5

从上图中可以看出,当中间某一个中间件的process_view()返回HttpResponse时,就不再执行下面中间件的process_view()和视图函数了。

4. 加入process_exception()方法

此方法是当视图函数中抛出异常时执行,当返回None时,前端页面会抛出一个异常页面,当返回HttpResponse时,前端页面会显示你定制的内容。

from django.shortcuts import HttpResponse
from django.utils.deprecation import MiddlewareMixin

class M1(MiddlewareMixin):
    def process_request(self,request):
        print('中间件: M1.process_request')

    def process_response(self,request,response):
        print('中间件:M1.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M1.process_view')
        # return HttpResponse('M1.process_view')

    def process_exception(self,request,exception):
        print('中间件:M1.process_exception')

class M2(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M2.process_request')
        # return HttpResponse('前端显示:中间件:M2.process_request')

    def process_response(self,request,response):
        print('中间件:M2.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M2.process_view')
        # return HttpResponse('前端显示:中间件:M2.process_view')

    def process_exception(self,request,exception):
        print('中间件:M2.process_exception')

class M3(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M3.process_request')
        # return HttpResponse('前端显示:中间件:M3.process_request')

    def process_response(self,request,response):
        print('中间件:M3.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M3.process_view')
        # return HttpResponse('前端显示:中间件:M3.process_view')

    def process_exception(self,request,exception):
        print('中间件:M3.process_exception')

故意给视图函数test加一个错误:

def test(request):
    int('abc')     #将字母转换成整型一定会抛出异常
    print('视图函数:views.test')
    return HttpResponse('ok')

前端页面显示如下图:


前端错误页面

4.1 将上述中间件代码中的M2.process_response()返回HttpResponse

class M2(MiddlewareMixin):
    def process_request(self,request):
        print('中间件:M2.process_request')

    def process_response(self,request,response):
        print('中间件:M2.process_response')
        return response

    def process_view(self,request,callback,args,kwargs):
        print('中间件:M2.process_view')

    def process_exception(self,request,exception):
        print('中间件:M2.process_exception')
        return HttpResponse("500错误")

前面页面显示:

500错误

后端输出结果:

中间件: M1.process_request
中间件:M2.process_request
中间件:M3.process_request
中间件:M1.process_view
中间件:M2.process_view
中间件:M3.process_view
中间件:M3.process_exception
中间件:M2.process_exception
中间件:M3.process_response
中间件:M2.process_response
中间件:M1.process_response

执行流程如下图:


执行流程6

从上图可以看出,当中一个中间件的process_exception()方法捕获到视图函数中抛出异常的后并返回HttpResponse,则前端页面就显示你自定制的内容。后端程序也不会出现异常。并且前面的中间件process_exception()也不再执行。

五、中间件应用场景

由于中间件工作在 视图函数执行前、执行后(像不像所有视图函数的装饰器!)适合所有的请求/一部分请求做批量处理

1、做IP限制

放在 中间件类的列表中,阻止某些IP访问了;

2、URL访问过滤

如果用户访问的是login视图(放过)

如果访问其他视图(需要检测是不是有session已经有了放行,没有返回login),这样就省得在 多个视图函数上写装饰器了!

3、缓存(还记得CDN吗?)

客户端请求来了,中间件去缓存看看有没有数据,有直接返回给用户,没有再去逻辑层 执行视图函数

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容