HttpRequest对象

阅读: 62397 评论：5

每当一个用户请求发送过来，Django将HTTP数据包中的相关内容，打包成为一个HttpRequest对象，并传递给视图函数作为第一位置参数，也就是request，供我们调用。

HttpRequest对象中包含了非常多的重要信息和元数据，应该熟练掌握它。

所有的请求和响应对象都位于django.http模块内。

一、HttpRequest内置的属性

HttpRequest对象的大部分属性都是只读的。

1. scheme

字符串类型，表示请求的协议种类，'http'或'https'。

2. body

bytes类型，表示原始HTTP请求的正文。它对于处理非HTML形式的数据非常有用：二进制图像、XML等。如果要处理常规的表单数据，应该使用HttpRequest.POST。

还可以使用类似读写文件的方式从HttpRequest中读取数据，参见HttpRequest.read()。

3. path

字符串类型，表示当前请求页面的完整路径，但是不包括协议名和域名。例如："/music/bands/the_beatles/"。

这个属性，常被用于我们进行某项操作时，如果不通过，返回用户先前浏览的页面。非常有用！

4. path_info

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

例如，如果ScriptAlias设置为/minfo，那么HttpRequest.path等于/music/bands/the_beatles/ ，而HttpRequest.path_info为/minfo/music/bands/the_beatles/。

5. method

字符串类型，表示请求使用的HTTP方法。默认为大写。像这样：

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

通过这个属性来判断请求的方法，然后根据请求的方法不同，在视图中执行不同的代码。

6. encoding

字符串类型，表示提交的数据的编码方式（如果为None 则表示使用DEFAULT_CHARSET设置）。这个属性是可写的，可以通过修改它来改变表单数据的编码。任何随后的属性访问（例如GET或POST）将使用新的编码方式。

7. content_type

表示从CONTENT_TYPE头解析的请求的MIME类型。

8. content_params

包含在CONTENT_TYPE标题中的键/值参数字典。

9. GET

一个类似于字典的QueryDict对象，包含GET请求中的所有参数，也就是类似http://example.com/?name=jack&age=18之中的name=jack和age=18。详情参考QueryDict文档。

10. POST

包含所有POST表单数据的QueryDict键值对字典。如果需要访问请求中的原始或非表单数据，可以使用HttpRequest.body属性。

注意：请使用if request.method == "POST"来判断一个请求是否POST类型，而不要使用if request.POST。

POST中不包含上传文件的数据。

11. COOKIES

包含所有Cookie信息的字典。键和值都为字符串。可以使用类似字典的方式，在cookie中读写数据，但是注意cookie是不安全的，因此，不要写敏感重要的信息。

12. FILES

一个类似于字典的MultiValueDict对象，包含所有上传的文件数据。 FILES中的每个键为<input type="file" name="xxx" />中的name属性值，每个值都是一个UploadedFile对象。

要在Django中实现文件上传，就要靠这个属性！

如果请求方法是POST且请求的<form>中带有enctype="multipart/form-data"属性，那么HttpRequest.FILES将包含上传的文件的数据。否则，FILES将为一个空的类似于字典的对象，属于被忽略、无用的情形。

13. META

包含所有HTTP头部信息的字典。可用的头部信息取决于客户端和服务器，下面是一些示例：

CONTENT_LENGTH —— 请求正文的长度（以字符串计）。
CONTENT_TYPE —— 请求正文的MIME类型。
HTTP_ACCEPT —— 可接收的响应Content-Type。
HTTP_ACCEPT_ENCODING —— 可接收的响应编码类型。
HTTP_ACCEPT_LANGUAGE —— 可接收的响应语言种类。
HTTP_HOST —— 客服端发送的Host头部。
HTTP_REFERER —— Referring页面。
HTTP_USER_AGENT —— 客户端的user-agent字符串。
QUERY_STRING —— 查询字符串。
REMOTE_ADDR —— 客户端的IP地址。想要获取客户端的ip信息，就在这里！
REMOTE_HOST —— 客户端的主机名。
REMOTE_USER —— 服务器认证后的用户，如果可用。
REQUEST_METHOD —— 表示请求方法的字符串，例如"GET" 或"POST"。
SERVER_NAME —— 服务器的主机名。
SERVER_PORT —— 服务器的端口（字符串）。

以上只是比较重要和常用的，还有很多未列出。

从上面可以看到，除CONTENT_LENGTH和CONTENT_TYPE之外，请求中的任何HTTP头部键转换为META键时，都会将所有字母大写并将连接符替换为下划线最后加上HTTP_前缀。所以，一个叫做X-Bender的头部将转换成META中的HTTP_X_BENDER键。

13.headers

一个不区分大小写、类似dict的对象，包含请求中HTTP头部的所有信息。

你在访问的时候，可以不区分大小写。

>>> request.headers
{'User-Agent': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6', ...}

>>> 'User-Agent' in request.headers
True
>>> 'user-agent' in request.headers
True

>>> request.headers['User-Agent']
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)
>>> request.headers['user-agent']
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)

>>> request.headers.get('User-Agent')
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)
>>> request.headers.get('user-agent')
Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_6)

在模板系统中，可以通过下面的方式访问：

{{ request.headers.user_agent }}

14. resolver_match

对请求中的URL进行解析，获取一些相关的信息，比如namespace。

ResolverMatch(func=app.views.print_request, args=(), kwargs={}, url_name=None, app_names=[], namespaces=[], route=app/print/)

在视图中通过request.resolver_match.namespace的方式访问。

二、app带来的属性

下面的属性是app带来的：

1. current_app

当前app的namespace。url模板标签将使用它的值作为reverse()方法的current_app参数。

2. urlconf

设置当前请求的根URLconf，用于指定不同的url路由进入口，这将覆盖settings中的ROOT_URLCONF设置。

将它的值修改为None，可以恢复使用ROOT_URLCONF设置。

3. exception_reporter_filter

用于替代当前请求的 DEFAULT_EXCEPTION_REPORTER_FILTER 。

4.exception_reporter_class

用于替代当前请求的DEFAULT_EXCEPTION_REPORTER。

三、中间件带来的属性

Django的contrib应用中包含的一些中间件会在请求上设置额外的属性。

1. session

来自SessionMiddleware中间件：一个可读写的，类似字典的对象，表示当前会话。我们要保存用户状态，会话过程等等，靠的就是这个中间件和这个属性。

2. site

来自CurrentSiteMiddleware中间件：get_current_site()方法返回的Site或RequestSite的实例，代表当前站点是哪个。

Django是支持多站点的，如果你同时上线了几个站点，就需要为每个站点设置一个站点id。

3. user

来自AuthenticationMiddleware中间件：表示当前登录的用户的AUTH_USER_MODEL的实例，这个模型是Django内置的Auth模块下的User模型。如果用户当前未登录，则user将被设置为AnonymousUser的实例。

可以使用is_authenticated方法判断当前用户是否合法用户，如下所示：

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

四、HttpRequest包含的方法

除了较多的属性，HttpRequest本身还有一些可调用的方法。

1. auser()

Django5.0版本新增。上面user属性的异步方法版本，用于异步视图上下文。

2. get_host()

根据HTTP_X_FORWARDED_HOST和HTTP_HOST头部信息获取请求的原始主机。如果这两个头部没有提供相应的值，则使用SERVER_NAME和SERVER_PORT。

例如："127.0.0.1:8000"

注：当主机位于多个代理的后面，get_host()方法将会失败。解决办法之一是使用中间件重写代理的头部，如下面的例子：

class MultipleProxyMiddleware:
    FORWARDED_FOR_FIELDS = [
        "HTTP_X_FORWARDED_FOR",
        "HTTP_X_FORWARDED_HOST",
        "HTTP_X_FORWARDED_SERVER",
    ]

    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(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()
        return self.get_response(request)

3. get_port()

使用META中HTTP_X_FORWARDED_PORT和SERVER_PORT的信息返回请求的始发端口。

4. get_full_path()

返回包含完整参数列表的HttpRequest.path。例如：/music/bands/the_beatles/?print=true

5. get_full_path_info()

像 get_full_path() 一样，但使用 HttpRequest.path_info 代替 HttpRequest.path。

例如："/minfo/music/bands/the_beatles/?print=true"

6. build_absolute_uri(location)

返回location的绝对URI形式。如果location没有提供，则使用request.get_full_path()的值。

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

注：不鼓励在同一站点混合部署HTTP和HTTPS，如果需要将用户重定向到HTTPS，最好使用Web服务器将所有HTTP流量重定向到HTTPS。

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

从已签名的Cookie中获取值，如果签名不合法则返回django.core.signing.BadSignature。

可选参数salt用来为密码加盐，提高安全系数。 max_age参数用于检查Cookie对应的时间戳是否超时。

范例：

>>> 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

8. is_secure()

如果使用的是Https，则返回True，表示连接是安全的。

9. accepts(mime_type)

如果请求头部接收的类型匹配mime_type参数，则返回True，否则返回False：

>>> request.accepts('text/html')
True

大多数浏览器默认的头部Accept设置是：Accept: */*，也就是说使用上面的accepts方法进行测试基本都会返回True。

10. HttpRequest.read(size=None)

11. HttpRequest.readline()

12. HttpRequest.readlines()

13. `HttpRequest.iter()`

上面的几个方法都是从HttpRequest实例读取文件数据的方法。

可以将HttpRequest实例直接传递到XML解析器，例如ElementTree：

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

异步视图 QueryDict对象

评论总数： 5

点击登录后方可评论

这里就是典型的上下文（context）吧，django把原生http中的Request封装了一下，得到了更多的请求上下文信息。

By 杀死庸碌的情怀1 On 2022年3月4日 17:27 回复

刘老师，那个path和path_info的例子是不是写反了，path_info不是路径部分吗？

By 尴尬村村长 On 2019年8月28日 09:29 回复

内容太概括抽象了。只好先通读几遍，有个大概印象。

By Zzz321A On 2019年4月9日 09:36 回复

HttpRequest.META['REMOTE_ADDR']获取的并不是真实的客户机IP！比如本地获取的是“127.0.0.1”，而不是真正的IPv4中的IP。那么，如何获取真实的客户端IP呢？

By 蔷薇-Nina On 2018年9月9日 19:49 回复

1.需要准备远程机测试才准确； 2.需要考虑是否部署了Nginx代理。

蔷薇-Nina 回复蔷薇-Nina 2018年9月9日 21:52 回复