Django使用request和response對象

Django使用request和response對象html

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

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

HttpRequest服務器

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

大多重要的請求信息都是做爲HttpRequest 對象的屬性出現(see Table H-1). 除了session外,其餘全部屬性都是隻讀的。session

Table H-1. HttpRequest對象的屬性app

Attribute函數

Descriptionpost

paththis

請求頁面的全路徑,不包括域名—例如, "/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:

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

若是用戶在your_name域中輸入"JohnSmith",同時在多選框中選擇了「The Beatles」和「The Zombies」,下面是Django請求對象的內容:

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

HttpResponse

對於HttpRequest 對象來講,是由Django自動建立, 可是,HttpResponse對象就必須咱們本身建立。每一個View方法必須返回一個HttpResponse對象。

HttpResponse類在django.http.HttpResponse。

構造HttpResponses

通常地, 你能夠經過給HttpResponse的構造函數傳遞字符串表示的頁面內容來構造HttpResponse對象:

>>> response = HttpResponse("Here's the text of the Web page.")
>>> response = HttpResponse("Text only, please.", mimetype="text/plain")

可是若是想要增量添加內容, 你能夠把response看成filelike對象使用:

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

也能夠給HttpResponse傳遞一個iterator做爲參數,而不用傳遞硬編碼字符串。 若是你使用這種技術, 下面是須要注意的一些事項:

·         iterator應該返回字符串.

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

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

設置Headers

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

>>> response = HttpResponse() 
>>> response['X-DJANGO'] = "It's the best."
>>> del response['X-PHP']
>>> response['X-DJANGO']
"It's the best."

你也可使用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了,例如:

def my_view(request):    
    #  ...   
    if foo:       
         return HttpResponseNotFound('<h1>Page not found</h1>')    
    else:        
         return HttpResponse('<h1>Page was found</h1>')

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

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

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

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

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

爲了使用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方法, 像這樣:

from django.conf.urls.defaults import *

urlpatterns = patterns('',    
    ...
)

handler404 = 'mysite.views.my_custom_404_view'

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

from django.conf.urls.defaults import *

在 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方法, 像這樣:

from django.conf.urls.defaults import *

   urlpatterns = patterns('',    

        ...

   )

 

   handler500 = 'mysite.views.my_custom_error_view'

相關文章
相關標籤/搜索