HTTP 應用的信息是通過 請求報文 和 響應報文 傳遞的,關於更多的相關知識,可以閱讀《HTTP權威指南》獲得。 其中 請求報文 由客戶端發送,其中包含和許多的信息,而 django 將這些信息封裝成了 HttpRequest 對象,該對象由 HttpRequest 類創建。每一個請求都會生成一個 ...
HTTP 應用的信息是通過 請求報文 和 響應報文 傳遞的,關於更多的相關知識,可以閱讀《HTTP權威指南》獲得。
其中 請求報文 由客戶端發送,其中包含和許多的信息,而 django 將這些信息封裝成了 HttpRequest 對象,該對象由 HttpRequest 類創建。每一個請求都會生成一個 HttpRequest 對象,django會將這個對象自動傳遞給響應的視圖函數,一般視圖函數約定俗成地使用 request 參數承接這個對象。
例如:
def index(request): .... return ....
當然你也可以使用其他參數來承接這個對象,並沒有硬性規定一定要使用什麼名稱。
屬性:
django將請求報文中的請求行、首部信息、內容主體封裝成 HttpRequest 類中的屬性。除了特殊說明的之外,其他均為只讀的。
1.HttpRequest.scheme
一個字元串,代表請求的方案,一般為 ‘http’ 或 ‘https’。
2.HttpRequest.body
一個字元串,代表請求報文的主體。在處理非 HTTP 形式的報文時非常有用,例如:二進位圖片、XML等。
但是,如果要處理表單數據的時候,推薦還是使用 HttpRequest.POST 。
另外,我們還可以用 python 的類文件方法去操作它,詳情參考 HttpRequest.read() 。
3.HttpRequest.path
一個字元串,表示請求的路徑組件(不含功能變數名稱)。
例如:"/music/bands/the_beatles/"
4.HttpRequest.path_info
一個字元串,在某些 Web 伺服器配置下,主機名後的 URL 部分被分成腳本首碼部分和路徑信息部分。path_info 屬性將始終包含路徑信息部分,不論使用的Web 伺服器是什麼。使用它代替 path 可以讓代碼在測試和開發環境中更容易地切換。
例如,如果應用的WSGIScriptAlias 設置為"/minfo",那麼當 path 是"/minfo/music/bands/the_beatles/" 時path_info 將是"/music/bands/the_beatles/"。
5.HttpRequest.method
一個字元串,表示請求使用的HTTP 方法。必須使用大寫。
例如:"GET"、"POST"
6.HttpRequest.encoding
一個字元串,表示提交的數據的編碼方式(如果為 None 則表示使用 DEFAULT_CHARSET 的設置,預設為 'utf-8')。這個屬性是可寫的,你可以修改它來修改訪問表單數據使用的編碼。接下來對屬性的任何訪問(例如從 GET 或 POST 中讀取數據)將使用新的 encoding 值。如果你知道表單數據的編碼不是 DEFAULT_CHARSET ,則使用它。
7.HttpRequest.GET
一個類似於字典的對象,包含 HTTP GET 的所有參數。詳情請參考 QueryDict 對象。
8.HttpRequest.POST
一個類似於字典的對象,如果請求中包含表單數據,則將這些數據封裝成 QueryDict 對象。
POST 請求可以帶有空的 POST 字典 —— 如果通過 HTTP POST 方法發送一個表單,但是表單中沒有任何的數據,QueryDict 對象依然會被創建。因此,不應該使用 if request.POST 來檢查使用的是否是POST 方法;應該使用 if request.method == "POST"
另外:如果使用 POST 上傳文件的話,文件信息將包含在 FILES 屬性中。
9.HttpRequest.REQUEST
一個類似於字典的對象,它首先搜索POST,然後搜索GET,主要是為了方便。靈感來自於PHP 的 $_REQUEST。
例如,如果 GET = {"name": "john"} 而 POST = {"age": '34'} , REQUEST["name"] 將等於"john", REQUEST["age"] 將等於"34"。
強烈建議使用 GET 和 POST 而不要用REQUEST,因為它們更加明確。
10.HttpRequest.COOKIES
一個標準的Python 字典,包含所有的cookie。鍵和值都為字元串。
11.HttpRequest.FILES
一個類似於字典的對象,包含所有的上傳文件信息。FILES 中的每個鍵為<input type="file" name="" /> 中的name,值則為對應的數據。
註意,FILES 只有在請求的方法為POST 且提交的<form> 帶有enctype="multipart/form-data" 的情況下才會包含數據。否則,FILES 將為一個空的類似於字典的對象。
12.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 鍵。
13.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.
user 只有當Django 啟用 AuthenticationMiddleware 中間件時才可用。
-------------------------------------------------------------------------------------
匿名用戶
class models.AnonymousUser
django.contrib.auth.models.AnonymousUser 類實現了django.contrib.auth.models.User 介面,但具有下麵幾個不同點:
- id 永遠為None。
- username 永遠為空字元串。
- get_username() 永遠返回空字元串。
- is_staff 和 is_superuser 永遠為False。
- is_active 永遠為 False。
- groups 和 user_permissions 永遠為空。
- is_anonymous() 返回True 而不是False。
- is_authenticated() 返回False 而不是True。
- set_password()、check_password()、save() 和delete() 引發 NotImplementedError。
新增 AnonymousUser.get_username() 以更好地模擬 django.contrib.auth.models.User。
14.HttpRequest.session
一個既可讀又可寫的類似於字典的對象,表示當前的會話。只有當Django 啟用會話的支持時才可用。完整的細節參見會話的文檔。
15.HttpRequest.urlconf
不是由Django 自身定義的,但是如果其它代碼(例如,自定義的中間件類)設置了它,Django 就會讀取它。如果存在,它將用來作為當前的請求的Root URLconf,並覆蓋 ROOT_URLCONF 設置。
16.HttpRequest.resolver_match
一個 ResolverMatch 的實例,表示解析後的URL。這個屬性只有在 URL 解析方法之後才設置,這意味著它在所有的視圖中可以訪問,但是在 URL 解析發生之前執行的中間件方法中不可以訪問(比如process_request,但你可以使用 process_view 代替)。
方法:
1.HttpRequest.get_host()
根據從HTTP_X_FORWARDED_HOST(如果打開 USE_X_FORWARDED_HOST,預設為False)和 HTTP_HOST 頭部信息返回請求的原始主機。如果這兩個頭部沒有提供相應的值,則使用SERVER_NAME 和SERVER_PORT,在PEP 3333 中有詳細描述。
USE_X_FORWARDED_HOST:一個布爾值,用於指定是否優先使用 X-Forwarded-Host 首部,僅在代理設置了該首部的情況下,才可以被使用。
例如:"127.0.0.1:8000"
註意:當主機位於多個代理後面時,get_host() 方法將會失敗。除非使用中間件重寫代理的首部。
2.HttpRequest.get_full_path()
返回 path,如果可以將加上查詢字元串。
例如:"/music/bands/the_beatles/?print=true"
3.HttpRequest.build_absolute_uri(location)
返回location 的絕對URI。如果location 沒有提供,則使用request.get_full_path()的返回值。
如果URI 已經是一個絕對的URI,將不會修改。否則,使用請求中的伺服器相關的變數構建絕對URI。
例如:"http://example.com/music/bands/the_beatles/?print=true"
4.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 秒。
>>> request.get_signed_cookie('name') 'Tony' >>> request.get_signed_cookie('name', salt='name-salt') 'Tony' # 假設在設置cookie的時候使用的是相同的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
5.HttpRequest.is_secure()
如果請求時是安全的,則返回True;即請求通是過 HTTPS 發起的。
6.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') 裝飾你的視圖以讓響應能夠正確地緩存。
7.HttpRequest.read(size=None)
像文件一樣讀取請求報文的內容主體,同樣的,還有以下方法可用。
HttpRequest.readline()
HttpRequest.readlines()
HttpRequest.xreadlines()
其行為和文件操作中的一樣。
HttpRequest.__iter__():說明可以使用 for 的方式迭代文件的每一行。