当前位置: 代码迷 >> 综合 >> 3-基于类的视图-Django REST框架
  详细解决方案

3-基于类的视图-Django REST框架

热度:17   发布时间:2023-09-14 11:24:35.0

3-基于类的视图-Django REST框架

教程3:基于类的视图

我们也可以使用基于类的视图而不是基于函数的视图来编写api视图.正如我们将要看到的,这是一种强大的模式,它允许我们重用公共功能,并帮助我们保留代码干的.

使用基于类的视图重写我们的api。

我们首先将根视图重写为基于类的视图。所有这些都涉及到一点点重构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 statusclass SnippetList(APIView):"""List all snippets, or create a new snippet."""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)

到现在为止还好。它看起来非常类似于上一种情况,但是不同的HTTP方法之间有更好的分离。我们还需要更新views.py.

class SnippetDetail(APIView):"""Retrieve, update or delete a snippet instance."""def get_object(self, pk):try:return Snippet.objects.get(pk=pk)except Snippet.DoesNotExist:raise Http404def 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.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import viewsurlpatterns = [path('snippets/', views.SnippetList.as_view()),path('snippets/<int:pk>/', views.SnippetDetail.as_view()),
]urlpatterns = format_suffix_patterns(urlpatterns)

好了我们结束了。如果您运行开发服务器,一切都应该像以前一样工作。

使用混合器

使用基于类的视图的最大优点之一是它允许我们轻松地组合可重用的行为比特。

我们到目前为止使用的创建/检索/更新/删除操作对于我们创建的任何模型支持的API视图都是非常相似的。这些常见行为是在REST框架的混合类中实现的。

让我们看看如何通过使用Mixin类来组合视图。这是我们的views.py模块又来了。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import mixins
from rest_framework import genericsclass SnippetList(mixins.ListModelMixin,mixins.CreateModelMixin,generics.GenericAPIView):queryset = Snippet.objects.all()serializer_class = SnippetSerializerdef get(self, request, *args, **kwargs):return self.list(request, *args, **kwargs)def post(self, request, *args, **kwargs):return self.create(request, *args, **kwargs)

我们会花点时间仔细检查这里到底发生了什么。我们正在用GenericAPIView,并加入ListModelMixinCreateModelMixin.

基类提供核心功能,混合类提供.list().create()行为。然后,我们将显式地绑定getpost方法对适当的动作。到目前为止已经够简单的了。

class SnippetDetail(mixins.RetrieveModelMixin,mixins.UpdateModelMixin,mixins.DestroyModelMixin,generics.GenericAPIView):queryset = Snippet.objects.all()serializer_class = SnippetSerializerdef 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类以提供核心功能,并添加混合器以提供.retrieve(), .update().destroy()行为。

使用基于泛型类的视图

通过使用Mixin类,我们重写了视图,使其使用的代码比以前略少,但我们可以更进一步。REST框架提供了一组已经混合的泛型视图,我们可以使用这些视图来减少views.py模块更多。

from snippets.models import Snippet
from snippets.serializers import SnippetSerializer
from rest_framework import genericsclass SnippetList(generics.ListCreateAPIView):queryset = Snippet.objects.all()serializer_class = SnippetSerializerclass SnippetDetail(generics.RetrieveUpdateDestroyAPIView):queryset = Snippet.objects.all()serializer_class = SnippetSerializer

哇,很简洁。我们免费获得了大量的数据,我们的代码看起来很好,很干净,很地道的Django。

接下来我们将继续本教程第4部分,在这里,我们将查看如何处理API的身份验证和权限。