教程 3：基于类的视图

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

使用基于类的视图重写我们的 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)
        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.urls import path
from rest_framework.urlpatterns import format_suffix_patterns
from snippets import views

urlpatterns = [
    path('snippets/', views.SnippetList.as_view()),
    path('snippets/<int:pk>/', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

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

使用 mixin

使用基于类的视图的一大好处是它允许我们轻松地组合可重复使用的行为片段。

我们到目前为止一直在使用的创建/检索/更新/删除操作对于我们创建的任何模型支持的 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 类来提供核心功能，并添加 mixin 来提供 .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

哇，这非常简洁。我们免费获得了大量的代码，并且我们的代码看起来像良好、干净、惯用的 Django。

接下来，我们将进入 教程的第 4 部分，我们将了解如何处理 API 的身份验证和权限。