教程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):
    """
    列出所有代码段，或创建一个新的代码段。
    """
    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):
    """
    检索，更新或删除片段实例。
    """
    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//', views.SnippetDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

好的，我们完成了。 如果运行开发服务器，则所有内容都应像以前一样工作。

使用mixins

使用基于类的视图的最大胜利之一是它使我们能够轻松地组合可重用的行为。到目前为止，对于我们创建的任何模型支持的API视图，我们一直在使用的create / retrieve / update / delete操作将非常相似。这些常见行为在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 and 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()操作

使用基于通用类的视图

使用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的身份验证和权限。