django rest framework快速入門(mén)第三章 基于類(lèi)的視圖

第三章 基于類(lèi)的視圖

寫(xiě)在前面:
本文翻譯于django rest framework官方文檔,由于網(wǎng)上大多數(shù)django rest framework中文翻譯文檔都有較為多的刪減行為午笛,筆者在學(xué)習(xí)的時(shí)候就覺(jué)得不是太方便鱼辙,故筆者將官方文檔較為完善的為大家翻譯下,僅供大家學(xué)習(xí)參考矗烛。

由于筆者文筆有限辅柴,若有寫(xiě)得不當(dāng)之處,敬請(qǐng)各位同仁指出瞭吃;若涉及到侵權(quán)碌嘀,請(qǐng)聯(lián)系筆者,筆者將立即刪除歪架。

我們還可以使用基于類(lèi)的視圖而不是基于函數(shù)的視圖來(lái)編寫(xiě)我們的API視圖股冗。 我們將看到這是一個(gè)強(qiáng)大的模式,允許我們重用通用功能和蚪,并幫助我們保持我們的代碼DRY

1. 使用基于類(lèi)的視圖來(lái)重寫(xiě)我們的API

首先我們從重寫(xiě)我們的根視圖來(lái)使用基于類(lèi)的視圖止状,所有的這些都只要重構(gòu)一點(diǎn)點(diǎn)我們的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):
    """
    列出所有的實(shí)例或者創(chuàng)建一個(gè)新的實(shí)例
    """
    def get(self, request, format=None):
        snippets = Snippet.objects.all()
        serializer = SnippetSerializer(snippets, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = SnippetSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

對(duì)于某個(gè)實(shí)例烹棉,我們重寫(xiě)SnippetDetail

class SnippetDetail(APIView):
    """
    檢索,更新或者刪除實(shí)例
    """
    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)

現(xiàn)在怯疤,我們的視圖仍然和基于函數(shù)的視圖比較類(lèi)似浆洗,現(xiàn)在我們還要重構(gòu)我們的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<pk>[0-9]+)/$', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

好的,我們的工作完成了集峦,當(dāng)你這個(gè)時(shí)候打開(kāi)服務(wù)器伏社,你會(huì)發(fā)現(xiàn)我們的項(xiàng)目會(huì)和原來(lái)一模一樣的運(yùn)行。


2. 使用mixins

使用基于類(lèi)的視圖的一大亮點(diǎn)是它允許我們輕松地組成可重用的行為塔淤。

到目前為止洛口,我們使用的創(chuàng)建/檢索/更新/刪除操作對(duì)于我們創(chuàng)建的任何模型支持的API視圖都非常相似。 這些常見(jiàn)的行為在REST Frameworkmixin類(lèi)中實(shí)現(xiàn)凯沪。

讓我們來(lái)看看如何使用mixin類(lèi)來(lái)構(gòu)造視圖第焰。 這里是我們的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):
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

我們現(xiàn)在花一點(diǎn)時(shí)間來(lái)解釋下現(xiàn)在是個(gè)什么狀況妨马。我們使用了GenericAPIView來(lái)構(gòu)建視圖挺举,并添加了ListModelMixinCreateModelMixin

mixins這個(gè)基類(lèi)提供了這些核心功能,并且mixins類(lèi)提供了.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類(lèi)來(lái)提供核心功能滤淳,然后我們添加mixins類(lèi)提供的.retrive()梧喷,.update().destroy()操作脖咐。


3. 使用通用的基于類(lèi)的視圖

使用mixins類(lèi)我們使用了更少的代碼來(lái)重寫(xiě)了我們的視圖铺敌,REST Framework已經(jīng)提供了一組已經(jīng)混合了的通用視圖,我們可以使用它來(lái)簡(jiǎn)化我們的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

是不是感覺(jué)很不錯(cuò)偿凭,我們只使用了很少很少的代碼,而且我們的代碼看起來(lái)很干凈派歌,這很Django

接下來(lái)弯囊,我們將來(lái)討論教程的第4章,我們將介紹如何處理我們API的身份驗(yàn)證和權(quán)限胶果。

謝謝各位閱讀匾嘱,并歡迎各位留下寶貴意見(jiàn)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市早抠,隨后出現(xiàn)的幾起案子霎烙,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,036評(píng)論 6 506
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件吼过,死亡現(xiàn)場(chǎng)離奇詭異锐秦,居然都是意外死亡,警方通過(guò)查閱死者的電腦和手機(jī)盗忱,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,046評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門(mén)酱床,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái),“玉大人趟佃,你說(shuō)我怎么就攤上這事扇谣。” “怎么了闲昭?”我有些...
    開(kāi)封第一講書(shū)人閱讀 164,411評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵罐寨,是天一觀(guān)的道長(zhǎng)。 經(jīng)常有香客問(wèn)我序矩,道長(zhǎng)鸯绿,這世上最難降的妖魔是什么? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,622評(píng)論 1 293
  • 正文 為了忘掉前任簸淀,我火速辦了婚禮瓶蝴,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘租幕。我一直安慰自己舷手,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,661評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布劲绪。 她就那樣靜靜地躺著男窟,像睡著了一般。 火紅的嫁衣襯著肌膚如雪贾富。 梳的紋絲不亂的頭發(fā)上歉眷,一...
    開(kāi)封第一講書(shū)人閱讀 51,521評(píng)論 1 304
  • 那天,我揣著相機(jī)與錄音祷安,去河邊找鬼姥芥。 笑死,一個(gè)胖子當(dāng)著我的面吹牛汇鞭,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播庸追,決...
    沈念sama閱讀 40,288評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼霍骄,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了淡溯?” 一聲冷哼從身側(cè)響起读整,我...
    開(kāi)封第一講書(shū)人閱讀 39,200評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎咱娶,沒(méi)想到半個(gè)月后米间,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體强品,經(jīng)...
    沈念sama閱讀 45,644評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,837評(píng)論 3 336
  • 正文 我和宋清朗相戀三年屈糊,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了的榛。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 39,953評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡逻锐,死狀恐怖夫晌,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情昧诱,我是刑警寧澤晓淀,帶...
    沈念sama閱讀 35,673評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站盏档,受9級(jí)特大地震影響凶掰,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜蜈亩,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,281評(píng)論 3 329
  • 文/蒙蒙 一锄俄、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧勺拣,春花似錦奶赠、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,889評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至愤惰,卻和暖如春苇经,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背宦言。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,011評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工扇单, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人奠旺。 一個(gè)月前我還...
    沈念sama閱讀 48,119評(píng)論 3 370
  • 正文 我出身青樓蜘澜,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親响疚。 傳聞我的和親對(duì)象是個(gè)殘疾皇子鄙信,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,901評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容