[Django REST FrameWork][03]:基于類的視圖

其實,與其使用基于方法(function based)的視圖,我們更加傾向使用基于類(class based)的視圖。接下來,你將看到這是一個強大的模式,是我們能夠重用公共的功能,并且,幫我們保持代碼DRY。

使用基于類的視圖 重寫我們的API

我們現在開始了。首先,重寫根視圖(root view),變成基于類的視圖。所涉及的,只是對?views.py文件的一點重構。

from?snippets.models?import?Snippet

from?snippets.serializers?import?SnippetSerializer

from?django.http?import?Http404

from?rest_framework.views?import?APIView

from?rest_framework.response?import?Response

from?rest_framework?import?status

class?SnippetList(APIView):

????#?APIView實際繼承django總的View

????#?from?django.views.generic?import?View

????"""

????#?這里是SnippetList接口描述

????List?all?snippets,?or?create?a?new?snippet.

????"""

????def?get(self,?request,?format=None):

????????snippets?=?Snippet.objects.all()

????????#?manay=True?用于querySet對象

????????serializer?=?SnippetSerializer(snippets,?many=True)

????????3?Respone比django的response更強大

????????return?Response(serializer.data)

????def?post(self,?request,?format=None):

????????serializer?=?SnippetSerializer(data=request.data)

????????if?serializer.is_valid():

????????????#?.save()是調用SnippetSerializer中的create()方法

????????????serializer.save()

????????????return?Response(serializer.data,?status=status.HTTP_201_CREATED)

????????return?Response(serializer.errors,?status=status.HTTP_400_BAD_REQUEST)

至此為止,一切順利??雌饋?,跟之前的案例差別不大,但我們將各個HTTP請求方法之間,做了更好的分離。接著,我們將同樣的更改我們,處理片段詳細的視圖,繼續我們的?views.py?文件:。

class?SnippetDetail(APIView):

????"""

????讀取,?更新?or?刪除一個代碼片段(snippet)實例(instance).

????"""

????def?get_object(self,?pk):

????????try:

????????????return?Snippet.objects.get(pk=pk)

????????except?Snippet.DoesNotExist:

????????????raise?Http404

????def?get(self,?request,?pk,?format=None):

????????snippet?=?self.get_object(pk)

????????serializer?=?SnippetSerializer(snippet)

????????return?Response(serializer.data)

????def?put(self,?request,?pk,?format=None):

????????snippet?=?self.get_object(pk)

????????serializer?=?SnippetSerializer(snippet,?data=request.data)

????????if?serializer.is_valid():

????????????serializer.save()

????????????return?Response(serializer.data)

????????return?Response(serializer.errors,?status=status.HTTP_400_BAD_REQUEST)

????def?delete(self,?request,?pk,?format=None):

????????snippet?=?self.get_object(pk)

????????snippet.delete()

????????return?Response(status=status.HTTP_204_NO_CONTENT)

這看起來不錯。 同樣,它現在仍然非常像基于方法的視圖。

我們還需要稍微重構我們的snippets/urls.py,因為我們正在使用基于類的視圖。

from?django.conf.urls?import?url

from?rest_framework.urlpatterns?import?format_suffix_patterns

from?snippets?import?views

urlpatterns?=?[

????url(r'^snippets/$',?views.SnippetList.as_view()),

????url(r'^snippets/(?P[0-9]+)/$',?views.SnippetDetail.as_view()),

]

urlpatterns?=?format_suffix_patterns(urlpatterns)

好的,我們完成了。 如果你運行開發服務器,一切都應該像以前一樣工作。

使用混入mixins

使用基于類的視圖的好處是,我們可以很容易組成可重復使用的代碼。

到目前為止,我們使用的創建/檢索/更新/刪除操作,對于我們創建的,任何模型支持的API視圖將非常相似。 這些常見的行為是在REST框架的mixin類中都已經實現的。

我們來看看如何使用mixin類來構建視圖。 這是我們的views.py模塊了。

from?snippets.models?import?Snippet

from?snippets.serializers?import?SnippetSerializer

from?rest_framework?import?mixins

from?rest_framework?import?generics

class?SnippetList(mixins.ListModelMixin,

??????????????????mixins.CreateModelMixin,

??????????????????generics.GenericAPIView):

????#?mixins.CreateModelMixin?可以保存數據??????????????????

????#?generics.GenericAPIView?繼承了APIView

????queryset?=?Snippet.objects.all()

????serializer_class?=?SnippetSerializer

????def?get(self,?request,?*args,?**kwargs):

????????#?self.list是ListModelMixin的list函數

????????#?功能是過濾、分頁、調用serializer,將數據序列化

????????return?self.list(request,?*args,?**kwargs)

????def?post(self,?request,?*args,?**kwargs):

????????return?self.create(request,?*args,?**kwargs)

我們將花一點時間仔細檢查這里發生的事情。我們用GenericAPIView建一個視圖,并添加ListModelMixin和CreateModelMixin。

?到目前為止足夠簡單?;愄峁┖诵墓δ埽琺ixin類提供.list()和.create()操作。然后,我們明確的將get和post方法綁定到適當的操作上。

class?SnippetDetail(mixins.RetrieveModelMixin,

????????????????????mixins.UpdateModelMixin,

????????????????????mixins.DestroyModelMixin,

????????????????????generics.GenericAPIView):

????queryset?=?Snippet.objects.all()

????serializer_class?=?SnippetSerializer

????def?get(self,?request,?*args,?**kwargs):

????????return?self.retrieve(request,?*args,?**kwargs)

????def?put(self,?request,?*args,?**kwargs):

????????return?self.update(request,?*args,?**kwargs)

????def?delete(self,?request,?*args,?**kwargs):

????????return?self.destroy(request,?*args,?**kwargs)

很相似,我們再次使用GenericAPIView類來提供核心功能,并在mixin中添加.retrieve(),.update()和.destroy()方法。

使用通用的基于類的視圖

使用mixin類,我們重寫了視圖,使用比以前稍少的代碼,但是我們可以更進一步。 REST框架提供了一組已經混合的通用視圖,我們可以使用這些通用視圖來重構我們的views.py模塊。

from?snippets.models?import?Snippet

from?snippets.serializers?import?SnippetSerializer

from?rest_framework?import?generics

class?SnippetList(generics.ListCreateAPIView):

????queryset?=?Snippet.objects.all()

????serializer_class?=?SnippetSerializer

class?SnippetDetail(generics.RetrieveUpdateDestroyAPIView):

????queryset?=?Snippet.objects.all()

????serializer_class?=?SnippetSerializer

哇,這很簡潔。我們的代碼看起來非常優雅。

接下來,我們將介紹本教程的第4部分,在這里我們將看看如何處理我們的API的身份驗證和權限。

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,156評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,401評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,069評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,873評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,635評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,128評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,203評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,365評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,881評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,733評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,935評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,475評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,172評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,582評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,821評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,595評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,908評論 2 372

推薦閱讀更多精彩內容