请求和响应对象¶

概述¶

Django使用Request对象和Response对象在系统间传递状态.

当请求一个页面时, Django会创建一个包含请求元数据的 HttpRequest 对象. 然后加载相应的视图, 将 HttpRequest 作为视图函数的第一个参数传入. 视图函数负责返回一个 HttpResponse 对象.

本文档对 HttpRequest 和 HttpResponse 对象的API进行说明, 这些API定义在 django.http 模块中.

`HttpRequest` 对象¶

class HttpRequest¶

属性¶

除非另有说明, 否则所有属性都应视为只读.

HttpRequest.scheme¶: 代表请求协议的字符串 (通常是 http 或 https).

HttpRequest.body¶

表示原始HTTP请求正文的字节字符串. 它对处理非HTML表单数据非常有用: 二进制图片, XML等. 如果要处理常规表单数据, 请使用 HttpRequest.POST.

还可以使用类似文件的接口从HttpRequest读取数据. 详见 HttpRequest.read().

HttpRequest.path¶

请求页面完整路径, 不包括scheme和domain.

例如: "/music/bands/the_beatles/"

HttpRequest.path_info¶

在某些Web服务器配置下, 主机名后的URL被分成脚本前缀部分和路径信息部分. path_info 属性始终会包含路径信息部分, 不论使用什么Web服务器, 使用它代替 path 可以使代码在测试和开发环境中更好地切换.

例如, 如果应用的 WSGIScriptAlias 设置为 "/minfo", path 是 "/minfo/music/bands/the_beatles/" 时 path_info 是 "/music/bands/the_beatles/".

HttpRequest.method¶

一个字符串, 表示请求使用的HTTP方法. 大些字母形式. 例如:

if request.method == 'GET':
    do_something()
elif request.method == 'POST':
    do_something_else()

HttpRequest.encoding¶: 一个字符串, 表示提交的数据的编码(如果为 None, 表示使用 DEFAULT_CHARSET 设置). 可以修改这个属性值来改变访问表单数据使用的编码. 修改后的属性访问(从 GET 或 POST 读取)都将使用新的 encoding 值. 这对于访问数据不是 DEFAULT_CHARSET 编码时非常有用.

HttpRequest.content_type¶: New in Django 1.10:

从 CONTENT_TYPE 请求头中解析到的MIME类型字符串.

HttpRequest.content_params¶: New in Django 1.10:

CONTENT_TYPE 请求头中的键值参数字典.

HttpRequest.GET¶: 包含所有HTTP GET请求参数的类字典对象. 详见 QueryDict.

HttpRequest.POST¶

包含所有HTTP POST请求参数的类字典对象, 前提是请求包含了表单数据. 详见 QueryDict. 如果需要访问post提交的原始或非表单数据, 可以使用 HttpRequest.body 属性.

有可能会有POST请求但是 POST 为空字典的情况 – 比如, 不包含表单数据的POST请求. 因此, 不要使用 if request.POST 来判断是否为POST请求; 应该使用 if request.method == "POST" (见上文).

注意: POST 不包含文件上传信息. 见 FILES.

HttpRequest.COOKIES¶: 包含所有cookie的Python字典. 键和值都是字符串.

HttpRequest.FILES¶

包含所有上传文件的类字典对象. FILES 中的键为 <input type="file" name="" /> 中的 name. FILES 中的值是一个 UploadedFile 对象.

详见 Managing files.

注意, 只有 <form> 中带有 enctype="multipart/form-data" 的POST请求, FILES 才会有数据, 否则将是一个空的类字典对象.

HttpRequest.META¶

包含所有可用HTTP首部的Python字典. 可用的首部取决了客户端和服务端, 下面是一些例子:

CONTENT_LENGTH – 请求体的长度 (字符串).
CONTENT_TYPE – 请求体的 MIME 类型.
HTTP_ACCEPT – 可接受的响应类型.
HTTP_ACCEPT_ENCODING – 可接受的响应编码.
HTTP_ACCEPT_LANGUAGE – 可接受的响应语言.
HTTP_HOST – 客户端发送的HTTP HOST首部.
HTTP_REFERER – referrer页面, 如果有的话.
HTTP_USER_AGENT – 客户端的user-agent字符串.
QUERY_STRING – 查询字符串, 单独(未解析)的一个字符串.
REMOTE_ADDR – 客户端的IP地址.
REMOTE_HOST – 客户端的hostname.
REMOTE_USER – Web服务器认证的用户, 如果有的话.
REQUEST_METHOD – "GET" 或 "POST" 等字符串.
SERVER_NAME – 服务端的hostname.
SERVER_PORT –服务端的端口(字符串).

从上面可以看出, 除了 CONTENT_LENGTH 和 CONTENT_TYPE 之外, 请求中的HTTP首部都会被转换为 META 中的键, 它将所有字符转换为大写用下划线连接, 并加上 HTTP_ 前缀, 例如名为 X-Bender 的首部将被映射到 META 键 HTTP_X_BENDER.

注意, runserver 会取消所有名称中带有下划线的请求头, 因此您不会在 META 中看到它们. 这可以防止基于下划线和破折号之间的歧义的报文欺骗, 这两种符号在WSGI环境变量中都被规范化为下划线. 它与Nginx和apache2.4+等Web服务器的行为相匹配.

HttpRequest.resolver_match¶: 代表解析后URL的 ResolverMatch 实例. 该属性只有在URL解析后才会被设置, 因此它在视图中是可用的, 但是在URL解析之前执行的中间件中不可用(不过可以在 process_view() 中使用).

应用程序代码设置的属性¶

Django不会自己设置这些属性, 而是由应用程序设置使用它们.

HttpRequest.current_app¶: url 模板标签使用它的值作为 reverse() 的 current_app 参数.

HttpRequest.urlconf¶

这将作为当前请求的根URLconf, 覆盖 ROOT_URLCONF 设置. 详见 How Django processes a request.

urlconf 可以设置为 None 用来重置在之前中间件中所做的修改, 并返回使用 ROOT_URLCONF.

Changed in Django 1.9:

在之前版本中, 设置 urlconf=None 会引发 ImproperlyConfigured 异常.

中间件设置的属性¶

Django的contrib应用中的一些中间件会在请求上设置属性. 如果在请求中没有见到这些属性, 请求确保 MIDDLEWARE 中使用了正确的中间件.

HttpRequest.session¶: 出自 SessionMiddleware: 一个可读写的代表当前session的类字典对象.

HttpRequest.site¶: 出自 CurrentSiteMiddleware: get_current_site() 返回的 Site 或者 RequestSite 实例, 代表当前站点.

HttpRequest.user¶

出自 AuthenticationMiddleware: 代表当前登录用户的 AUTH_USER_MODEL 实例. 如果用户没有登录, user 会返回一个 AnonymousUser 实例. 可以使用 is_authenticated 来区分它们, 例如:

if request.user.is_authenticated:
    ... # Do something for logged-in users.
else:
    ... # Do something for anonymous users.

方法¶

HttpRequest.get_host()¶

根据 HTTP_X_FORWARDED_HOST (如果启用了 USE_X_FORWARDED_HOST) 和 HTTP_HOST 首部按顺序返回请求原始host. 如果没有提供响应的值, 则使用 SERVER_NAME 和 SERVER_PORT 组合, 详见 PEP 3333.

例如: "127.0.0.1:8000"

注解

当使用了多重代理时 get_host() 方法会失败. 有个解决方法是使用中间件重新代理首部, 例如:

from django.utils.deprecation import MiddlewareMixin

class MultipleProxyMiddleware(MiddlewareMixin):
    FORWARDED_FOR_FIELDS = [
        'HTTP_X_FORWARDED_FOR',
        'HTTP_X_FORWARDED_HOST',
        'HTTP_X_FORWARDED_SERVER',
    ]

    def process_request(self, request):
        """
        Rewrites the proxy headers so that only the most
        recent proxy is used.
        """
        for field in self.FORWARDED_FOR_FIELDS:
            if field in request.META:
                if ',' in request.META[field]:
                    parts = request.META[field].split(',')
                    request.META[field] = parts[-1].strip()

该中间件应该放在所有依赖 get_host() 的中间件之前 – 例如, CommonMiddleware 或者 CsrfViewMiddleware.

HttpRequest.get_port()¶: New in Django 1.9:

根据 HTTP_X_FORWARDED_PORT (如果启用了 USE_X_FORWARDED_PORT 设置) 和 SERVER_PORT META 变量, 按顺序返回请求的原始端口.

HttpRequest.get_full_path()¶

返回带有查询字符串的 path (如果有的话).

例如: "/music/bands/the_beatles/?print=true"

HttpRequest.build_absolute_uri(location)¶

返回 location 的绝对URI. 如果没有则设置为 request.get_full_path().

如果URI已经是一个绝对的URI则不会修改, 否则, 使用请求中的服务器相关的变量构建绝对URI.

例如: "https://example.com/music/bands/the_beatles/?print=true"

注解

不鼓励在同一站点中混用HTTP和HTTPS, 因此, build_absolute_uri() 会始终返回与当前请求相同协议的绝对URI. 如果你想将用户重定向到HTTPS, 最好让Web服务器将所有HTTP请求重定向到HTTPS.

HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt='', max_age=None)¶

返回签名的cookie值, 如果签名不再有效则引发 django.core.signing.BadSignature 异常. 如果提供了 default 参数, 则不会引发异常而是返回default值.

可选参数 salt 用来提供额外的保护以防止对秘钥的暴力攻击. max_age 参数用于检查cookie的签名时间戳, 确保不超过 max_age 秒.

例如:

>>> request.get_signed_cookie('name')
'Tony'
>>> request.get_signed_cookie('name', salt='name-salt')
'Tony' # assuming cookie was set using the same salt
>>> request.get_signed_cookie('non-existing-cookie')
...
KeyError: 'non-existing-cookie'
>>> request.get_signed_cookie('non-existing-cookie', False)
False
>>> request.get_signed_cookie('cookie-that-was-tampered-with')
...
BadSignature: ...
>>> request.get_signed_cookie('name', max_age=60)
...
SignatureExpired: Signature age 1677.3839159 > 60 seconds
>>> request.get_signed_cookie('name', False, max_age=60)
False

详见加密签名 .

HttpRequest.is_secure()¶: 如果请求是安全的则返回 True , 即使用HTTPS.

HttpRequest.is_ajax()¶

如果请求是通过 XMLHttpRequest 发起的则返回 True, 方法是检查 HTTP_X_REQUESTED_WITH 首部中是否包含 'XMLHttpRequest'. 大部分现在的JavaScript库都会发送这个首部. 如果你自定义了XMLHttpRequest调用(浏览器端), 想要 is_ajax() 正常工作的话需要手动设置这个首部.

如果响应根据是否通过AJAX请求而有所不同, 并且您正在使用某种形式的缓存, 如Django的 缓存中间件, 则应使用 vary_on_headers('X-Requested-With') 来装饰视图以便正确缓存响应.

HttpRequest.read(size=None)¶

HttpRequest.readline()¶

HttpRequest.readlines()¶

HttpRequest.xreadlines()¶

HttpRequest.__iter__()¶

实现从HttpRequest实例类似文件读取的接口. 这使得可以以流的方式读取请求. 常见的用例是使用迭代解析器处理大型XML负载, 而无需在内存中构建整个XML树.

给定此标准接口, HttpRequest实例可以直接传递给XML解析器, 如ElementTree:

import xml.etree.ElementTree as ET
for element in ET.iterparse(request):
    process(element)

`QueryDict` 对象¶

class QueryDict¶

在 HttpRequest 对象中, GET 和 POST 属性都是 django.http.QueryDict 实例, 这是一个类似字典的类, 用来处理一个键的多个值. 这很有用, 因为有些HTML表单, 尤其是 <select multiple>, 会传递一个键的多个值.

QueryDict 在 request.POST 和 request.GET 的一个正常请求/响应周期中是不可变的. 如果有修改需要请使用 .copy().

方法¶

QueryDict 实现了字典的所有标准方法, 因为它是字典的子类. 下面列出了例外情况:

QueryDict.__init__(query_string=None, mutable=False, encoding=None)¶

基于 query_string 实例化的 QueryDict 对象.

>>> QueryDict('a=1&a=2&c=3')
<QueryDict: {'a': ['1', '2'], 'c': ['3']}>

如果没有传入 query_string, 返回的 QueryDict 为空(没有键和值).

大多数的 QueryDict, 特别是 request.POST 和 request.GET 中的都是不可变的. 如果你在自己实例化时, 可以在 __init__() 中传入 mutable=True 来创建可变的实例.

设置的键和值都会使用 encoding 编码方式编码. 如果没有设置编码方式, 则使用默认的 DEFAULT_CHARSET.

QueryDict.__getitem__(key)¶: 返回给定键的值. 如果该键有多个值, __getitem__() 返回最后一个值. 如果键不存在则会引发 django.utils.datastructures.MultiValueDictKeyError. (它是Python KeyError 异常的一个子类, 所以可以使用 KeyError 捕获该异常.)

QueryDict.__setitem__(key, value)¶: 为指定键设置值 [value] (只有一个 value 元素的Python列表). 注意, 和其他带有限制的字典函数一样, 它仅可以在可变的 QueryDict 上调用(比如通过 copy() 创建的副本).

QueryDict.__contains__(key)¶: 如果设置了给定的键则返回 True . 这使你能够 if "foo" in request.GET 这样.

QueryDict.get(key, default=None)¶: 使用和上面 __getitem__() 一样逻辑, 如果键不存在则返回默认值.

QueryDict.setdefault(key, default=None)¶: 和普通字典的 setdefault() 方法一样, 只是它内部使用的是 __setitem__().

QueryDict.update(other_dict)¶

接收一个 QueryDict 或普通字典. 和普通字典的 update() 方法类似, 除了当键存在时它是添加新值而不是替换. 例如:

>>> q = QueryDict('a=1', mutable=True)
>>> q.update({'a': '2'})
>>> q.getlist('a')
['1', '2']
>>> q['a'] # returns the last
'2'

QueryDict.items()¶

类似普通字典的 items() 方法, 除了它使用与 __getitem__() 相同逻辑取最后一个值. 例如:

>>> q = QueryDict('a=1&a=2&a=3')
>>> q.items()
[('a', '3')]

QueryDict.iteritems()¶

类似普通字典的 iteritems() 方法. 和 QueryDict.items() 一样使用与 QueryDict.__getitem__() 相同的逻辑取最后一个值.

仅适用于Python2.

QueryDict.iterlists()¶

类似 QueryDict.iteritems(), 只是它以列表形式返回字典成员的所有值.

仅适用于Python2.

QueryDict.values()¶

类似普通字典的 values() 方法, 除了它使用与 __getitem__() 相同的逻辑返回最后一个值. 例如:

>>> q = QueryDict('a=1&a=2&a=3')
>>> q.values()
['3']

QueryDict.itervalues()¶

类似 QueryDict.values(), 只是它返回的是迭代器.

仅适用于Python2.

此外, QueryDict 还有如下方法:

QueryDict.copy()¶: 使用Python标准库 copy.deepcopy() 返回对象的副本. 返回的对象是可变的即使原始对象不可变.

QueryDict.getlist(key, default=None)¶: 以列表形式返回给定键的数据, 如果键不存在且没有提供默认值则返回空列表. 除了默认值不是列表的情况, 它的返回值一定是列表.

QueryDict.setlist(key, list_)¶: 为指定键设置值 list_ (与 __setitem__() 不同).

QueryDict.appendlist(key, item)¶: 将项追加到与键相关联的列表中.

QueryDict.setlistdefault(key, default_list=None)¶: 类似 setdefault, 只是它接收一个列表而不是单个值.

QueryDict.lists()¶

类似 items(), 它以列表形式返回字典成员的所有值. 例如:

>>> q = QueryDict('a=1&a=2&a=3')
>>> q.lists()
[('a', ['1', '2', '3'])]

QueryDict.pop(key)¶

移除并返回字典中给定键对应值的列表. 如果键不存在会引发 KeyError 异常. 例如:

>>> q = QueryDict('a=1&a=2&a=3', mutable=True)
>>> q.pop('a')
['1', '2', '3']

QueryDict.popitem()¶

删除并返回字典的任意成员(因为没有顺序的概念), 返回一个元组, 包含键和所有值的列表. 如果对空字典调用会引发 KeyError 异常. 例如:

>>> q = QueryDict('a=1&a=2&a=3', mutable=True)
>>> q.popitem()
('a', ['1', '2', '3'])

QueryDict.dict()¶

返回 QueryDict 的 dict 形式. 对于 QueryDict 中的每个(键, 列表), dict 是(键, item), item是列表中的一个元素, 使用与 QueryDict.__getitem__() 相同逻辑返回:

>>> q = QueryDict('a=1&a=3&a=5')
>>> q.dict()
{'a': '5'}

QueryDict.urlencode(safe=None)¶

返回query-string格式字符串. 例如:

>>> q = QueryDict('a=2&b=3&b=5')
>>> q.urlencode()
'a=2&b=3&b=5'

或者, 可以向urlencode传递不需要编码的字符. 例如:

>>> q = QueryDict(mutable=True)
>>> q['next'] = '/a&b/'
>>> q.urlencode(safe='/')
'next=/a%26b/'

`HttpResponse` 对象¶

class HttpResponse¶

与自动创建的 HttpRequest 对象不同, HttpResponse 是你需要在每个视图里实例化, 填充和返回的.

HttpResponse 类定义在 django.http 模块中.

用例¶

传递字符串¶

典型的用法是将页面内容以字符串的形式传递给 HttpResponse:

>>> from django.http import HttpResponse
>>> response = HttpResponse("Here's the text of the Web page.")
>>> response = HttpResponse("Text only, please.", content_type="text/plain")

如果想要添加内容, response 可以像文件对象那样:

>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the Web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")

传递迭代器¶

你也可以传递一个迭代器给 HttpResponse. HttpResponse 会立即消费这个迭代器, 然后将其内容储存为字符串. 如果对象带有 close() 方法, 例如文件或迭代器, 会立即关闭.

如果想以流的形式返回给客户端, 请使用 StreamingHttpResponse 类.

Changed in Django 1.10:

WSGI服务器响应时调用 close() 方法, 具有 close() 方法的对象将会被close.

设置首部字段¶

可以将它当做一个字典来设置或删除response首部字段:

>>> response = HttpResponse()
>>> response['Age'] = 120
>>> del response['Age']

注意与字典不同的是, del 删除不存在的字段时不会引发 KeyError 异常.

如果要设置 Cache-Control 和 Vary 首部字段, 建议使用 django.utils.cache 中的 patch_cache_control() 和 patch_vary_headers() 方法, 因为这两个字段是以逗号分隔的多个值. 而这些”patch”方法确保不会丢失其他值, 例如中间件添加的值.

HTTP首部字段不能包含换行. 如果尝试为首部字段设置包含换行符(CR或LF)的字符串会引发 BadHeaderError.

告诉浏览器将响应作为文件处理¶

要告诉浏览器将响应作为文件处理, 需要使用 content_type 参数并设置 Content-Disposition 首部. 例如, 以Microsoft Excel电子表格的形式响应:

>>> response = HttpResponse(my_data, content_type='application/vnd.ms-excel')
>>> response['Content-Disposition'] = 'attachment; filename="foo.xls"'

关于 Content-Disposition 首部没有Django相关的内容, 很容易忘记语法, 所以我们将其放在这里.

属性¶

HttpResponse.content¶: 表单内容的字节字符串, 必要时由Unicode编码.

HttpResponse.charset¶: 表示响应的编码的字符串. 如果 HttpResponse 在实例化时没有指定, 将从 content_type 中提取, 如果不成功将使用 DEFAULT_CHARSET 设置.

HttpResponse.status_code¶: 响应的 HTTP状态码.

Changed in Django 1.9:
除非明确设置了 reason_phrase , 否则在构造函数之外修改 status_code 的值也会修改 reason_phrase.

HttpResponse.reason_phrase¶: 响应的HTTP原因短语.

Changed in Django 1.9:
reason_phrase 不再默认为所有大写字母. 它现在使用 HTTP标准 默认原因短语.

除非显式设置, reason_phrase 由 status_code 值决定.

HttpResponse.streaming¶

此选项总为 False.

此属性的存在是为了让中间件能够将流式响应与常规响应区别对待.

HttpResponse.closed¶: 如果响应已关闭则为 True.

方法¶

HttpResponse.__init__(content='', content_type=None, status=200, reason=None, charset=None)¶

使用页面内容和内容类型来实例化一个 HttpResponse 对象.

content 应该是一个迭代器或字符串. 如果是迭代器, 它应该返回字符串, 然后这些字符串连接在一起形成响应的内容. 如果它不是迭代器或字符串, 将在访问时转换为字符串.

content_type 是可选地由字符集编码的MIME类型, 用于填充HTTP的 Content-Type 首部. 如果没有指定, 则由 DEFAULT_CONTENT_TYPE 和 DEFAULT_CHARSET 设置组成, 默认为: “text/html; charset=utf-8”.

status 是响应的 HTTP状态码.

reason 是HTTP响应短语. 如果没有指定则使用默认值.

charset 是响应的编码字符集. 如果没有设置, 将从 content_type 中提取, 如果不成功, 将使用 DEFAULT_CHARSET 配置.

HttpResponse.__setitem__(header, value)¶: 设置给定首部的值. header 和 value 都必须是字符串.

HttpResponse.__delitem__(header)¶: 删除给定名字的首部. 如果给定首部不存在不会引发异常. 大小写不敏感.

HttpResponse.__getitem__(header)¶: 返回给定名字的首部值. 大小写不敏感.

HttpResponse.has_header(header)¶: 检查首部是否包含给定的名字, 返回 True 或者 False. 大小写不敏感.

HttpResponse.setdefault(header, value)¶: 设置首部, 除非它已经存在.

HttpResponse.set_cookie(key, value='', max_age=None, expires=None, path='/', domain=None, secure=None, httponly=False)¶

设置Cookie. 参数与Python标准库 Morsel 中的cookie对象一样.

max_age 应为秒数, 如果cookie的持续时间与客户端浏览器会话的持续时间相同, 则为 None (默认值). 如果未指定 expires, 则会通过计算得到.
expires 必须是 "Wdy, DD-Mon-YY HH:MM:SS GMT" 格式的字符串或UTC下的 datetime.datetime 对象. 如果 expires 是 datetime 对象, 则会根据其计算 max_age.
如果要设置跨域cookie可以使用 domain 参数. 例如, domain=".lawrence.com" 将设置可被 www.lawrence.com, blogs.lawrence.com 和 calendars.lawrence.com等域读取的cookie. 否则只能被设置它的域读取.
设置 httponly=True 可以阻止客户端的JavaScript读取cookie.

HTTPOnly 是包含在Set-Cookie HTTP响应头的一个标志. 它不是 RFC 2109 中的cookie标准, 也没有被所有的浏览器支持. 但是, 在支持的情况下, 它是减轻客户端脚本访问受保护的cookie数据的风险的有用方式.

警告

RFC 2109 和 RFC 6265 都声明用户端应支持至少4096字节大小的cookie. 对于大多数浏览器这也是最大大小. 如果试图存储超过4096字节的cookie, Django不会引发异常, 但许多浏览器不会正确设置cookie.

HttpResponse.set_signed_cookie(key, value, salt='', max_age=None, expires=None, path='/', domain=None, secure=None, httponly=True)¶: 与 set_cookie() 类似, 但是会在设置前先将cookie 签名加密. 通常配合 HttpRequest.get_signed_cookie() 一起使用. 使用 salt 参数可以增加加密强度, 调用 HttpRequest.get_signed_cookie() 时也需要传入这个值.

HttpResponse.delete_cookie(key, path='/', domain=None)¶

删除给定键的cookie值. 键不存在时不会引发异常.

由于cookies的工作方式, 删除时 path 和 domain 值必须要和 set_cookie() 时的值相同 – 不然不会正常删除.

HttpResponse.write(content)¶: 该方法使 HttpResponse 实例可以像类似文件对象那样write操作(添加内容).

HttpResponse.flush()¶: 该方法使 HttpResponse 实例可以像类似文件对象那样flush操作(清空内容).

HttpResponse.tell()¶: 该方法使 HttpResponse 实例可以像类似文件对象那样tell操作(移动位置指针).

HttpResponse.getvalue()¶: 返回 HttpResponse.content 的值. 此方法使 HttpResponse 实例是成为一个类似流的对象.

HttpResponse.readable()¶: New in Django 1.10:
值始终为 False. 此方法使 HttpResponse 实例成为一个类似流的对象.

HttpResponse.seekable()¶: New in Django 1.10:
值始终为 False. 此方法使 HttpResponse 实例成为一个类似流的对象.

HttpResponse.writable()¶: 值始终为 True. 此方法使 HttpResponse 实例成为一个类似流的对象.

HttpResponse.writelines(lines)¶: 将一个包含行的列表写入响应. 不添加行的分隔. 此方法使 HttpResponse 实例成为一个类似流的对象.

`HttpResponse` 子类¶

Django包含了许多 HttpResponse 子类来处理不同的HTTP响应. 它们和 HttpResponse 一样位于 django.http 中.

class HttpResponseRedirect¶

构造函数的第一个参数 – 重定向的地址, 这是个必传参数. 它可以是完整的URL地址(例如. 'https://www.yahoo.com/search/'), 或者是不带域名的绝对地址(例如. '/search/'), 或者相对路径 (例如. 'search/'). 在相对路径的情况下, 客户端浏览器会根据当前路径构建完整的URL. 其他构造参数详见 HttpResponse. 注意该响应的HTTP状态码为302.

url¶: 只读属性, 表示将要重定向到的URL(相当于响应的 Location 首部).

class HttpResponsePermanentRedirect¶: 类似 HttpResponseRedirect, 区别是它返回的是永久重定向(HTTP状态码301), 而不是”found”重定向(HTTP状态码302).

class HttpResponseNotModified¶: 不需要构造参数, 也不需要为这个响应设置内容. 该响应用来表示自上次请求页面没有发生变化(HTTP状态码304).

class HttpResponseBadRequest¶: 状态码为400的 HttpResponse.

class HttpResponseNotFound¶: 状态码为404的 HttpResponse .

class HttpResponseForbidden¶: 状态码为403的 HttpResponse.

class HttpResponseNotAllowed¶: 状态码为405的 HttpResponse. 该构造函数的第一个参数为必传参数: 一个允许使用的方法组成的列表 (例如. ['GET', 'POST']).

class HttpResponseGone¶: 状态码为410的 HttpResponse.

class HttpResponseServerError¶: 状态码为500的 HttpResponse.

注解

如果自定义的 HttpResponse 子类实现了 render 方法, Django会将其视为 SimpleTemplateResponse, 且 render 必须返回一个有效的response对象.

`JsonResponse` 对象¶

class JsonResponse(data, encoder=DjangoJSONEncoder, safe=True, json_dumps_params=None, **kwargs)¶

一个用于创建JSON响应的 HttpResponse 子类. 它继承了父类的大部分行为, 但有以下不同点:

它默认的 Content-Type 首部为 application/json.

第一个参数 data 必须是一个 dict 实例. 如果 safe 参数设置为 False (见下文), 那么它可以是任何可以JSON序列化的对象.

encoder 参数默认为 django.core.serializers.json.DjangoJSONEncoder, 用于序列化data. 详见 JSON序列化.

布尔值参数 safe 默认为 True. 如果设置为 False, 则可以接收任何可序列化的对象 (否则仅支持 dict 实例). 如果 safe 设置为 True 且参入了一个非 dict 对象, 则会引发 TypeError 异常.

json_dumps_params 参数是一个关键字参数的字典, 用于在生成响应时传递给 json.dumps().

Changed in Django 1.9:

新增 json_dumps_params 参数.

用法¶

典型用法如下:

>>> from django.http import JsonResponse
>>> response = JsonResponse({'foo': 'bar'})
>>> response.content
b'{"foo": "bar"}'

序列化非字典对象¶

如果要序列化除 dict 之外的对象, 必须要将 safe 设置为 False:

>>> response = JsonResponse([1, 2, 3], safe=False)

不设置 safe=False 会引发 TypeError 异常.

警告

在第五版ECMAScript 之前, 有可能使JavaScript Array 构造函数中毒. 因此默认情况下, Django不允许将非dict对象传递给 JsonResponse 构造函数. 然而, 大多数现代浏览器都实现了ECMAScript 5, 它去除了这个攻击因素. 因此可以禁用此安全预防措施.

修改默认的JSON encoder¶

如果要使用其他的JSON encoder类, 可以使用 encoder 参数:

>>> response = JsonResponse(data, encoder=MyJSONEncoder)

`StreamingHttpResponse` 对象¶

class StreamingHttpResponse¶

StreamingHttpResponse 类用来从Django流式化一个响应到浏览器. 如果要生成的响应太长或者占用内存过多可以使用该类. 例如它对于生成超大CSV文件非常有用.

性能考量

Django是为了那些短时请求设计的. 流式响应将在整个响应期间绑定工作进程. 这可能导致性能不佳.

一般来说, 消耗较大的任务应该在请求-响应周期之外执行, 而不应依赖流式响应.

StreamingHttpResponse 不是 HttpResponse 的子类, 因为它的API略有不同. 除了以下几个显著差别其他几乎相同:

应该接收一个迭代器, 该迭代器返回响应内容的字符串.
除非通过迭代响应对象本身, 否则无法访问其内容. 只有当响应返回到客户端时, 才会发生这种情况.
它没有 content 属性. 取而代之的是 streaming_content 属性.
不可以使用类文件对象的 tell() 或者 write() 方法. 这会引发异常.

StreamingHttpResponse 只应在绝对要求在将数据传输到客户端之前不迭代整个内容的情况下使用. 由于内容无法访问, 许多中间件无法正常工作. 例如, 无法为流式响应生成 ETag 和 Content-Length 首部.

属性¶

StreamingHttpResponse.streaming_content¶: 内容字符串的迭代器.

StreamingHttpResponse.status_code¶: 响应的 HTTP状态码.

Changed in Django 1.9:
除非明确设置了 reason_phrase , 否则在构造函数之外修改 status_code 的值也会修改 reason_phrase.

StreamingHttpResponse.reason_phrase¶: 响应的HTTP原因短语.

Changed in Django 1.9:
reason_phrase 不再默认为所有大写字母. 它现在使用 HTTP标准 默认原因短语.

除非显式设置, reason_phrase 由 status_code 值决定.

StreamingHttpResponse.streaming¶: 始终为 True.

`FileResponse` 对象¶

class FileResponse¶

FileResponse 是 StreamingHttpResponse 的子类, 针对二进制文件做了优化. 如果wsgi服务器提供的话它使用 wsgi.file_wrapper, 否则它将文件以块的形式流式传输出去.

FileResponse 需要以二进制模式打开文件, 例如:

>>> from django.http import FileResponse
>>> response = FileResponse(open('myfile.png', 'rb'))

Django 1.10 文档

请求和响应对象¶

概述¶

`HttpRequest` 对象¶

属性¶

应用程序代码设置的属性¶

中间件设置的属性¶

方法¶

`QueryDict` 对象¶

方法¶

`HttpResponse` 对象¶

用例¶

传递字符串¶

传递迭代器¶

设置首部字段¶

告诉浏览器将响应作为文件处理¶

属性¶

方法¶

`HttpResponse` 子类¶

`JsonResponse` 对象¶

用法¶

序列化非字典对象¶

修改默认的JSON encoder¶

`StreamingHttpResponse` 对象¶

属性¶

`FileResponse` 对象¶

Table of Contents

上一个主题

下一个主题

本页

Last update:

Django 1.10 文档

请求和响应对象¶

概述¶

HttpRequest 对象¶

属性¶

应用程序代码设置的属性¶

中间件设置的属性¶

方法¶

QueryDict 对象¶

方法¶

HttpResponse 对象¶

用例¶

传递字符串¶

传递迭代器¶

设置首部字段¶

告诉浏览器将响应作为文件处理¶

属性¶

方法¶

HttpResponse 子类¶

JsonResponse 对象¶

用法¶

序列化非字典对象¶

修改默认的JSON encoder¶

StreamingHttpResponse 对象¶

属性¶

FileResponse 对象¶

Last update:

`HttpRequest` 对象¶

`QueryDict` 对象¶

`HttpResponse` 对象¶

`HttpResponse` 子类¶

`JsonResponse` 对象¶

`StreamingHttpResponse` 对象¶

`FileResponse` 对象¶