Django 文档协作翻译小组人手紧缺,有兴趣的朋友可以加入我们,完全公益性质。

交流群:467338606

网站:http://python.usyiyi.cn/django/index.html

中间件

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

中间件组件责任处理某些特殊的功能。例如,Django包含一个中间件组件,AuthenticationMiddleware ,使用会话将用户和请求关联。

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

激活中间件

要激活一个中间件组件,需要把它添加到你Django配置文件中的MIDDLEWARE_CLASSES 列表中。

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

MIDDLEWARE_CLASSES = ('django.contrib.sessions.middleware.SessionMiddleware','django.middleware.common.CommonMiddleware','django.middleware.csrf.CsrfViewMiddleware','django.contrib.auth.middleware.AuthenticationMiddleware','django.contrib.auth.middleware.SessionAuthenticationMiddleware','django.contrib.messages.middleware.MessageMiddleware','django.middleware.clickjacking.XFrameOptionsMiddleware','django.middleware.security.SecurityMiddleware',
)

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

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

钩子和应用顺序

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

  • process_request()
  • process_view()

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

  • process_exception() (仅当视图抛出异常的时候)
  • process_template_response() (仅用于模板响应)
  • process_response()

如果你愿意的话,你可以把它想象成一颗洋葱:每个中间件都是包裹视图的一层“皮”。

每个钩子的行为接下来会描述。

编写自己的中间件

编写自己的中间件很容易的。每个中间件组件是一个单独的Python的class,你可以定一个或多个下面的这些方法:

process_request

process_request(request)

request是一个HttpRequest 对象。

在Django决定执行哪个视图(view)之前,process_request()会被每次请求调用。

它应该返回一个None 或一个HttpResponse对象。如果返回 None, Django会继续处理这个请求,执行其他process_request()中间件,然后process_view()中间件显示对应的视图。如果它返回一个HttpResponse对象,Django便不再会去调用其他的请求(request), 视图(view)或其他中间件,或对应的视图;处理HttpResponse的中间件会处理任何返回的响应(response)。

process_view

process_view(request, view_func, view_args, view_kwargs)

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

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

它将返回None 或一个HttpResponse 对象。如果返回 None,将会继续处理这个请求,执行其他的process_view() 中间件,然后显示对应的视图。如果返回HttpResponse对象,Django就不再会去调用其他的视图(view),异常中间件(exception middleware)或对应的视图 ;它会把响应中间件应用到HttpResponse上,并返回结果。

注意

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

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

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()。

process_response

process_response(request, response)

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

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

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

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

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

处理流式响应

不像HttpResponse,StreamingHttpResponse并没有content属性。所以,中间件再也不能假设所有响应都带有content属性。如果它们需要访问内容,他们必须测试是否为流式响应,并相应地调整自己的行为。

if response.streaming:response.streaming_content = wrap_streaming_content(response.streaming_content)
else:response.content = alter_content(response.content)

注意

我们需要假设streaming_content可能会大到在内存中无法容纳。响应中间件可能会把它封装在新的生成器中,但是一定不要销毁它。封装一般会实现成这样:

def wrap_streaming_content(content):for chunk in content:yield alter_content(chunk)

process_exception

process_exception(request, exception)

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

当一个视图抛出异常时,Django会调用process_exception()来处理。process_exception()应该返回一个None 或者一个HttpResponse对象。如果它返回一个HttpResponse对象,模型响应和响应中间件会被应用,响应结果会返回给浏览器。Otherwise, default exception handling kicks in.

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

__init__

大多数的中间件类都不需要一个初始化方法,因为中间件的类定义仅仅是为process_*提供一个占位符。如果你确实需要一个全局的状态那就可以通过__init__来加载。然后要铭记如下两个警告:

Django初始化你的中间件无需任何参数,因此不要定义一个有参数的__init__方法。
不像process_*每次请求到达都要调用__init__只会被调用一次,就是在Web服务启动的时候。

标记中间件不被使用

有时在运行时决定是否一个中间件需要被加载是很有用的。 在这种情况下,你的中间件中的 __init__方法可以抛出一个django.core.exceptions.MiddlewareNotUsed异常。Django会从中间件处理过程中移除这部分中间件,并且当DEBUG为True的时候在django.request记录器中记录调试信息。

1.8中的修改:之前 MiddlewareNotUsed异常不会被记录。

指导准则

  • 中间件的类不能是任何类的子类。
  • 中间件可以存在与你Python路径中的任何位置。 Django所关心的只是被包含在MIDDLEWARE_CLASSES中的配置。
  • 将Django’s available middleware作为例子随便看看。
  • 如果你认为你写的中间件组建可能会对其他人有用,那就把它共享到社区! 让我们知道它,我们会考虑把它添加到Django中。

django 1.8 官方文档翻译: 3-6-1 中间件概览相关推荐

  1. django 1.8 官方文档翻译: 2-5-7 自定义查找

    自定义查找 New in Django 1.7. Django为过滤提供了大量的内建的查找(例如,exact和icontains).这篇文档阐述了如何编写自定义查找,以及如何修改现存查找的功能.关于查 ...

  2. django 1.8 官方文档翻译: 14-4-1 重定向应用

    重定向应用 Django 原生自带一个可选的重定向应用.它将简单的重定向保存到数据库中并处理重定向.它默认使用HTTP 响应状态码301 Moved Permanently. 安装 请依照下面的步骤安 ...

  3. django 1.8 官方文档翻译: 6-6-2 如何使用WSGI 部署

    如何使用WSGI 部署 Django 首要的部署平台是WSGI,它是Python Web 服务器和应用的标准. Django 的startproject 管理命名为你设置一个简单的默认WSGI 配置, ...

  4. django 1.8 官方文档翻译: 2-5-6 多数据库

    多数据库 这篇主题描述Django 对多个数据库的支持.大部分Django 文档假设你只和一个数据库打交道.如果你想与多个数据库打交道,你将需要一些额外的步骤. 定义你的数据库 在Django中使用多 ...

  5. django 1.8 官方文档翻译: 1-1-2 快速安装指南

    快速安装指南 在你开始使用 Django 之前,你需要先安装它.我们有一个 完整安装指南 它涵盖了所有的安装步骤和可能遇到的问题:本指南将会给你一个最简单.简洁的安装指引. 安装 Python 作为一 ...

  6. django 1.8 官方文档翻译: 3-4-2 基于类的内建通用视图

    基于类的内建通用视图 编写Web应用可能是单调的,因为你需要不断的重复某一种模式. Django尝试从model和 template层移除一些单调的情况,但是Web开发者依然会在view(视图)层经历 ...

  7. django 1.8 官方文档翻译:2-5-9 条件表达式

    条件表达式 New in Django 1.8. 条件表达式允许你在过滤器.注解.聚合和更新操作中使用 if ... elif ... else的逻辑.条件表达式为表中的每一行计算一系列的条件,并且返 ...

  8. django 1.8 官方文档翻译:8-5 加密签名

    加密签名 web应用安全的黄金法则是,永远不要相信来自不可信来源的数据.有时通过不可信的媒介来传递数据会非常方便.密码签名后的值可以通过不受信任的途径传递,这样是安全的,因为任何篡改都会检测的到. D ...

  9. django 1.8 官方文档翻译: 3-4-2 内建显示视图

    Django 文档协作翻译小组人手紧缺,有兴趣的朋友可以加入我们,完全公益性质. 交流群:467338606 网站:http://python.usyiyi.cn/django/index.html ...

  10. django 1.8 官方文档翻译:2-1-1 模型语法

    模型 模型是你的数据的唯一的.权威的信息源.它包含你所储存数据的必要字段和行为.通常,每个模型对应数据库中唯一的一张表. 基础: 每个模型都是django.db.models.Model 的一个Pyt ...

最新文章

  1. jpa多条件查询重写Specification的toPredicate方法(转)
  2. きゃらコレ! -ALICESOFT- 汉化补丁
  3. 面试必备算法题集之「动态规划」Ⅰ
  4. VTK:可视化之StructuredDataTypes
  5. SGU 183. Painting the balls( dp )
  6. iOS之常用的方法和技巧
  7. CentOS 6.0 X86_64 下 vsftp 配置过程
  8. 六、Analysis of quicksort
  9. Linux-Ubuntu安装 MySQL
  10. 美网络司令部:马上修复严重的 PAN-OS 漏洞,免遭国家黑客攻击
  11. CentOS 7 怎样自动连接网络
  12. 正则式获取特定标识的字符串并替换
  13. R_ggplot2地理信息可视化_史上最全(二)
  14. WIFI和蓝牙无线模块的应用小结
  15. 求PIFA天线相关介绍
  16. 《C专家编程》阅读笔记
  17. STM32 直流电机 转速比
  18. Linux下制作WIndows 7启动U盘
  19. python里的jh是啥意思_JH是什么意思啊
  20. 2022年最值得阅读的强化学习书籍

热门文章

  1. 太空java游戏_JavaSpaceWar 一个基于 语言编写的太空战争游戏,包含所有图像和声音资源,便 习理解使用 Game Program 238万源代码下载- www.pudn.com...
  2. php怎么将网页变成图片格式,php如何实现图片格式转换
  3. leecode-8字符串转化为整数C版
  4. STM32 DMA详解
  5. python3调用adb命令_Python操作adb命令
  6. java 国家名称排序,我有一个国家名单。我想按字母顺序对它进行排序,除了两个我想放在第一位的国家...
  7. python列表数据类型一致_python自学——数据类型之列表
  8. c语言程序可以单独编译,c语言的函数能单独进行编译吗?
  9. 【重难点】【Java基础 01】一致性哈希算法、sleep() 和wait() 的区别、强软弱虚引用
  10. [cerc2012][Gym100624C]20181013