一、使用方法
1.傳遞一個字符串
最簡單的方式是傳遞一個字符串作為頁面的內容到HttpResponse構造函數,並返回給用戶:
from django.http import HttpResponse response = HttpResponse("Here's the text of the Web page.") response = HttpResponse("Text only,please.",content_type="text/plain")
可以將response看做一個類文件對象,使用write()方法不斷地往里面添加內容。
response = HttpResponse() response.write("<p>Here's the text of the Web page.</p>") response.write("<p>Here's another paragraph.</p>")
2.傳遞可迭代對象
HttpResponse會立即處理這個迭代器,並把它的內容存成字符串,最后廢棄這個迭代器。比如文件在讀取后,會立刻調用close()方法,關閉文件。
3.設置頭部字段
可以把HttpResponse對象當作一個字典一樣,在其中增加和刪除頭部字段。
response = HttpResponse() response['Age'] = 120 del response['Age']
注意!與字典不同的是,若要刪除的頭部字段不存在,del不會拋出KeyError異常。
HTTP的頭部字段中不能包含換行。所以如果我們提供的頭部字段值包含換行符(CR或者LF),將會拋出BadHeaderError異常。
4.告訴瀏覽器將響應視為文件附件
讓瀏覽器以文件附件的形式處理響應,需要聲明content_type
類型和設置Content-Disposition
頭信息。 例如,給瀏覽器返回一個微軟電子表格:
response = HttpResponse(my_data, content_type='application/vnd.ms-excel') response['Content-Disposition'] = 'attachment; filename="foo.xls"'
二、屬性
1.HttpResponse.content
響應的內容。bytes類型。
2.HttpResponse.charset
編碼的字符集。 如果沒指定,將會從content_type
中解析出來。
3.HttpResponse.status_code
響應的狀態碼,比如200。
4.HttpResponse.reason_phrase
響應的HTTP原因短語。 使用標准原因短語。除非明確設置,否則reason_phrase
由status_code
的值決定。
5.HttpResponse.streaming
這個屬性的值總是False。由於這個屬性的存在,使得中間件能夠區別對待流式響應和常規響應。
6.HttpResponse.closed
如果響應已關閉,那么這個屬性的值為True。
三、方法
1.HttpResponse.init(content='', content_type=None, status=200, reason=None, charset=None)[source]
響應的實例化方法。使用content參數和content-type
實例化一個HttpResponse對象。
content應該是一個迭代器或者字符串。如果是迭代器,這個迭代期返回的應是一串字符串,並且這些字符串連接起來形成response的內容。 如果不是迭代器或者字符串,那么在其被接收的時候將轉換成字符串。
content_type
是可選地,用於填充HTTP的Content-Type
頭部。如果未指定,默認情況下由DEFAULT_CONTENT_TYPE
和DEFAULT_CHARSET
設置組成:text/html; charset=utf-8
。
status是響應的狀態碼。reason是HTTP響應短語。charset是編碼方式。
2.HttpResponse.has_header(header)
檢查頭部中是否有給定的名稱(不區分大小寫),返回True或 False。
3.HttpResponse.setdefault(header, value)
設置一個頭部,除非該頭部已經設置過了。
4.HttpResponse.set_cookie(key, value='', max_age=None, expires=None, path='/', domain=None, secure=None, httponly=False)
設置一個Cookie。 參數與Python標准庫中的Morsel.Cookie對象相同。
max_age: 生存周期,以秒為單位。
expires:到期時間。
domain: 用於設置跨域的Cookie。例如domain=".lawrence.com"
將設置一個www.lawrence.com
、blogs.lawrence.com
和calendars.lawrence.com
都可讀的Cookie。 否則,Cookie將只能被設置它的域讀取。
如果你想阻止客服端的JavaScript訪問Cookie,可以設置httponly=True。
5. HttpResponse.set_signed_cookie(key, value, salt='', max_age=None, expires=None, path='/', domain=None, secure=None, httponly=True)
與set_cookie()
類似,但是在設置之前將對cookie進行加密簽名。通常與HttpRequest.get_signed_cookie()
一起使用。
6.HttpResponse.delete_cookie(key, path='/', domain=None)
刪除Cookie中指定的key。由於Cookie的工作方式,path和domain應該與set_cookie()
中使用的值相同,否則Cookie不會刪掉。
7.HttpResponse.write(content)[source]
將HttpResponse實例看作類似文件的對象,往里面添加內容。
8.HttpResponse.flush()
清空HttpResponse實例的內容。
9.HttpResponse.tell()[source]
將HttpResponse實例看作類似文件的對象,移動位置指針。
10.HttpResponse.getvalue()[source]
返回HttpResponse.content的值。 此方法將HttpResponse實例看作是一個類似流的對象。
11.HttpResponse.writelines(lines)[source]
將一個包含行的列表寫入響應對象中。 不添加分行符。
四、HttpResponse的子類
Django包含了一系列的HttpResponse衍生類(子類),用來處理不同類型的HTTP響應。與HttpResponse相同, 這些衍生類存在於django.http之中。
·class HttpResponseRedirect[source]:重定向,返回302狀態碼。已經被redirect()替代。
·class HttpResponsePermanentRedirect[source]:永久重定向,返回301狀態碼。
·class HttpResponseNotModified[source]:未修改頁面,返回304狀態碼。
·class HttpResponseBadRequest[source]:錯誤的請求,返回400狀態碼。
·class HttpResponseNotFound[source]:頁面不存在,返回404狀態碼。
·class HttpResponseForbidden[source]:禁止訪問,返回403狀態碼。
·class HttpResponseNotAllowed[source]:禁止訪問,返回405狀態碼。
·class HttpResponseGone[source]:過期,返回405狀態碼。
·class HttpResponseServerError[source]:服務器錯誤,返回500狀態碼。
五、JsonResponse類
class JsonResponse(data,encoder = DjangoJSONEncoder,safe = True,json_dumps_params = None ,** kwargs)[source]
JsonResponse是HttpResponse的一個子類,是Django提供的用於創建JSON編碼類型響應的快捷類。
它從父類繼承大部分行為,並具有以下不同點:
它的默認Content-Type頭部設置為application/json。
它的第一個參數data,通常應該為一個字典數據類型。 如果safe參數設置為False,則可以是任何可JSON 序列化的對象。
encoder默認為django.core.serializers.json.DjangoJSONEncoder
,用於序列化數據。
布爾類型參數safe默認為True。 如果設置為False,可以傳遞任何對象進行序列化(否則,只允許dict 實例)。
典型的用法如下:
from django.http import JsonResponse response = JsonResponse({'foo': 'bar'}) response.content
若要序列化非dict對象,必須設置safe參數為False:
response = JsonResponse([1, 2, 3], safe=False)
如果不傳遞safe=False,將拋出一個TypeError。
如果你需要使用不同的JSON 編碼器類,可以傳遞encoder參數給構造函數:
response = JsonResponse(data, encoder=MyJSONEncoder)
六、StreamingHttpResponse類
StreamingHttpResponse類被用來從Django響應一個流式對象到瀏覽器。如果生成的響應太長或者是占用的內存較大,這么做可能更有效率。 例如,它對於生成大型的CSV文件非常有用。
StreamingHttpResponse不是HttpResponse的衍生類(子類),因為它實現了完全不同的應用程序接口。但是,除了幾個明顯不同的地方,兩者幾乎完全相同。
七、FileResponse
文件類型響應。通常用於給瀏覽器返回一個文件附件。
FileResponse是StreamingHttpResponse的衍生類,為二進制文件專門做了優化。
FileResponse需要通過二進制模式打開文件,如下:
from django.http import FileResponse response = FileResponse(open('myfile.png', 'rb'))