django-rest-framework 類視圖拓展自 django 的類視圖，只是針對(duì)數(shù)據(jù)的序列化和反序列化等邏輯做了封裝。

django-rest-framework 中最基本的類視圖是 views.APIView，這個(gè)類可以看成是上一篇教程中用到的 api_view 裝飾器的類版本。這個(gè)類比較基礎(chǔ)，其核心功能就是 HTTP 請(qǐng)求預(yù)處理、分發(fā)請(qǐng)求給對(duì)應(yīng)的處理函數(shù)，以及 HTTP 響應(yīng)后處理，還有就是 as_view 方法將類轉(zhuǎn)為函數(shù)（要注意與被請(qǐng)求的 URL 綁定的視圖必須是一個(gè)可調(diào)用對(duì)象，普通的的類是無法被直接調(diào)用的）。除非需要深度定制視圖函數(shù)的邏輯，一般情況下我們的視圖不會(huì)直接繼承這個(gè)類。

更為通用的類視圖是 GenericAPIView，這個(gè)類繼承自 APIView，對(duì)基類的功能做了拓展。繼承自這個(gè)類的視圖，只需對(duì)其類屬性做一些簡單的配置，就能獲得獲取單個(gè)資源、獲取資源列表、資源列表分頁等功能。當(dāng)然，這個(gè)類作為其他特定功能類視圖的基類，我們一般也很少使用。

回顧一下此前講的 RESTful 架構(gòu)的基本概念，客戶端使用 URL 訪問資源，通過 HTTP 請(qǐng)求的動(dòng)詞表達(dá)對(duì)資源的操作。django-rest-framework 針對(duì)各種類型的資源操作，提供了對(duì)應(yīng)的通用類視圖，這些通用類視圖主要包括：

CreateAPIView

用于創(chuàng)建資源的 POST 請(qǐng)求。

ListAPIView 和 RetrieveAPIView

用于訪問資源列表和單個(gè)資源的 GET 請(qǐng)求。

DestroyAPIView

用于刪除資源的 DELETE 請(qǐng)求。

UpdateAPIView

用于更新資源的 PUT（全量更新）和 PATCH（部分更新）請(qǐng)求。

以及以上視圖的各種組合通用類視圖：ListCreateAPIView、RetrieveUpdateAPIView、RetrieveDestroyAPIView、RetrieveUpdateDestroyAPIView。

博客首頁 API 返回首頁文章列表數(shù)據(jù)，顯然應(yīng)該選用的是 ListAPIView。其代碼如下：

from rest_framework.generics import ListAPIView
from rest_framework.pagination import PageNumberPagination
from rest_framework.permissions import AllowAny
class IndexPostListAPIView(ListAPIView):
  serializer_class = PostListSerializer
  queryset = Post.objects.all()
  pagination_class = PageNumberPagination
  permission_classes = [AllowAny]

That all！首頁 API 就寫好了。我們基本沒有寫任何邏輯代碼，只是指定了類視圖的幾個(gè)屬性值。因?yàn)檫壿嫽径际峭ㄓ玫?，通用類視圖在背后幫我們做了全部工作，我們只要告訴它：用哪個(gè)序列化器去做，序列化哪個(gè)資源等就可以了。以這里的類視圖為例，我們指定了：

使用 PostListSerializer 序列化器（通過 serializer_class 指定）；

序列化博客文章（Post）列表（通過 queryset 指定）；

對(duì)資源列表分頁（通過 pagination_class 指定，PageNumberPagination 會(huì)自動(dòng)對(duì)資源進(jìn)行分頁，后面的教程會(huì)詳細(xì)介紹分頁功能）；

允許任何人訪問該資源（通過 permission_classes 指定，AllowAny 權(quán)限類不對(duì)任何訪問做攔截，即允許任何人調(diào)用這個(gè) API 以訪問其資源）。

最后一步就是在 urls.py 中綁定接口，把原來綁定的函數(shù)視圖改為現(xiàn)在的類視圖：

path('api/index/', views.IndexPostListAPIView.as_view())

啟動(dòng)開發(fā)服務(wù)器，打開瀏覽器訪問 http://127.0.0.1:8000/api/index/，可以看到和上一篇教程中使用函數(shù)視圖返回的結(jié)果是一樣的：

{
  "count": 201,
  "next": "http://127.0.0.1:10000/api/index/?page=2",
  "previous": null,
  "results": [
    {
      "id": 1,
      "title": "Markdown 與代碼高亮測(cè)試",
      "created_time": "2020-04-23T14:22:36.129383+08:00",
      "excerpt": "歡迎使用馬克飛象\n@(示例筆記本)[馬克飛象|幫助|Markdown]\n馬克飛象是一款專為印象筆記（Ever",
      "category": {
        "id": 6,
        "name": "Markdown測(cè)試"
      },
      "author": {
        "id": 1,
        "username": "admin"
      },
      "views": 0
    }
  ]
}

而且可以看到，返回的結(jié)果進(jìn)行了分頁，next 字段指示了下一頁的鏈接，這樣分頁訪問資源就變的非常方便了。

以上就是本文的全部內(nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論