[Django REST FrameWork][03]:基于类的视图

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

使用基于类的视图 重写我们的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):

    # APIView实际继承django总的View

    # from django.views.generic import View

    """

    # 这里是SnippetList接口描述

    List all snippets, or create a new snippet.

    """

    def get(self, request, format=None):

        snippets = Snippet.objects.all()

        # manay=True 用于querySet对象

        serializer = SnippetSerializer(snippets, many=True)

        3 Respone比django的response更强大

        return Response(serializer.data)

    def post(self, request, format=None):

        serializer = SnippetSerializer(data=request.data)

        if serializer.is_valid():

            # .save()是调用SnippetSerializer中的create()方法

            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)

这看起来不错。 同样,它现在仍然非常像基于方法的视图。

我们还需要稍微重构我们的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)

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

使用混入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):

    # mixins.CreateModelMixin 可以保存数据                  

    # generics.GenericAPIView 继承了APIView

    queryset = Snippet.objects.all()

    serializer_class = SnippetSerializer

    def get(self, request, *args, **kwargs):

        # self.list是ListModelMixin的list函数

        # 功能是过滤、分页、调用serializer,将数据序列化

        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

哇,这很简洁。我们的代码看起来非常优雅。

接下来,我们将介绍本教程的第4部分,在这里我们将看看如何处理我们的API的身份验证和权限。

你可能感兴趣的:([Django REST FrameWork][03]:基于类的视图)