Tutorial 3: Class-based Views

Tutorial 3: Class-based Views

我们还可以使用基于类的视图而不是基于函数的视图来编写API视图。我们将看到这是一个强大的模式，允许我们重用常用功能，并帮助我们保持代码 DRY。

Rewriting our API using class-based views

我们首先将根视图重写为基于类的视图。所有这些都涉及到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)
        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)

那看起来不错。同样，它现在仍然非常类似于基于函数的视图。
我们还需要稍微重构我们的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)

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

Using 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类来提供核心功能，并添加mixins以提供.retrieve（）,. update（）和.destroy（）操作。

Using generic class-based views

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

哇，这很简洁。我们免费获得了大量金额，而且我们的代码看起来很好，干净，惯用的Django 。
接下来我们将进入本教程的第4部分part 4 of the tutorial，在这里我们将了解如何处理API的身份验证和权限。