當請求一個頁面時,Django 會建立一個包含請求元數據的 HttpRequest 對象。 當 Django 加載對應的視圖時,HttpRequest 對象將作為視圖函數的第一個參數(即:request)。每個視圖會返回一個 HttpResponse 對象。
屬性
- HttpRequest.scheme
一個字符串,表示請求的方案(通常是 http 或 https)。
- HttpRequest.body
一個字節字符串,表示原始 HTTP 請求的正文。
- HttpRequest.path
一個字符串,表示請求的頁面的完整路徑,不包含域名。
例如:"/music/bands/the_beatles/"
- HttpRequest.path_info
在某些 Web 服務器配置下,主機名后的 URL 部分被分成腳本前綴部分和路徑信息部分。path_info 屬性將始終包含路徑信息部分,不論使用的 Web 服務器是什么。使用它代替 path 可以讓代碼在測試和開發環境中更容易地切換。
- HttpRequest.method
一個字符串,表示請求使用的 HTTP 方法。必須使用大寫。例如:
if request.method == 'GET':
do_something()
elif request.method == 'POST':
do_something_else()
- HttpRequest.encoding
一個字符串,表示提交的數據的編碼方式(如果為 None 則表示使用 DEFAULT_CHARSET 設置)。你可以通過修改它來修改訪問表單數據使用的編碼。
- HttpRequest.GET
一個類似于字典的對象,包含 HTTP GET 的所有參數
- HttpRequest.POST
一個類似于字典的對象,包含所有給定的 HTTP POST參數,提供了包含表單數據的請求。
- HttpRequest.COOKIES
一個標準的 Python 字典,包含所有的 cookie。鍵和值都為字符串。
- HttpRequest.FILES
一個類似于字典的對象,包含所有的上傳文件。FILES 中的每個鍵為 <input type="file" name="" /> 中的 name。
- HttpRequest.META
一個標準的 Python 字典,包含所有的 HTTP 頭部。具體的頭部信息取決于客戶端和服務器,下面是一些示例:
- CONTENT_LENGTH —— 請求的正文的長度(是一個字符串)。
- CONTENT_TYPE —— 請求的正文的MIME 類型。
- HTTP_ACCEPT —— 響應可接收的Content-Type。
- HTTP_ACCEPT_ENCODING —— 響應可接收的編碼。
- HTTP_ACCEPT_LANGUAGE —— 響應可接收的語言。
- HTTP_HOST —— 客服端發送的HTTP Host 頭部。
- HTTP_REFERER —— Referring 頁面。
- HTTP_USER_AGENT —— 客戶端的user-agent 字符串。
- QUERY_STRING —— 單個字符串形式的查詢字符串(未解析過的形式)。
- REMOTE_ADDR —— 客戶端的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 鍵。
- HttpRequest.user
一個 AUTH_USER_MODEL 類型的對象,表示當前登錄的用戶。如果用戶當前沒有登錄,user 將設置為 django.contrib.auth.models.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 頭部信息返回請求的原始主機。如果這兩個頭部沒有提供相應的值,則使用 SERVER_NAME 和 SERVER_PORT,在 PEP 3333 中有詳細描述。
例如:"127.0.0.1:8000"
- HttpRequest.get_full_path()
返回 path,如果可以將加上查詢字符串。
例如:"/music/bands/the_beatles/?print=true"
- HttpRequest.build_absolute_uri(location)
返回 location 的絕對 URI。如果 location 沒有提供,則設置為 request.get_full_path()。
如果 URI 已經是一個絕對的URI,將不會修改。否則,使用請求中的服務器相關的變量構建絕對URI。
例如:"http://example.com/music/bands/the_beatles/?print=true"
- HttpRequest.get_signed_cookie(key, default=RAISE_ERROR, salt='', max_age=None)
返回簽名過的 Cookie 對應的值,如果簽名不再合法則返回 django.core.signing.BadSignature。如果提供 default 參數,將不會引發異常并返回 default 的值。
可選參數 salt 可以用來對安全密鑰強力攻擊提供額外的保護。max_age 參數用于檢查 Cookie 對應的時間戳以確保 Cookie 的時間不會超過 max_age 秒。
- HttpRequest.is_secure()
如果請求時是安全的,則返回 True;即請求是通過 HTTPS 發起的。
- HttpRequest.is_ajax()
如果請求是通過 XMLHttpRequest 發起的,則返回 True,方法是檢查 HTTP_X_REQUESTED_WITH 頭部是否是字符串 'XMLHttpRequest'。大部分現代的 JavaScript 庫都會發送這個頭部。如果你編寫自己的 XMLHttpRequest 調用(在瀏覽器端),你必須手工設置這個值來讓 is_ajax() 可以工作。
如果一個響應需要根據請求是否是通過 AJAX 發起的,并且你正在使用某種形式的緩存例如 Django 的 cache middleware, 你應該使用 vary_on_headers('HTTP_X_REQUESTED_WITH') 裝飾你的視圖以讓響應能夠正確地緩存。
- HttpRequest.read(size=None)
- HttpRequest.readline()
- HttpRequest.readlines()
- HttpRequest.xreadlines()
- HttpRequest.__iter__()
這幾個方法實現類文件的接口用于讀取 HttpRequest 實例。這使得可以用流的方式讀取進來的請求。一個常見的用例是使用迭代解析器處理大型 XML 有效載荷,而不在內存中構造一個完整的 XML 樹。