Django 類視圖

引文

有朋友反映說對於 Django 的 Class-Based-View（基於類的通用視圖）還有很多不明白的地方，因此接下來我會在文章中講解幾個常用的具有代表性的基於類的視圖用法，並在適當的源碼層面下講解其機理和如何按照我們的需要拓展它。

所有的類視圖都繼承django.views.generic.base.View類。

TemplateView

這可能是最簡單的通用類視圖。一般在僅僅渲染一個模板時派上用場。可直接在URLconf中使用as_view()方法，如下所示：

from django.urls import path
from django.views.generic import TemplateView

urlpatterns = [
    path('about/', TemplateView.as_view(template_name="about.html")),
]

 ListView

從名字我們可以對其功能略窺一二，ListView 用於列出一系列 Model 對象集合（比如文章列表）。

在開發一個網站時，我們常常需要獲取存儲在數據庫中的某個 Model 的列表，比如 Blog 要獲取文章（Article）列表以顯示到首頁，通常我們都會寫如下的視圖函數來滿足我們的需求：

當然這僅僅是一個最為基本的視圖函數的例子，Django 開發者發現，如果項目里有大量的視圖都是實現類似於上面這種獲取存儲在數據庫中的某個 Model 的列表的功能的話，會不斷地重復書寫諸如下面的代碼：

就是不斷地獲取 Model 列表然后渲染模板文件，Django 說寫多了開發人員就覺得無聊了，那我們何不把這些邏輯抽象出來放到一個類里？於是 Django 幫我們寫好了一個類，專門用於處理上面的情況，這就是 ListView，將上面的視圖函數轉寫成類視圖如下：

首先看看 get_queryset() 方法，它完成的功能和 article_list = Article.objects.all() 這句代碼類似，獲取某個 Model 的列表（這里是文章列表），其中 article_list 就是 context_object_name 屬性值。

同時我們加入了自己的邏輯，即對 article_list 中的各個 article 進行了 markdwon 拓展。假如僅僅只需要獲取 article_list ，則甚至可以不用復寫 get_queryset 方法，只需指定一個 model 屬性，告訴 Django 去獲取哪個 model 的列表就可以了，像這樣：

第二個復寫的方法是 get_context_data() 方法，這個方法是用來給傳遞到模板文件的上下文對象（context）添加額外的內容的（context 的概念在前面的教程中已有介紹，如果這里不懂的話我再簡單解釋一下，我們在模板文件中會使用 {{ }} 這樣的標簽來包裹模板變量，這些變量哪里來的？就是視圖函數通過 context 傳遞到模板的）。

我們這里因為首頁需要顯示分類信息，因此我們把 category_list 通過 get_context_data 方法加入了 context 對象，視圖函數再幫我們把 context 傳遞給模板。return super(IndexView, self).get_context_data(**kwargs) 語句的作用是添加了 category_list 到上下文中，還要把默認的一些上下文變量也返回給視圖函數，以便其后續處理。

現在有了 model 列表，context，按照視圖函數的邏輯應該是把這些傳遞給模板了，ListView 通過指定 template_name 屬性來指定需要渲染的模板，而 context_object_name 是給 get_queryset 方法返回的 model 列表重新命名的，因為默認返回的 model 列表其名字是 object_list，為了可讀性，我們可以通過 context_object_name 來重新指定，例如我們這里指定為 article_list。

return render_to_response(‘blog/index.html’,context) 的功能在 ListView 中 Django 已經默認幫我們做了，翻看其源代碼就會知道：

如果你改變渲染模板的一些行為，通過復寫 render_to_response 方法即可。

以上方法在類視圖調用 as_view() 方法后會被自動調用。

ListView總結

• ListView 主要用在獲取某個 model 列表中

• 通過 template_name 屬性來指定需要渲染的模板，通過 context_object_name 屬性來指定獲取的 model 列表的名字，否則只能通過默認的 object_list 獲取

• 復寫 get_queryset 方法以增加獲取 model 列表的其他邏輯

• 復寫 get_context_data 方法來為上下文對象添加額外的變量以便在模板中訪問

DetailView

前面的 ListView 用於獲取某個 model 的列表，獲取的是一系列對象，但獲取單個mdoel對象也是很常見的，比如 Blog 里點擊某篇文章后進入文章的詳情頁，這里獲取的就是點擊這篇文章。我們通常會寫如下視圖函數：

同樣的，如果這種需求多的話，開發人員就需要枯燥而乏味地大量重復寫 article = get_object_or_404(Article,pk=article_id) 這樣的句子，Django 通過 DetailView 來把這種邏輯抽象出來，把上面的視圖函數轉成類視圖：

model 屬性告訴 Django 是獲取哪個 model 對應的單個對象，template_name，context_object_name 屬性和 ListView 中是一樣的作用，pk_url_kwarg 相當於視圖函數中的 article_id 參數（也是URLconf中的id參數），已告訴 Django 獲取的是 id 為多少的 model 實例。

get_object() 方法默認情況下獲取 id 為pk_url_kwarg 的對象，如果需要在獲取過程中對獲取的對象做一些處理，比如對文章做 markdown 拓展，通過復寫 get_object 即可實現。

之后的處理就和 ListView 類似了，已經實現了 render_to_response 方法來渲染模板。

以上方法在類視圖調用 as_view() 方法后會被自動調用。

DetailView 總結

• DetailView主要用在獲取某個 model 的單個對象中

• 通過 template_name 屬性來指定需要渲染的模板，通過 context_object_name 屬性來指定獲取的 model 對象的名字，否則只能通過默認的 object 獲取

• 復寫 get_object 方法以增加獲取單個 model 對象的其他邏輯

• 復寫 get_context_data 方法來為上下文對象添加額外的變量以便在模板中訪問

使用類的通用視圖的好處

通過上面的例子你可能並未體會到使用類的通用視圖的好處，畢竟我們寫的基於函數的視圖似乎代碼量更短，但這僅僅是因為例子簡單而已。

同時別忘了，類是可以被繼承的，假如我們已經寫好了一個基於類的通用視圖，要對其拓展功能，只需繼承原本這個類視圖即可，而如果寫的是函數呢？拓展性就沒有這么靈活，可能需要使用到裝飾器等高級技巧，或甚至不得不重復一段代碼到新拓展的視圖函數中。

但本質上而言，基於類的通用視圖依然是一個視圖函數，因為最終調用時我們會通過 genericview.as_view() 方法把類視圖轉換成一般的視圖，url 配置是這樣的：

因此，基於類的視圖並非什么新的東西，只是為了方便而對一般的視圖另一種形式的改寫而已，理解了一般的視圖寫法后，通過閱讀其官方文檔和類視圖的源碼，很快就能掌握如何寫好類視圖了。

 

　　至此。轉載請注明出處。

[參考：Django官方文檔 https://docs.djangoproject.com/zh-hans/2.0]