Django請求和響應(yīng)對象

Django 使用請求和響應(yīng)對象在系統(tǒng)中傳遞狀態(tài)。

當(dāng)一個頁面被請求時，Django 會創(chuàng)建一個 HttpRequest 對象，這個對象包含了請求的元數(shù)據(jù)。然后，Django 加載相應(yīng)的視圖，將 HttpRequest 作為視圖函數(shù)的第一個參數(shù)。每個視圖負(fù)責(zé)返回一個 HttpResponse 對象。

HttpRequest對象

下面介紹HttpRequest對象常用的屬性和方法。

HttpRequest常用屬性

1.HttpRequest.body

原始的 HTTP 請求體作為一個字節(jié)字符串。這對于以不同方式處理非常規(guī) HTML 表單的數(shù)據(jù)很有用：二進(jìn)制圖像，XML 有效負(fù)載等。對于處理傳統(tǒng)的表單數(shù)據(jù)，使用 HttpRequest.POST

2.HttpRequest.method

代表請求中使用的 HTTP 方法的字符串，一定是大寫字母。

3.HttpRequest.GET

一個類似字典的對象，包含所有給定的 HTTP GET 參數(shù)。

4.HttpRequest.POST

一個類似字典的對象，包含所有給定的 HTTP POST 參數(shù)，前提是請求包含表單數(shù)據(jù)。如果你需要訪問請求中發(fā)布的原始或非表單數(shù)據(jù)，可以通過 HttpRequest.body 屬性來訪問。

以上的4個屬性是我們最常用的HttpRequest屬性。結(jié)合實際，我們可能寫出的代碼如下：

if request.method == "POST":        # POST請求方法
    try:
        data = json.loads(request.body)     # 獲取POST請求攜帶的非表單數(shù)據(jù)（JSON數(shù)據(jù)）
    except json.JSONDecodeError:
        return JsonResponse({"status": "1", "msg": "數(shù)據(jù)格式錯誤"})
    # 表單數(shù)據(jù)
    # keys = request.POST.get("keys")       # 如果POST攜帶的是表單數(shù)據(jù)，可以這樣獲取。
elif request.method == "GET":
    keys = request.GET.get("keys")      # 獲取get請求攜帶的參數(shù)
    return JsonResponse({"status": "0", "msg": "請求成功"})
else:
    return JsonResponse({"status": "0", "msg": "請求方法錯誤"})

5.HttpRequest.COOKIES

一個包含所有 cookies 的字典。鍵和值是字符串。

6.HttpRequest.FILES

一個類似字典的對象，包含所有上傳的文件。FILES 中的每個鍵是<input type="file" name=""> 中的 name。FILES 中的每個值是一個 UploadedFile。

FILES 只有在請求方法是 POST，并且發(fā)布請求的<form>有 enctype=“multipart/form-data” 的情況下，才會包含數(shù)據(jù)。否則，F(xiàn)ILES 將是一個類似字典的空白對象。

7.HttpRequest.META

一個包含所有可用的 HTTP 頭文件的字典?？捎玫念^信息取決于客戶端和服務(wù)器。一些可能的例子如下：

1.CONTENT_LENGTH —— 請求體的長度（字符串）。

2.CONTENT_TYPE —— 請求體的 MIME 類型。

3.HTTP_ACCEPT —— 可接受的響應(yīng)內(nèi)容類型。

4.HTTP_ACCEPT_ENCODING —— 可接受的響應(yīng)編碼。

5.HTTP_ACCEPT_LANGUAGE —— 可接受的響應(yīng)語言。

6.HTTP_HOST —— 客戶端發(fā)送的 HTTP 主機(jī)頭。

7.HTTP_REFERER —— referrer 頁面，如果有的話。

8.HTTP_USER_AGENT —— 客戶端的用戶代理字符串。

9.QUERY_STRING —— 查詢字符串，是一個單一的（未解析的）字符串。

10.REMOTE_ADDR —— 客戶機(jī)的 IP 地址。

11.REMOTE_HOST —— 客戶機(jī)的主機(jī)名。

12.REMOTE_USER —— Web 服務(wù)器認(rèn)證的用戶，如果有的話。

13.REQUEST_METHOD —— “GET” 或 “POST” 等字符串。

14.SERVER_NAME —— 服務(wù)器的主機(jī)名。

15.SERVER_PORT —— 服務(wù)器的端口（字符串）。

請求中的任何 HTTP 頭都會被轉(zhuǎn)換為 META 鍵，方法是將所有字符轉(zhuǎn)換為大寫字母，用下劃線代替任何連字符，并在名稱前加上 HTTP_` 前綴。例如，請求頭里的X-CSRFToken在META中變?yōu)镠TTP_X_CSRFTOKEN.

中間件設(shè)置的屬性

Django 的 contrib 應(yīng)用中包含的一些中間件會在請求中設(shè)置屬性。

1.HttpRequest.session

來自 SessionMiddleware。一個可讀可寫的，類似字典的對象，代表當(dāng)前會話。

2.HttpRequest.user

從 AuthenticationMiddleware。AUTH_USER_MODEL 的一個實例，代表當(dāng)前登錄的用戶。如果用戶當(dāng)前沒有登錄，user 將被設(shè)置為一個 AnonymousUser 的實例。你可以用 is_authenticated 來區(qū)分它們，例如：

if request.user.is_authenticated:
    ... # Do something for logged-in users.
else:
    ... # Do something for anonymous users.

如果使用Nginx+uWsgi的方式部署Django項目，那么META中的REMOTE_ADDR，REMOTE_HOST等不正確的，因為通過Nginx代理轉(zhuǎn)發(fā)到uWsgi監(jiān)聽的端口，這時候應(yīng)用程序獲取的客戶端信息就是127.0.0.1的本機(jī)信息，而不是真實客戶端的信息。因此，需要在Nginx中添加如下參數(shù)：

uwsgi_param  Host $host;
uwsgi_param  X-Real-IP $remote_addr;
uwsgi_param  X-Forwarded-For $proxy_add_x_forwarded_for;
uwsgi_param  X-Forwarded-Proto $http_x_forwarded_proto;

至于你需要的到底是X-Real-IP還是X-Forwarded-For，取決于你的業(yè)務(wù)邏輯。

QueryDict對象

在一個 HttpRequest 對象中， GET 和 POST 屬性是 django.http.QueryDict 的實例，這是一個類似字典的類，用來處理同一個鍵的多個值。這是很有必要的，因為一些 HTML 表單元素，尤其是<select multiple>，會傳遞同一個鍵的多個值。

在 request.POST 和 request.GET 中的 QueryDict 將在正常的請求／響應(yīng)周期中被訪問時是不可改變的。要得到一個可變的版本，你需要使用 QueryDict.copy()。

QueryDict方法

QueryDict是字典的子類，因此字典有的標(biāo)準(zhǔn)方法，QueryDict都具備。

1.QueryDict.get(key, default=None)

 如果鍵不存在，則用鉤子返回一個默認(rèn)值。如果鍵有多個值，則會獲取到最后一個值。

2.QueryDict.getlist(key, default=None)

 返回帶有請求鍵的數(shù)據(jù)列表。如果鍵不存在且 default 是 None，則返回一個空列表。除非提供的默認(rèn)值不是一個列表，否則返回一個列表。

下面是一段代碼，展示了get和getlist的使用。

>>> qd = QueryDict('a=1&a=2&a=3&b=4')  # 構(gòu)造QueryDict對象qd
>>> qd.get('a')         # 獲取鍵a的最后一個值
'3'
>>> qd.getlist('a')     # 獲取鍵a的所有值
['1', '2', '3']
>>> qd
<QueryDict: {'a': ['1', '2', '3'], 'b': ['4']}>
>>> qd.getlist('c')
[]
>>> qd.getlist('c', [1,2])
[1, 2]
>>> qd.get('c', '5')
'5'

HttpResponse對象

Django會自動創(chuàng)建HttpRequest(wsgi或者asgi創(chuàng)建)對象， HttpResponse則是后端開發(fā)人員負(fù)責(zé)實例化、填充和返回。每一個視圖函數(shù)都必須返回一個HttpResponse對象。

HttpResponse類位于django.http模塊中。

HttpResponse對象用法

典型的用法是將頁面的內(nèi)容以字符串、字節(jié)字符串或 memoryview 的形式傳遞給 HttpResponse 構(gòu)造函數(shù)。例如：

>>> from django.http import HttpResponse
>>> response = HttpResponse("Hello World!")

這樣，在函數(shù)結(jié)束的時候return response前端就能拿到響應(yīng)數(shù)據(jù)了。

但如果你想增量添加內(nèi)容，你可以使用 response 作為一個類似文件的對象：

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

在前后端分離的大趨勢下，我們機(jī)會很少使用后端去渲染頁面。后端通常都是返回JSON數(shù)據(jù)。

傳入迭代器

你可以傳遞 HttpResponse 一個迭代器而不是字符串。HttpResponse 將立即消耗迭代器，將其內(nèi)容存儲為一個字符串，然后丟棄它。帶有 close() 方法的對象，如文件和生成器，會立即關(guān)閉。如果你需要將響應(yīng)從迭代器流式傳輸?shù)娇蛻舳?，你必須使?StreamingHttpResponse 類來代替。

這種操作在普通場景下沒什么問題，但是如果文件或者圖片很多，并且很大，通常我們使用一個獨(dú)立的靜態(tài)文件服務(wù)器來解決問題，而不是由Django來處理這些東西

** 告訴瀏覽器將響應(yīng)作為文件附件處理 **

>>> response = HttpResponse(my_data, headers={
...     'Content-Type': 'application/vnd.ms-excel',
...     'Content-Disposition': 'attachment; filename="foo.xls"',
... })

Content-Disposition 頭并沒有什么 Django 特有的內(nèi)容，但是很容易忘記語法，所以我們把它包含在這里。

HttpResponse對象屬性

1.HttpResponse.charset

表示響應(yīng)將被編碼的字符集的字符串。如果在 HttpResponse 實例化時沒有給出，將從 content_type 中提取，如果不成功，將使用 DEFAULT_CHARSET（如果沒有設(shè)置，默認(rèn)為utf-8）設(shè)置。

2.HttpResponse.status_code

HttpResponse對象的 HTTP 狀態(tài)碼。

除非 reason_phrase 被明確設(shè)置，否則在構(gòu)造函數(shù)外修改 status_code 的值也會修改 reason_phrase 的值。

HttpResponse對象方法

1.HttpResponse.set_cookie(key, value='', max_age=None, expires=None, path='/', domain=None, secure=False, httponly=False, samesite=None)

設(shè)置一個 cookie。參數(shù)與 Python 標(biāo)準(zhǔn)庫中的 Morsel cookie 對象相同。

max_age should be an integer number of seconds, or None (default) if the cookie should last only as long as the client's browser session. If expires is not specified, it will be calculated.

expires 應(yīng)是格式為 “Wdy, DD-Mon-YY HH:MM:SS GMT” 的字符串，或者是 UTC 的 datetime.datetime 對象。如果 expires 是一個 datetime 對象，將計算 max_age。

max_age在不遠(yuǎn)的將來會取代expires。

如果你想設(shè)置一個跨域的 cookie，請使用 domain。例如，domain=“example.com” 將設(shè)置一個可被 www.example.com、blog.example.com 等域讀取的 cookie。否則，一個 cookie 將只能被設(shè)置它的域讀取。

如果你想讓 cookie 只在使用 https 方案進(jìn)行請求時才發(fā)送給服務(wù)器，請使用 secure=True。

如果你想防止客戶端的 JavaScript 訪問 cookie，請使用 httponly=True。

HttpOnly 是包含在 Set-Cookie HTTP 響應(yīng)頭中的一個標(biāo)志。它是 RFC 6265 標(biāo)準(zhǔn)中 Cookie 的一部分，可以作為一種有用的方式來降低客戶端腳本訪問受保護(hù) Cookie 數(shù)據(jù)的風(fēng)險。

使用 samesite=‘Strict' 或 samesite=‘Lax' 來告訴瀏覽器在執(zhí)行跨源請求時不要發(fā)送這個 cookie。SameSite 并不是所有瀏覽器都支持，所以它并不能替代 Django 的 CSRF 保護(hù)，而是一種深度防御措施。

使用 samesite='‘None' （字符串）來明確說明這個 cookie 會隨著所有的同站和跨站請求而發(fā)送。

Changed in Django 3.1:

允許使用 samesite='None （字符串）。

2.HttpResponse.delete_cookie(key, path='/', domain=None, samesite=None)

刪除給定鍵的 cookie。如果鍵不存在，則靜默失敗。

由于 cookie 的工作方式，path 和 domain 應(yīng)該與你在 set_cookie() 中使用的值相同，否則 cookie 可能不會被刪除。

HttpResponse子類

HttpResponse子類可以直接參考Django文檔，對于現(xiàn)在而言，最常用的莫過于JsonResponse子類。在此，會專門介紹JsonResponse子類的。

JsonResponse對象

class JsonResponse(data, encoder=DjangoJSONEncoder, safe=True, json_dumps_params=None, **kwargs)

一個 HttpResponse 子類，幫助創(chuàng)建一個 JSON 編碼的響應(yīng)。它繼承了它的超類的大部分行為，但有一些不同：

其默認(rèn)的 Content-Type 頭設(shè)置為 application/json。

第一個參數(shù) data 應(yīng)該是 dict 實例。如果 safe 參數(shù)設(shè)置為 False （見下文），它可以是任何 JSON 可序列化的對象。

encoder，默認(rèn)為 django.core.serializers.json.DjangoJSONEncoder，將用于序列化數(shù)據(jù)。

safe 布爾參數(shù)默認(rèn)為 True。如果它被設(shè)置為 False，任何對象都可以被傳遞到序列化中（否則只允許 dict 實例）。如果 safe 為 True，而第一個參數(shù)是一個非 dict 對象，則會引發(fā)一個 TypeError。

json_dumps_params 參數(shù)是一個關(guān)鍵字參數(shù)的字典，用來傳遞給 json.dumps() 調(diào)用，用于生成響應(yīng)?？梢杂脕碇付ň幋a。

參考資料

請求和響應(yīng)

總結(jié)

本篇文章就到這里了，希望能夠給你帶來幫助，也希望您能夠多多關(guān)注腳本之家的更多內(nèi)容！

最新評論