Django中HttpRequest和HttpResponse

請求和響應對象

Django中通過使用請求和響應對象來傳遞系統的狀態。

當請求一個頁面的時候，Django就創建一個HttpRequest對象，它包含了關於請求的元數據對象，然后Django加載適當的視圖，並將HttpRequest作為視圖函數的第一個參數，每個視圖負責返回一個HttpResponse對象。

一、HttpRequest對象

class HttpRequest[源代碼]

常用屬性

• HttpRequest.path_info     返回用戶訪問url，不包括域名

• HttpRequest.method        請求中使用的HTTP方法的字符串表示，全大寫表示。

• HttpRequest.GET              包含所有HTTP  GET參數的類字典對象

• HttpRequest.POST           包含所有HTTP POST參數的類字典對象

• HttpRequest.body            請求體，byte類型 request.POST的數據就是從body里面提取到的

其他屬性：

屬性：
　　django將請求報文中的請求行、頭部信息、內容主體封裝成 HttpRequest 類中的屬性。
   除了特殊說明的之外，其他均為只讀的。


0.HttpRequest.scheme
   表示請求方案的字符串（通常為http或https）

1.HttpRequest.body

　　一個字符串，代表請求報文的主體。在處理非 HTTP 形式的報文時非常有用，例如：二進制圖片、XML,Json等。

　　但是，如果要處理表單數據的時候，推薦還是使用 HttpRequest.POST 。

　　另外，我們還可以用 python 的類文件方法去操作它，詳情參考 HttpRequest.read() 。

 

2.HttpRequest.path

　　一個字符串，表示請求的路徑組件（不含域名）。

　　例如："/music/bands/the_beatles/"



3.HttpRequest.method

　　一個字符串，表示請求使用的HTTP 方法。必須使用大寫。

　　例如："GET"、"POST"

 

4.HttpRequest.encoding

　　一個字符串，表示提交的數據的編碼方式（如果為 None 則表示使用 DEFAULT_CHARSET 的設置，默認為 'utf-8'）。
   這個屬性是可寫的，你可以修改它來修改訪問表單數據使用的編碼。
   接下來對屬性的任何訪問（例如從 GET 或 POST 中讀取數據）將使用新的 encoding 值。
   如果你知道表單數據的編碼不是 DEFAULT_CHARSET ，則使用它。

 

5.HttpRequest.GET 

　　一個類似於字典的對象，包含 HTTP GET 的所有參數。詳情請參考 QueryDict 對象。

 

6.HttpRequest.POST

　　一個類似於字典的對象，如果請求中包含表單數據，則將這些數據封裝成 QueryDict 對象。

　　POST 請求可以帶有空的 POST 字典 —— 如果通過 HTTP POST 方法發送一個表單，但是表單中沒有任何的數據，QueryDict 對象依然會被創建。
   因此，不應該使用 if request.POST  來檢查使用的是否是POST 方法；應該使用 if request.method == "POST" 

　　另外：如果使用 POST 上傳文件的話，文件信息將包含在 FILES 屬性中。

 7.HttpRequest.COOKIES

　　一個標准的Python 字典，包含所有的cookie。鍵和值都為字符串。

 

8.HttpRequest.FILES

　　一個類似於字典的對象，包含所有的上傳文件信息。
   FILES 中的每個鍵為<input type="file" name="" /> 中的name，值則為對應的數據。

　　注意，FILES 只有在請求的方法為POST 且提交的<form> 帶有enctype="multipart/form-data" 的情況下才會
   包含數據。否則，FILES 將為一個空的類似於字典的對象。

 

9.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 鍵。

 
10.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。
    New in Django 1.8:
    新增 AnonymousUser.get_username() 以更好地模擬 django.contrib.auth.models.User。

 

11.HttpRequest.session

 　　一個既可讀又可寫的類似於字典的對象，表示當前的會話。只有當Django 啟用會話的支持時才可用。
    完整的細節參見會話的文檔。

上傳下載示例：

def upload(request):
    """
    保存上傳文件前，數據需要存放在某個位置。默認當上傳文件小於2.5M時，django會將上傳文件的全部內容讀進內存。從內存讀取一次，寫磁盤一次。
    但當上傳文件很大時，django會把上傳文件寫到臨時文件中，然后存放到系統臨時文件夾中。
    :param request: 
    :return: 
    """
    if request.method == "POST":
        # 從請求的FILES中獲取上傳文件的文件名，file為頁面上type=files類型input的name屬性值
        filename = request.FILES["file"].name
        # 在項目目錄下新建一個文件
        with open(filename, "wb") as f:
            # 從上傳的文件對象中一點一點讀
            for chunk in request.FILES["file"].chunks():
                # 寫入本地文件
                f.write(chunk)
        return HttpResponse("上傳OK")

HttpRequest方法

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.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
        復制代碼
         


4.HttpRequest.is_secure()

　　如果請求時是安全的，則返回True；即請求通是過 HTTPS 發起的。

 

5.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') 裝飾你的視圖以讓響應能夠正確地緩存。

注意：鍵值對的值是多個的時候,比如checkbox類型的input標簽，select標簽，需要用：

request.POST.getlist("hobby")

二、HttpResponse對象

與由Django自動創建的HttpRequest對象相比，HttpResponse對象是我們的職責范圍了。我們寫的每個視圖都需要實例化，填充和返回一個HttpResponse。

HttpResponse類位於django.http模塊中。

使用

傳遞字符串

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 = HttpResponse()
response['Content-Type'] = 'text/html; charset=UTF-8'
del response['Content-Type']

屬性

HttpResponse.content：響應內容

HttpResponse.charset：響應內容的編碼

HttpResponse.status_code：響應的狀態碼

JsonResponse對象

JsonResponse是HttpResponse的子類，專門用來生成JSON編碼的響應。

from django.http import JsonResponse

response = JsonResponse({'foo': 'bar'})
print(response.content)

b'{"foo": "bar"}'

默認只能傳遞字典類型，如果要傳遞非字典類型需要設置一下safe關鍵字參數。

response = JsonResponse([1, 2, 3], safe=False)