Django - View（視圖）

時間 2019-11-21

標籤 django view 視圖欄目 Python 简体版

原文原文鏈接

1、簡單的視圖

一個視圖函數（類），簡稱視圖，是一個簡單的Python 函數（類），它接受Web請求而且返回Web響應。html

響應能夠是一張網頁的HTML內容，一個重定向，一個404錯誤，一個XML文檔，或者一張圖片。python

不管視圖自己包含什麼邏輯，都要返回響應。代碼寫在哪裏也無所謂，只要它在你當前項目目錄下面。除此以外沒有更多的要求了——能夠說「沒有什麼神奇的地方」。爲了將代碼放在某處，你們約定成俗將視圖放置在項目（project）或應用程序（app）目錄中的名爲views.py的文件中。ajax

下面是一個以HTML文檔的形式返回當前日期和時間的視圖：django

1 from django.http import HttpResponse
2 import datetime
3 
4 def current_datetime(request):
5     now = datetime.datetime.now()
6     html = "<html><body>It is now %s.</body></html>" % now
7     return HttpResponse(html)

讓咱們來逐行解釋下上面的代碼：瀏覽器

首先，咱們從 django.http模塊導入了HttpResponse類，以及Python的datetime庫。
接着，咱們定義了current_datetime函數。它就是視圖函數。每一個視圖函數都使用HttpRequest對象做爲第一個參數，而且一般稱之爲request。

注意，視圖函數的名稱並不重要；不須要用一個統一的命名方式來命名，以便讓Django識別它。咱們將其命名爲current_datetime，是由於這個名稱可以比較準確地反映出它實現的功能。緩存

這個視圖會返回一個HttpResponse對象，其中包含生成的響應。每一個視圖函數都負責返回一個HttpResponse對象。

Django使用請求和響應對象來經過系統傳遞狀態。安全

當瀏覽器向服務端請求一個頁面時，Django建立一個HttpRequest對象，該對象包含關於請求的元數據。而後，Django加載相應的視圖，將這個HttpRequest對象做爲第一個參數傳遞給視圖函數。服務器

每一個視圖負責返回一個HttpResponse對象。cookie

2、CBV和FBV

咱們以前寫過的都是基於函數的view，就叫FBV。還能夠把view寫成基於類的。session

就拿咱們以前寫過的添加班級爲例：

FBV版：

1 # FBV版添加班級
2 def add_class(request):
3     if request.method == "POST":
4         class_name = request.POST.get("class_name")
5         models.Classes.objects.create(name=class_name)
6         return redirect("/class_list/")
7     return render(request, "add_class.html")

CBV版：

 1 # CBV版添加班級
 2 from django.views import View
 3 
 4 
 5 class AddClass(View):
 6 
 7     def get(self, request):
 8         return render(request, "add_class.html")
 9 
10     def post(self, request):
11         class_name = request.POST.get("class_name")
12         models.Classes.objects.create(name=class_name)
13         return redirect("/class_list/")

注意：

使用CBV時，urls.py中也作對應的修改：

1 # urls.py中
2 url(r'^add_class/$', views.AddClass.as_view()),

3、給視圖加裝飾器

使用裝飾器裝飾FBV

FBV自己就是一個函數，因此和給普通的函數加裝飾器無差：

 1 def wrapper(func):
 2     def inner(*args, **kwargs):
 3         start_time = time.time()
 4         ret = func(*args, **kwargs)
 5         end_time = time.time()
 6         print("used:", end_time-start_time)
 7         return ret
 8     return inner
 9 
10 
11 # FBV版添加班級
12 @wrapper
13 def add_class(request):
14     if request.method == "POST":
15         class_name = request.POST.get("class_name")
16         models.Classes.objects.create(name=class_name)
17         return redirect("/class_list/")
18     return render(request, "add_class.html")

使用裝飾器裝飾CBV

類中的方法與獨立函數不徹底相同，所以不能直接將函數裝飾器應用於類中的方法，咱們須要先將其轉換爲方法裝飾器。

Django中提供了method_decorator裝飾器用於將函數裝飾器轉換爲方法裝飾器。

 1 # CBV版添加班級
 2 from django.views import View
 3 from django.utils.decorators import method_decorator
 4 
 5 class AddClass(View):
 6 
 7     @method_decorator(wrapper)
 8     def get(self, request):
 9         return render(request, "add_class.html")
10 
11     def post(self, request):
12         class_name = request.POST.get("class_name")
13         models.Classes.objects.create(name=class_name)
14         return redirect("/class_list/")

關於CBV的擴展閱讀

 1 # 使用CBV時要注意，請求過來後會先執行dispatch()這個方法，若是須要批量對具體的請求處理方法，如get，post等作一些操做的時候，這裏咱們能夠手動改寫dispatch方法，這個dispatch方法就和在FBV上加裝飾器的效果同樣。
 2 
 3 class Login(View):
 4      
 5     def dispatch(self, request, *args, **kwargs):
 6         print('before')
 7         obj = super(Login,self).dispatch(request, *args, **kwargs)
 8         print('after')
 9         return obj
10  
11     def get(self,request):
12         return render(request,'login.html')
13  
14     def post(self,request):
15         print(request.POST.get('user'))
16         return HttpResponse('Login.post')

4、Request對象

官方文檔：https://docs.djangoproject.com/en/1.11/ref/request-response/

請求相關的經常使用值

path_info 返回用戶訪問url，不包括域名
method 請求中使用的HTTP方法的字符串表示，全大寫表示。
GET 包含全部HTTP GET參數的類字典對象
POST 包含全部HTTP POST參數的類字典對象
body 請求體，byte類型 request.POST的數據就是從body裏面提取到的

屬性

全部的屬性應該被認爲是隻讀的，除非另有說明。

request屬性相關

屬性：

　　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() 區分它們。

    例如：

 1     if request.user.is_authenticated():
 2         # Do something for logged-in users.
 3     else:
 4         # Do something for anonymous users.
 5      
 6 
 7      　　user 只有當Django 啓用 AuthenticationMiddleware 中間件時纔可用。
 8 
 9      -------------------------------------------------------------------------------------
10 
11     匿名用戶
12     class models.AnonymousUser
13 
14     django.contrib.auth.models.AnonymousUser 類實現了django.contrib.auth.models.User 接口，但具備下面幾個不一樣點：
15 
16     id 永遠爲None。
17     username 永遠爲空字符串。
18     get_username() 永遠返回空字符串。
19     is_staff 和 is_superuser 永遠爲False。
20     is_active 永遠爲 False。
21     groups 和 user_permissions 永遠爲空。
22     is_anonymous() 返回True 而不是False。
23     is_authenticated() 返回False 而不是True。
24     set_password()、check_password()、save() 和delete() 引起 NotImplementedError。
25     New in Django 1.8:
26     新增 AnonymousUser.get_username() 以更好地模擬 django.contrib.auth.models.User。

11.HttpRequest.session

 　　一個既可讀又可寫的相似於字典的對象，表示當前的會話。只有當Django 啓用會話的支持時纔可用。

    完整的細節參見會話的文檔。

上傳文件示例

 1 def upload(request):
 2     """
 3     保存上傳文件前，數據須要存放在某個位置。默認當上傳文件小於2.5M時，django會將上傳文件的所有內容讀進內存。從內存讀取一次，寫磁盤一次。
 4     但當上傳文件很大時，django會把上傳文件寫到臨時文件中，而後存放到系統臨時文件夾中。
 5     :param request: 
 6     :return: 
 7     """
 8     if request.method == "POST":
 9         # 從請求的FILES中獲取上傳文件的文件名，file爲頁面上type=files類型input的name屬性值
10         filename = request.FILES["file"].name
11         # 在項目目錄下新建一個文件
12         with open(filename, "wb") as f:
13             # 從上傳的文件對象中一點一點讀
14             for chunk in request.FILES["file"].chunks():
15                 # 寫入本地文件
16                 f.write(chunk)
17         return HttpResponse("上傳OK")

方法

請求相關方法

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

 1         >>> request.get_signed_cookie('name')
 2         'Tony'
 3         >>> request.get_signed_cookie('name', salt='name-salt')
 4         'Tony' # 假設在設置cookie的時候使用的是相同的salt
 5         >>> request.get_signed_cookie('non-existing-cookie')
 6         ...
 7         KeyError: 'non-existing-cookie'    # 沒有相應的鍵時觸發異常
 8         >>> request.get_signed_cookie('non-existing-cookie', False)
 9         False
10         >>> request.get_signed_cookie('cookie-that-was-tampered-with')
11         ...
12         BadSignature: ...    
13         >>> request.get_signed_cookie('name', max_age=60)
14         ...
15         SignatureExpired: Signature age 1677.3839159 > 60 seconds
16         >>> request.get_signed_cookie('name', False, max_age=60)
17         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")

5、Response對象

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

HttpResponse類位於django.http模塊中。

使用

傳遞字符串

1 from django.http import HttpResponse
2 response = HttpResponse("Here's the text of the Web page.")
3 response = HttpResponse("Text only, please.", content_type="text/plain")
4 設置或刪除響應頭信息
5 response = HttpResponse()
6 response['Content-Type'] = 'text/html; charset=UTF-8'
7 del response['Content-Type']

屬性

HttpResponse.content：響應內容

HttpResponse.charset：響應內容的編碼

HttpResponse.status_code：響應的狀態碼

6、JsonResponse對象

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

1 from django.http import JsonResponse
2 
3 response = JsonResponse({'foo': 'bar'})
4 print(response.content)
5 
6 b'{"foo": "bar"}'
7 默認只能傳遞字典類型，若是要傳遞非字典類型須要設置一下safe關鍵字參數。
8 response = JsonResponse([1, 2, 3], safe=False)

7、Django shortcut functions

官方文檔：https://docs.djangoproject.com/en/1.11/topics/http/shortcuts/

render()

結合一個給定的模板和一個給定的上下文字典，並返回一個渲染後的 HttpResponse 對象。

參數：

request：用於生成響應的請求對象。

template_name：要使用的模板的完整名稱，可選的參數

context：添加到模板上下文的一個字典。默認是一個空字典。若是字典中的某個值是可調用的，視圖將在渲染模板以前調用它。

content_type：生成的文檔要使用的MIME類型。默認爲 DEFAULT_CONTENT_TYPE 設置的值。默認爲'text/html'

status：響應的狀態碼。默認爲200。

　　　useing: 用於加載模板的模板引擎的名稱。

一個簡單的例子：

 1 from django.shortcuts import render
 2 
 3 def my_view(request):
 4     # 視圖的代碼寫在這裏
 5     return render(request, 'myapp/index.html', {'foo': 'bar'})
 6 
 7 上面的代碼等於：
 8 from django.http import HttpResponse
 9 from django.template import loader
10 
11 def my_view(request):
12     # 視圖代碼寫在這裏
13     t = loader.get_template('myapp/index.html')
14     c = {'foo': 'bar'}
15     return HttpResponse(t.render(c, request))

redirect()

參數能夠是：

一個模型：將調用模型的get_absolute_url() 函數
一個視圖，能夠帶有參數：將使用urlresolvers.reverse 來反向解析名稱
一個絕對的或相對的URL，將原封不動的做爲重定向的位置。

默認返回一個臨時的重定向；傳遞permanent=True 能夠返回一個永久的重定向。

示例:

你能夠用多種方式使用redirect() 函數。

傳遞一個具體的ORM對象（瞭解便可）

將調用具體ORM對象的get_absolute_url() 方法來獲取重定向的URL：

1 from django.shortcuts import redirect
2  
3 def my_view(request):
4     ...
5     object = MyModel.objects.get(...)
6     return redirect(object)

傳遞一個視圖的名稱

def my_view(request):
    ...
    return redirect('some-view-name', foo='bar')

傳遞要重定向到的一個具體的網址

 1 def my_view(request):
 2     ...
 3     return redirect('/some/url/')
 4 固然也能夠是一個完整的網址
 5 def my_view(request):
 6     ...
 7     return redirect('http://example.com/')
 8 默認狀況下，redirect() 返回一個臨時重定向。以上全部的形式都接收一個permanent 參數；若是設置爲True，將返回一個永久的重定向：
 9 def my_view(request):
10     ...
11     object = MyModel.objects.get(...)
12     return redirect(object, permanent=True)

8、擴展閱讀：

臨時重定向（響應狀態碼：302）和永久重定向（響應狀態碼：301）對普通用戶來講是沒什麼區別的，它主要面向的是搜索引擎的機器人。

A頁面臨時重定向到B頁面，那搜索引擎收錄的就是A頁面。

A頁面永久重定向到B頁面，那搜索引擎收錄的就是B頁面。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。