Django的HttpRequest和HttpResponse對象

請求一張頁面時，Django把請求的metadata數據包裝成一個HttpRequest對象，然後Django加載合適的view方法,把這個HttpRequest 對象作爲第一個參數傳給view方法。任何view方法都應該返回一個HttpResponse對象。

我們在本書中大量使用這兩個對象；本附錄詳細解釋HttpRequest和HttpResponse對象。

HttpRequest

HttpRequest代表一個來自uesr-agent的HTTP請求。

大多重要的請求信息都是作爲HttpRequest 對象的屬性出現(see Table H-1). 除了session外，其他所有屬性都是隻讀的。

Table H-1. HttpRequest對象的屬性

Attribute	Description
path	請求頁面的全路徑,不包括域名—例如, "/music/bands/the_beatles/"。
method	請求中使用的HTTP方法的字符串表示。全大寫表示。例如: if request.method == 'GET':     do_something() elif request.method == 'POST':     do_something_else()
GET	包含所有HTTP GET參數的類字典對象。參見QueryDict 文檔。
POST	包含所有HTTP POST參數的類字典對象。參見QueryDict 文檔。 服務器收到空的POST請求的情況也是有可能發生的。也就是說，表單form通過HTTP POST方法提交請求，但是表單中可以沒有數據。因此，不能使用語句if request.POST來判斷是否使用HTTP POST方法；應該使用if request.method == "POST" (參見本表的method屬性)。 注意: POST不包括file-upload信息。參見FILES屬性。
REQUEST	爲了方便，該屬性是POST和GET屬性的集合體，但是有特殊性，先查找POST屬性，然後再查找GET屬性。借鑑PHP’s $_REQUEST。 例如，如果GET = {"name": "john"} 和POST = {"age": '34'},則 REQUEST["name"] 的值是"john", REQUEST["age"]的值是"34". 強烈建議使用GET and POST,因爲這兩個屬性更加顯式化，寫出的代碼也更易理解。
COOKIES	包含所有cookies的標準Python字典對象。Keys和values都是字符串。參見第12章，有關於cookies更詳細的講解。
FILES	包含所有上傳文件的類字典對象。FILES中的每個Key都是<input type="file" name="" />標籤中name屬性的值. FILES中的每個value 同時也是一個標準Python字典對象，包含下面三個Keys: filename: 上傳文件名,用Python字符串表示 content-type: 上傳文件的Content type content: 上傳文件的原始內容 注意：只有在請求方法是POST，並且請求頁面中<form>有enctype="multipart/form-data"屬性時FILES才擁有數據。否則，FILES 是一個空字典。
META	包含所有可用HTTP頭部信息的字典。 例如: CONTENT_LENGTH CONTENT_TYPE QUERY_STRING: 未解析的原始查詢字符串 REMOTE_ADDR: 客戶端IP地址 REMOTE_HOST: 客戶端主機名 SERVER_NAME: 服務器主機名 SERVER_PORT: 服務器端口 META 中這些頭加上前綴HTTP_最爲Key, 例如: HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_HOST: 客戶發送的HTTP主機頭信息 HTTP_REFERER: referring頁 HTTP_USER_AGENT: 客戶端的user-agent字符串 HTTP_X_BENDER: X-Bender頭信息
user	是一個django.contrib.auth.models.User 對象，代表當前登錄的用戶。如果訪問用戶當前沒有登錄，user將被初始化爲django.contrib.auth.models.AnonymousUser的實例。你可以通過user的is_authenticated()方法來辨別用戶是否登錄： if request.user.is_authenticated():     # Do something for logged-in users. else:     # Do something for anonymous users. 只有激活Django中的AuthenticationMiddleware時該屬性纔可用 關於認證和用戶的更詳細講解,參見第12章。
session	唯一可讀寫的屬性，代表當前會話的字典對象。只有激活Django中的session支持時該屬性纔可用。 參見第12章。
raw_post_data	原始HTTP POST數據，未解析過。 高級處理時會有用處。

Request對象也有一些有用的方法,見Table H-2：

 

Table H-2. HttpRequest Methods
Method	Description
__getitem__(key)	返回GET/POST的鍵值,先取POST,後取GET。如果鍵不存在拋出 KeyError。 這是我們可以使用字典語法訪問HttpRequest對象。 例如,request["foo"]等同於先request.POST["foo"] 然後 request.GET["foo"]的操作。
has_key()	檢查request.GET or request.POST中是否包含參數指定的Key。
get_full_path()	返回包含查詢字符串的請求路徑。例如， "/music/bands/the_beatles/?print=true"
is_secure()	如果請求是安全的，返回True，就是說，發出的是HTTPS請求。

 

QueryDict對象

在HttpRequest對象中, GET和POST屬性是django.http.QueryDict類的實例。 QueryDict類似字典的自定義類，用來處理單鍵對應多值的情況。因爲一些HTML form元素，例如，<selectmultiple="multiple">, 就會傳多個值給單個鍵。

QueryDict對象是immutable(不可更改的),除非創建它們的copy()。這意味着我們不能直接改變request.POST and request.GET的屬性。

QueryDict實現所有標準的字典方法。還包括一些特有的方法，見Table H-3.

 

Table H-3. How QueryDicts Differ from Standard Dictionaries.
Method	Differences from Standard dict Implementation
__getitem__	和標準字典的處理有一點不同，就是，如果Key對應多個Value，__getitem__()返回最後一個value。
__setitem__	設置參數指定key的value列表(一個Python list)。注意：它只能在一個mutable QueryDict 對象上被調用(就是通過copy()產生的一個QueryDict對象的拷貝).
get()	如果key對應多個value，get()返回最後一個value。
update()	參數可以是QueryDict，也可以是標準字典。和標準字典的update方法不同，該方法添加字典 items，而不是替換它們: >>> q = QueryDict('a=1') >>> q = q.copy() # to make it mutable >>> q.update({'a': '2'}) >>> q.getlist('a')  ['1', '2'] >>> q['a'] # returns the last ['2']
items()	和標準字典的items()方法有一點不同,該方法使用單值邏輯的__getitem__(): >>> q = QueryDict('a=1&a=2&a=3') >>> q.items() [('a', '3')]
values()	和標準字典的values()方法有一點不同,該方法使用單值邏輯的__getitem__():

 

此外, QueryDict也有一些方法，見Table H-4.

 

H-4. 額外的 (非字典的) QueryDict 方法
Method	Description
copy()	返回對象的拷貝，內部實現是用Python標準庫的copy.deepcopy()。該拷貝是mutable(可更改的) — 就是說，可以更改該拷貝的值。
getlist(key)	返回和參數key對應的所有值，作爲一個Python list返回。如果key不存在，則返回空list。 It’s guaranteed to return a list of some sort..
setlist(key,list_)	設置key的值爲list_ (unlike __setitem__()).
appendlist(key,item)	添加item到和key關聯的內部list.
setlistdefault(key,list)	和setdefault有一點不同，它接受list而不是單個value作爲參數。
lists()	和items()有一點不同, 它會返回key的所有值，作爲一個list, 例如: >>> q = QueryDict('a=1&a=2&a=3') >>> q.lists() [('a', ['1', '2', '3'])]
urlencode()	返回一個以查詢字符串格式進行格式化後的字符串(e.g., "a=2&b=3&b=5").

 

A Complete Example

例如, 下面是一個HTML form:

<span style="font-size:12px;"><form action="/foo/bar/" method="post">
<input type="text" name="your_name" />
<select multiple="multiple" name="bands"> 
   <option value="beatles">The Beatles</option>
    <option value="who">The Who</option>
    <option value="zombies">The Zombies</option>
</select>
<input type="submit" />
</form></span>

如果用戶在your_name域中輸入"JohnSmith"，同時在多選框中選擇了“The Beatles”和“The Zombies”，下面是Django請求對象的內容:

<span style="font-size:12px;">>>> request.GET{}
>>> request.POST
{'your_name': ['John Smith'], 'bands': ['beatles', 'zombies']}
>>> request.POST['your_name']
'John Smith' 
>>> request.POST['bands']
'zombies'
>>> request.POST.getlist('bands')
['beatles', 'zombies']
>>> request.POST.get('your_name', 'Adrian')
'John Smith'
>>> request.POST.get('nonexistent_field', 'Nowhere Man')
'Nowhere Man'</span>

HttpResponse

對於HttpRequest 對象來說，是由Django自動創建, 但是，HttpResponse對象就必須我們自己創建。每個View方法必須返回一個HttpResponse對象。

HttpResponse類在django.http.HttpResponse。

構造HttpResponses

一般地, 你可以通過給HttpResponse的構造函數傳遞字符串表示的頁面內容來構造HttpResponse對象:

<span style="font-size:12px;">>>> response = HttpResponse("Here's the text of the Web page.")
>>> response = HttpResponse("Text only, please.", mimetype="text/plain")</span>

但是如果想要增量添加內容, 你可以把response當作filelike對象使用:

<span style="font-size:12px;">>>> response = HttpResponse()
>>> response.write("<p>Here's the text of the Web page.</p>")
>>> response.write("<p>Here's another paragraph.</p>")</span>

<span style="font-family: verdana, arial, helvetica, sans-serif; line-height: 15.6px; background-color: rgb(255, 255, 255);"><span style="font-size:12px;">也可以給HttpResponse傳遞一個iterator作爲參數，而不用傳遞硬編碼字符串。 如果你使用這種技術, 下面是需要注意的一些事項:</span></span>

·         iterator應該返回字符串.

·         如果HttpResponse使用iterator進行初始化，就不能把HttpResponse實例作爲filelike 對象使用。這樣做將會拋出異常。

最後，再說明一下，HttpResponse實現了write()方法, 可以在任何需要filelike對象的地方使用HttpResponse對象。參見第11章，有一些例子。

設置Headers

你可以使用字典語法添加，刪除headers:

<span style="font-size:12px;">>>> response = HttpResponse() 
>>> response['X-DJANGO'] = "It's the best."
>>> del response['X-PHP']
>>> response['X-DJANGO']
"It's the best."</span>

你也可以使用has_header(header)方法檢測某個header是否存在。

不要手動設置Cookie headers；具體的做法，參見第12章，有關於怎樣在Django中處理cookies的詳細講解。

HttpResponse子類

Django包含很多HttpResponse子類，用來處理不同的HTTP響應類型(見Table H-5). 和HttpResponse一樣, 這些子類在django.http中.

 

Table H-5. HttpResponse Subclasses
Class	Description
HttpResponseRedirect	構造函數接受單個參數：重定向到的URL。可以是全URL (e.g., 'http://search.yahoo.com/')或者相對URL(e.g., '/search/'). 注意：這將返回HTTP狀態碼302。
HttpResponsePermanentRedirect	同HttpResponseRedirect一樣，但是返回永久重定向(HTTP 狀態碼 301)。
HttpResponseNotModified	構造函數不需要參數。Use this to designate that a page hasn’t been modified since the user’s last request.
HttpResponseBadRequest	返回400 status code。
HttpResponseNotFound	返回404 status code.
HttpResponseForbidden	返回403 status code.
HttpResponseNotAllowed	返回405 status code. 它需要一個必須的參數：一個允許的方法的list (e.g., ['GET','POST']).
HttpResponseGone	返回410 status code.
HttpResponseServerError	返回500 status code.

 

當然，你也可以自己定義不包含在上表中的HttpResponse子類。

返回Errors

在Django中返回HTTP錯誤碼是很容易的。上面介紹了HttpResponseNotFound, HttpResponseForbidden, HttpResponseServerError等一些子類。View方法中返回這些子類的實例就OK了,例如:

<span style="font-size:12px;">def my_view(request):    
    #  ...   
    if foo:       
         return HttpResponseNotFound('<h1>Page not found</h1>')    
    else:        
         return HttpResponse('<h1>Page was found</h1>')</span>

當返回HttpResponseNotFound時,你需要定義錯誤頁面的HTML:

return HttpResponseNotFound('<h1>Page not found</h1>')

因爲404錯誤是最常使用的HTTP錯誤, 有一個更方便的方法處理它。

爲了方便，而且整個站點有一致的404錯誤頁面也是友好的,Django提供一個Http404異常類。如果在一個View方法中拋出Http404,Django將會捕獲它並且返回標準錯誤頁面,同時返回錯誤碼404。

<span style="font-size:12px;">from django.http import Http404

def detail(request, poll_id):    
    try:        
        p = Poll.objects.get(pk=poll_id)    
    except Poll.DoesNotExist:       
         raise Http404    
    return render_to_response('polls/detail.html', {'poll': p})</span>

爲了使用Http404異常, 你需要創建一個模板文件。當異常拋出時，就會顯示該模板文件。該模板文件的文件名是404.html,在模板根目錄下創建。

自定義404 (Not Found) View方法

當拋出Http404異常時, Django會加載一個特殊的view方法處理404錯誤。默認地, 它是django.views.defaults.page_not_found,負責加載和渲染404.html模板文件。

這意味着我們必須在模板根目錄定義404.html模板文件，該模板文件應用於所有的404異常。

該page_not_found view方法應該可以應對幾乎99%的Web App，但是如果想要重載該view方法時, 你可以在URLConf文件中指定handler404爲自定義的404 errpr view方法, 像這樣:

<span style="font-size:12px;">from django.conf.urls.defaults import *

urlpatterns = patterns('',    
    ...
)

handler404 = 'mysite.views.my_custom_404_view'</span>

Django就是通過在URLConf文件中查找handler404來決定404 view方法的。默認地, URLconfs包含下面一行代碼:

<span style="font-size:12px;">from django.conf.urls.defaults import *</span>

在 django/conf/urls/defaults.py模塊中, handler404賦值爲 'django.views.defaults.page_not_found'。

注意:

·         如果請求URL沒有和Django的URLConf文件中的任何一個正則表示式匹配，404 view方法就會被調用。

·         如果沒有定義自己的404 view — 使用默認地404 view，你仍然有一個工作要做：在模板根目錄創建404.html模板文件。默認地404 view將使用該模板處理所有404錯誤。

·         如果 DEBUG設置爲True (在setting模塊中)，404 view方法不會被使用，取而代之的是，traceback信息。

自定義500 (Server Error) View方法

同樣地，當view代碼發生運行時錯誤時，Django也會產生特殊行爲。如果view方法產生異常，Django將會調用默認地view方法django.views.defaults.server_error, 該方法加載渲染500.html模板文件。

這意味着我們必須在模板根目錄定義500.html模板文件，該模板文件應用於所有的服務器錯誤。

該server_error view方法應該可以應對幾乎99%的Web App，但是如果想要重載該view方法時, 你可以在URLConf文件中指定handler500爲自定義的server error view方法, 像這樣:

<span style="font-size:12px;">from django.conf.urls.defaults import *

   urlpatterns = patterns('',    

        ...

   ) 

   handler500 = 'mysite.views.my_custom_error_view'</span>

翻譯文章來源 (Django官網文檔)：https://docs.djangoproject.com/en/1.9/ref/request-response/#django.http.HttpRequest

其中進行了一些整理。