DRF-vew/viewset

Serialization是对数据进行序列化和反序列化，但数据获取以及获取什么样的数据，就要靠视图层来完成了。DRF不仅对Django的基于函数的视图以及基于类的视图做了扩展，还增加了ViewSet。

基于函数的Views

DRF提供了一组简单的装饰器, 用于包装基于函数的视图, 以确保它们接收Request的实例 (而不是通常的 Django HttpRequest), 并允许它们返回Repsonse (而不是 Django HttpResponse), 并允许您配置如何请求被处理。

api_view()

@api_view(http_method_names=['GET']) 此函数接受一个http方法列表参数。若参数为空，默认只有GET方法能被接受。其他方法将响应405 Method Not Allowed。若需要允许其他方法，须在函数列表参数里指明。

from rest_framework.decorators import api_view

#参数列表为空，默认只有get方法能被接受
@api_view()
def hello_world(request):
    return Response({"message": "Hello, world!"})

#指定get、post方法允许访问
@api_view(['GET', 'POST'])
def hello_world(request):
    if request.method == 'POST':
        return Response({"message": "Got some data!", "data": request.data})
    return Response({"message": "Hello, world!"})

此视图将使用setting.py中指定的默认呈现器、解析器、身份验证类等。

api策略装饰器

DRF提供了一系列额外的装饰器来覆盖settings.py里的默认配置.这些装饰器必须在@api_view()之后.比如使用throttle来创建视图以确保该视图每天只能被特定用户访问一次。

from rest_framework.decorators import api_view, throttle_classes
from rest_framework.throttling import UserRateThrottle

class OncePerDayUserThrottle(UserRateThrottle):
        rate = '1/day'

@api_view(['GET'])
@throttle_classes([OncePerDayUserThrottle])
def view(request):
    return Response({"message": "Hello for today! See you tomorrow!"})

类似的装饰器还有：

@renderer_classes(...)
@parser_classes(...)
@authentication_classes(...)
@throttle_classes(...)
@permission_classes(...)

基于类的Views

我们还可以使用基于类的视图而不是基于函数的视图编写 api 视图。正如我们将看到的, 这是一个强大的模式, 它允许我们重用通用功能, 并帮助我们保持我们的代码

APIView

DRF提供了一个APIView类, 继承自 Django 的 View 类。 APIView类与View类有以下几点不同：

传递给处理程序方法的request将是 DRF 的request实例, 而不是 django 的 HttpRequest 实例
处理程序方法可能返回 DRF 的Response, 而不是 Django 的 HttpResponse
任何 ApiException 异常都将被捕获并传递到适当的响应中
传入请求将经过身份验证, 并在将请求调度到处理程序方法之前运行适当的权限和/或限制检查。

example:

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import authentication, permissions
from django.contrib.auth.models import User

class ListUsers(APIView):
    """
    View to list all users in the system.

    * Requires token authentication.
    * Only admin users are able to access this view.
    """
    authentication_classes = (authentication.TokenAuthentication,)
    permission_classes = (permissions.IsAdminUser,)

    def get(self, request, format=None):
        """
        Return a list of all users.
        """
        usernames = [user.username for user in User.objects.all()]
        return Response(usernames)

Using mixins

到目前为止, 我们一直在使用的create/retrieve/update/delete 操作对于我们创建的任何模型支持的 api 视图都将非常相似。这些常见行为在DRF的混合类中实现。

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)

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类提供核心代码，其他minxs类提供诸如list、create和retrieve等操作。

Using generic class-based views

使用上面的mixin 类, 我们重写了视图, 以使用比以前略少的代码, 但我们可以更进一步。DRF提供了一组已经混合的泛型视图, 我们可以使用这些视图来缩小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

是不是十分的简介？许多通用的逻辑都被封装到了泛型视图内，这样，我们就不用写大量重复的代码。让我们看看源码是如何封装的：

class ListCreateAPIView(mixins.ListModelMixin,
                        mixins.CreateModelMixin,
                        GenericAPIView):
    """
    Concrete view for listing a queryset or creating a model instance.
    """
    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)


class RetrieveUpdateAPIView(mixins.RetrieveModelMixin,
                            mixins.UpdateModelMixin,
                            GenericAPIView):
    """
    Concrete view for retrieving, updating a model instance.
    """
    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 patch(self, request, *args, **kwargs):
        return self.partial_update(request, *args, **kwargs)

当然，良好封装代价就是不够定制化。这一切得按照实际项目中的需求来分析。

ViewSets

看完上面的介绍，你可能又会想了，不管是SnippetList还是SnippetDetail都是对Snippet的操作，那我们能不能再封装一下，将其全部放在一个类里进行处理呢？

DRF提供了ViewSet来完成这一功能。

viewset 类与 view 类几乎是一回事, 只是它们提供了读取或更新等操作, 而不是方法处理函数 (如 get 或 put)。

Refactoring to use ViewSets

让我们使用ViewSet来替代上述使用的SnippetList和SnippetDetail：

from rest_framework.decorators import action
from rest_framework.response import Response

class SnippetViewSet(viewsets.ModelViewSet):
    """
    This viewset automatically provides `list`, `create`, `retrieve`,
    `update` and `destroy` actions.

    Additionally we also provide an extra `highlight` action.
    """
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer
    permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                          IsOwnerOrReadOnly,)

    @action(detail=True, renderer_classes=[renderers.StaticHTMLRenderer])
    def highlight(self, request, *args, **kwargs):
        snippet = self.get_object()
        return Response(snippet.highlighted)

    def perform_create(self, serializer):
        serializer.save(owner=self.request.user)

这里我们使用了 ModelViewSet，其默认提供了list, create, retrieve, update 和 destroy 方法。当然我们也可以通过@action装饰器自定义我们需要的方法，比如代码中的highlight方法。默认情况下, 使用 @action 装饰器的自定义操作将响应 GET 请求。如果我们想要响应POST请求，可以使用methods参数：@action(detail=True, methods=['post'])

Binding ViewSets to URLs explicitly

只有在定义 URLConf 时, 处理函数才会绑定到ViewSet中的action上。

snippets/urls.py:

from snippets.views import SnippetViewSet, UserViewSet, api_root
from rest_framework import renderers

snippet_list = SnippetViewSet.as_view({
    'get': 'list',
    'post': 'create'
})
snippet_detail = SnippetViewSet.as_view({
    'get': 'retrieve',
    'put': 'update',
    'patch': 'partial_update',
    'delete': 'destroy'
})
snippet_highlight = SnippetViewSet.as_view({
    'get': 'highlight'
}, renderer_classes=[renderers.StaticHTMLRenderer])

通过上述操作，我们将不同方法的请求绑定到了SnippetViewSet的各个方法上。

现在, 我们已经将资源绑定到具体的视图中, 我们可以像往常一样将views注册到 URL conf 中。

urlpatterns = format_suffix_patterns([
    path('', api_root),
    path('snippets/', snippet_list, name='snippet-list'),
    path('snippets/<int:pk>/', snippet_detail, name='snippet-detail'),
    path('snippets/<int:pk>/highlight/', snippet_highlight, name='snippet-highlight'),
    path('users/', user_list, name='user-list'),
    path('users/<int:pk>/', user_detail, name='user-detail')
])

Using Routers

因为我们是使用ViewSet而不是View，所以事实上，我们不需要自己设计`URL conf。通过使用Router类，我们将资源与视图以及urls字段绑定起来。