Django REST FrameWork中文教程3:基于类的视图

时间：2023-03-08 15:56:35
Django REST FrameWork中文教程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):

    # 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):

    """

    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)

　　

看起来不错 再次，它现在仍然非常类似于基于功能的视图。

我们还需要重构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<pk>[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类来提供核心功能，并增加提供.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的身份验证和权限。

相关文章