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

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

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

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

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更強(qiáng)大

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

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

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

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

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

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

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

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

至此為止,一切順利??雌饋恚暗陌咐顒e不大,但我們將各個HTTP請求方法之間,做了更好的分離。接著,我們將同樣的更改我們,處理片段詳細(xì)的視圖,繼續(xù)我們的?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)

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

我們還需要稍微重構(gòu)我們的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)

好的,我們完成了。 如果你運(yùn)行開發(fā)服務(wù)器,一切都應(yīng)該像以前一樣工作。

使用混入mixins

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

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

我們來看看如何使用mixin類來構(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):

????#?mixins.CreateModelMixin?可以保存數(shù)據(jù)??????????????????

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

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

????serializer_class?=?SnippetSerializer

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

????????#?self.list是ListModelMixin的list函數(shù)

????????#?功能是過濾、分頁、調(diào)用serializer,將數(shù)據(jù)序列化

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

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

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

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

?到目前為止足夠簡單?;愄峁┖诵墓δ?,mixin類提供.list()和.create()操作。然后,我們明確的將get和post方法綁定到適當(dāng)?shù)牟僮魃稀?/p>

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類,我們重寫了視圖,使用比以前稍少的代碼,但是我們可以更進(jìn)一步。 REST框架提供了一組已經(jīng)混合的通用視圖,我們可以使用這些通用視圖來重構(gòu)我們的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

哇,這很簡潔。我們的代碼看起來非常優(yōu)雅。

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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容