Django REST framework教程三: 基于类的视图

教程索引目录

Django REST framework的系列教程
对于需要通篇了解的同学，可以点击教程索引目录。

---

其实，与其使用基于方法（function based）的视图，我们更加倾向使用基于类（class based）的视图。接下来，你将看到这是一个强大的模式，是我们能够重用公共的功能，并且，帮我们保持代码DRY（Don’t Repeat Yourself）

---

使用基于类的视图，重新API

我们现在开始了。首先，重写根视图（root view），变成基于类的视图。所涉及的，只是对 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):
    """
    列出所有代码片段(snippets), 或者新建一个代码片段(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):
    """
    读取, 更新 or 删除一个代码片段(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 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)

好，搞定。如果你跑起开发者服务器，应该跟之前的效果是一样的。

---

使用混入（mixins）

使用类视图的一大好处是，我们可以很容易地，组成可重复使用的行为。

目前为止，我们所用的增删改查操作，在我们创建的，任何支持模型的视图里，都没有太大区别。这些通用的行为，在REST framework的混入(mixin)类中，都已经实现(implemented)了。

让我们看看，使用混合类，如何组建视图。下面同样是我们的 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() 行为。

---

使用基于泛类(generic class)的视图

使用混入(mixin)类重新视图，相比之前，我们减少了一些代码，但我们还可以更进一步。REST framework提供了一套已经实现了混入类的通用（generic）视图，我们可以使我们的 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。

下一步，我们将移步教程第四部分(part 4 of the tutorial)，将看看如何处理我们API的认证（authentication）和权限（permissions）。

---

如果你觉得这个翻译非常有帮助，不妨小额赞助我一下，你的认可，是我的动力！