当前位置：首页 > news >正文

Django REST框架-基于类的视图

news 来源：原创 2024/4/18 8:08:05

以下代码基于前面的文件里面，请在前面的文件里边操作

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 status class 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) #转化为json格式 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 Http404 def get(self, request, pk, format=None): snippet = self.get_object(pk) serializer = SnippetSerializer(snippet) return Response(serializer.data) def patch(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)

看起来不错再次，它现在仍然非常类似于基于功能的视图。

我们还需要重构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)

好的，我们完成了如果运行开发服务器，那么应该像以前一样工作。

使用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): 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)

我们会花点时间仔细检查这里发生的情况。我们正在使用的建筑我们的观点GenericAPIView，并在加ListModelMixin和CreateModelMixin。

基类提供核心功能，而mixin类提供.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类来提供核心功能，并混入增加提供.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