python django rest framework Class-based Views

基于类的视图

我们也可以使用基于类的视图来编写我们的API视图,而不是基于功能的视图.正如我们将看到的,这是一个强大的模式,使我们可以重用常用的功能,并帮助我们保持代码干爽.

使用基于类的诗句重写我们的API

我么首先将根视图重写为一个基于类的视图,所有这些都设计到views.py的一些重构.

from snippets.models import Snippetfrom snippets.serializers import SnippetSerializerfrom django.http import Http404from rest_framework.views import APIViewfrom rest_framework.response import Responsefrom 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 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)

这看起来不错。 同样，它现在仍然非常类似于基于功能的视图。我们还需要稍微重构我们的urls.py，我们正在使用基于类的视图。

from django.conf.urls import urlfrom rest_framework.urlpatterns import format_suffix_patternsfrom snippets import viewsurlpatterns = [    url(r'^snippets/$', views.SnippetList.as_view()),    url(r'^snippets/(?P<pk>[0-9]+)/$', views.SnippetDetail.as_view()),]urlpatterns = format_suffix_patterns(urlpatterns)

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

Using mixins

使用基于类的视图的一个重大胜利是它允许我们轻松地构造可重复使用的行为。到目前为止，我们使用的创建/检索/更新/删除操作对于我们创建的任何模型支持的API视图将非常相似。 这些常见的行为是在REST框架的mixin类中实现的。我们来看看如何使用mixin类来构建视图。 这是我们的views.py模块了。

from snippets.models import Snippetfrom snippets.serializers import SnippetSerializerfrom rest_framework import mixinsfrom rest_framework import genericsclass 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类来提供核心功能，并在mixin中添加.retrieve（），.update（）和.destroy（）动作。

使用通用的基于类的视图

使用mixin类，我们重写了视图，使用比以前稍少的代码，但是我们可以更进一步。 REST框架提供了一组已经混合的通用视图，我们可以使用这些视图来裁剪我们的views.py模块。

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

使用mixin类，我们重写了视图，使用比以前稍少的代码，但是我们可以更进一步。 REST框架提供了一组已经混合的通用视图，我们可以使用这些视图来裁剪我们的views.py模块。