Django中的中间件机制和执行顺序
该文章转载至:https://blog.csdn.net/orangleliu/article/details/48316919
什么是 middleware
Middlewares 是修改 Django request 或者 response 对象的钩子. 下面是Django 文档中的一段描述。
[code]Middleware is a framework of hooks into Django’s request/response processing. It’s a light, low-level “plugin” system for globally altering Django’s input or output.
- 1
什么时候使用 middleware
如果你想修改请求,例如被传送到view中的HttpRequest对象。 或者你想修改view返回的HttpResponse对象,这些都可以通过中间件来实现。
可能你还想在view执行之前做一些操作,这种情况就可以用 middleware来实现。
Django 提供了一些默认的 middleware,例如:
AuthenticationMiddleware
大家可能频繁在view使用
request.user吧。 Django想在每个view执行之前把user设置为request的属性,于是就用了一个中间件来实现这个目标。所以Django提供了可以修改request 对象的中间件
AuthenticationMiddleware。
Django 这样修改request对象的:
[code]https://github.com/django/django/blob/master/django/contrib/auth/middleware.py#L22
- 1
例如你有一个应用,它的用户是不同时区的人们。你想让他们在访问任何页面的时候都能显示正确的时区,想让所有的views中都能得到用户自己的timezone信息。 这种情况下可以用session来解决,所以你可以像下面添加一个 middleware:
[code]class TimezoneMiddleware(object): def process_request(self, request): # Assuming user has a OneToOneField to a model called Profile # And Profile stores the timezone of the User. request.session['timezone'] = request.user.profile.timezone
- 1
- 2
- 3
- 4
- 5
TimezoneMiddleware 是依赖于 request.user的,request.user 是通过
AuthenticationMiddleware来设置的。 所以在
settings.MIDDLEWARE_CLASSES配置中,TimezoneMiddleware 一定要在 AuthenticationMiddleware 之后。
下面的例子可以得到关于中间件顺序的更多体会。
使用middleware时应该记住的东西
- middlewares 的顺序非常重要
- 一个middleware只需要继承 object 类
- 一个middleware可以实现一些方法并且不需要实现所有的方法
- 一个middleware可以实现 process_request(方法) 但是不可以实现 process_response(方法) 和 process_view 方法。 这些都很常见,Django提供了很多middlewares可以做到。
- 一个middleware可以实现 process_response 方法,但是不需要实现 process_request 方法
AuthenticationMiddleware 只实现了对请求的处理,并没有处理响应. 参照文档
GZipMiddleware 只实现了对响应的处理,并没有实现对请求和view的处理 参见文档
写一些 middlewares
首先确认下你有一个Django项目,需要一个url和一个view,并且可以进入这个view。下面我们会对request.user做几个测试,确认权限设置好了,并可以在view中正确打印 request.user 的信息。
在任意一个app中创建middleware.py文件。
我有一个叫做books的app,所以文件的位置是
books/middleware.py
[code]class BookMiddleware(object): def process_request(self, request): print "Middleware executed"
MIDDLEWARE_CLASSES 中添加这个中间件
[code]MIDDLEWARE_CLASSES = ( 'books.middleware.BookMiddleware', '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', )
对任意的一个url发送请求, 下面的信息将会打印在runserver的控制台。
[code]Middleware executed
修改
BookMiddleware.process_request如下
[code]class BookMiddleware(object): def process_request(self, request): print "Middleware executed" print request.user
再次访问一个url,将会引起一个错误。
[code]'WSGIRequest' object has no attribute 'user'
这是因为request对象还没有设置user属性呢。
现在我们改变下 middlewares的顺序,
BookMiddleware放在
AuthenticationMiddleware之后。
[code]MIDDLEWARE_CLASSES = ( 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'books.middleware.BookMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', )
访问一个url,runserver控制台打印如下
[code]Middleware executed <username>
这说明middlewares处理request的顺序跟 settings.MIDDLEWARE_CLASSES 中列出的顺序是一致的。
你可以进一步证实,middleware.py添加另外一个middleware
[code]class AnotherMiddleware(object): def process_request(self, request): print "Another middleware executed"
把它也加到
MIDDLEWARE_CLASSES
[code]MIDDLEWARE_CLASSES = ( 'django.contrib.sessions.middleware.SessionMiddleware', 'django.middleware.common.CommonMiddleware', 'django.middleware.csrf.CsrfViewMiddleware', 'django.contrib.auth.middleware.AuthenticationMiddleware', 'books.middleware.BookMiddleware', 'books.middleware.AnotherMiddleware', 'django.contrib.messages.middleware.MessageMiddleware', 'django.middleware.clickjacking.XFrameOptionsMiddleware', )
现在的输出是:
[code]Middleware executed <username> Another middleware executed
在process_request方法中返回HttpResponse,把BookMiddleware改成下面这样:
[code]class BookMiddleware(object): def process_request(self, request): print "Middleware executed" print request.user return HttpResponse("some response")
尝试下任何一个url,会得到如下输出:
[code]Middleware executed <username>
你会注意到下面2个事情:
- 不管你访问哪个url,自己写的view 处理方法都不执行了,只有 “some response”这样一种响应。
- AnotherMiddleware.process_request 不在被执行
所以如果 Middleware的process_request方法中返回了HttpResponse对象,那么它之后的中间件将被略过, view中的处理方法也被略过。
所以在实际的项目中很少会这么干(不过也有些项目会,例如做代理)
注释掉
"return HttpResponse("some response")",两个 middleware 才能正常的处理请求。
使用 process_response
给这两个middleware添加 process_response方法
[code]class AnotherMiddleware(object): def process_request(self, request): print "Another middleware executed" def process_response(self, request, response): print "AnotherMiddleware process_response executed" return response class BookMiddleware(object): def process_request(self, request): print "Middleware executed" print request.user return HttpResponse("some response") #self._start = time.time() def process_response(self, request, response): print "BookMiddleware process_response executed" return response
访问一些url,得到如下的输出
[code]Middleware executed <username> Another middleware executed AnotherMiddleware process_response executed BookMiddleware process_response executed
AnotherMiddleware.process_response()在
BookMiddleware.process_response()之前执行 而
AnotherMiddleware.process_request()在
BookMiddleware.process_request()之后执行. 所以
process_response()执行的顺序跟 process_request正好相反.
process_response()执行的顺序是从最后一个中间件执行,到倒数第二个,然后直到第一个中间件.
process_view
Django 按顺序执行中间件
process_view()的方法,从上到下。 类似process_request()方法执行的顺序。
所以如果任何一个
process_view()返回了HttpResponse对象,那么在它后面
process_view()将会被省略,不会被执行。 阅读更多
- [Django高级]理解django中的中间件机制和执行顺序
- [Django高级]理解django中的中间件机制和执行顺序
- 详解Django中间件执行顺序
- Django 中间件 执行机制
- sturts2拦截器执行顺序理解以及拦截器机制实现原理
- javascript运行机制之执行顺序详解
- Django--服务端响应url请求的执行顺序
- JavaScript在HTML中的执行顺序与运行机制
- javascript运行机制之执行顺序详解
- javascript运行机制之执行顺序详解
- 74_异常机制_try_catch_finally_return执行顺序
- javascript运行机制之执行顺序详解
- javascript运行机制之执行顺序详解
- VC++学习笔记之MFC应用程序创建/执行顺序和MFC运行机制
- Java异常处理机制以及try-catch-finally-return执行顺序
- 异常机制第三十六课,try,_catch,finally,_return执行顺序
- javascript运行机制之执行顺序详解
- 'AjaxPro'未定义错误的原因&javascript顺序执行&AjaxPro机制
- 请求处理机制其二:Django中间件的解析
- [Django架构流程分析]请求处理机制其二:Django中间件的解析