06 类视图

APIView

基于类的视图编写API视图，允许我们重用常用的功能。

基于类视图重写API

  1. from snippets.models import Snippet
  2. from snippets.serializers import SnippetSerializer
  3. from django.http import Http404
  4. from rest_framework.views import APIView
  5. from rest_framework.response import Response
  6. from rest_framework import status
  9. class SnippetList(APIView):
  10.     """
  11.     列出所有的snippets或者创建一个新的snippet。
  12.     """
  13.     def get(self, request, format=None):
  14.         snippets = Snippet.objects.all()
  15.         serializer = SnippetSerializer(snippets, many=True)
  16.         return Response(serializer.data)
  18.     def post(self, request, format=None):
  19.         serializer = SnippetSerializer(data=request.data)
  20.         if serializer.is_valid():
  21.             serializer.save()
  22.             return Response(serializer.data, status=status.HTTP_201_CREATED)
  23.         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
  25. class SnippetDetail(APIView):
  26.     """
  27.     检索，更新或删除一个snippet示例。
  28.     """
  29.     def get_object(self, pk):
  30.         try:
  31.             return Snippet.objects.get(pk=pk)
  32.         except Snippet.DoesNotExist:
  33.             raise Http404
  35.     def get(self, request, pk, format=None):
  36.         snippet = self.get_object(pk)
  37.         serializer = SnippetSerializer(snippet)
  38.         return Response(serializer.data)
  40.     def put(self, request, pk, format=None):
  41.         snippet = self.get_object(pk)
  42.         serializer = SnippetSerializer(snippet, data=request.data)
  43.         if serializer.is_valid():
  44.             serializer.save()
  45.             return Response(serializer.data)
  46.         return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
  48.     def delete(self, request, pk, format=None):
  49.         snippet = self.get_object(pk)
  50.         snippet.delete()
  51.         return Response(status=status.HTTP_204_NO_CONTENT)

ViewSets

REST框架包含一个用于处理的抽象概念 ViewSets，它允许开发人员专注于对API的状态和交互进行建模，并根据通过约定自动处理URL构造。

  1. viewsets = (view1, view2, view3, viewN...)

DRF允许您将一组相关的视图view逻辑的组合到一个类中，称为一个ViewSet

  • ViewSet类与View类几乎相同
  • 它不提供任何方法处理程序，如（get/post/），而是提供诸如(list/create/read/update)
  • 一个ViewSet类只在最后时刻绑定到一组方法处理程序，当它被实例为一组视图时，通常通过使用一个Router类来处理复杂的URL conf

使用ViewSet重构

将UserList和UserDetail观点重构成一个单一的UserViewSet。我们可以删除这两个视图，并用一个类来替换它们。

  1. from rest_framework import viewsets
  3. class UserViewSet(viewsets.ReadOnlyModelViewSet):
  4.     """
  5.     此视图集自动提供‘list’和‘detail’操作
  6.     """
  8.     queryset = User.objects.all()
  9.     serializer_class = UserSerializer

ReadOnlyModelViewSet自动提供默认的“只读”操作。

将SnippetList，SnippetDetail和SnippetHighlight视图类更换为一个SnippetViewSet

  1. from rest_framework.decorators import action
  2. from rest_framework.response import Response
  4. class SnippetViewSet(viewsets.ModelViewSet):
  5.     """
  6.     此视图集自动提供“list”、“create”、“retrieve”、“update”和“destroy”操作
  7.     """
  8.     queryset = Snippet.objects.all()
  9.     serializer_class = SnippetSerializer
  10.     permission_classes = (permissions.IsAuthenticatedOrReadOnly, 
  11.                         IsOwnerOrReadOnly,)
  13.     @action(detail=True, renderer_classes=[renderers.StaticHTMLRenderer])
  14.     def highlight(self, request, *args, **kwargs):
  15.         snippet = self.get_object()
  16.         return Response(snippet.highlighted)
  18.     def permform_create(self, serializer):
  19.         serializer.save(owner=self.request.user)

继承自ModelViewSet类，提供完整的读写操作。

  • @action装饰自定义操作highlight。用来添加任何不符合标准create/update/delete的自定义endpoints
  • @action默认处理GET请求，如果要处理POST请求，可以使用method参数来指定

view与viewsets之间权衡

viewsets是一个非常有用的抽象

  • 有助于确保URL在API中保持一致，最大限度地减少需要编写的代码量
  • 使用viewsets时，不如view更明确。