Tutorial 6: ViewSets & Routers

REST框架包括用于处理ViewSets的抽象，它允许开发人员专注于建模API的状态和交互，并使URL构造基于通用约定自动处理。

ViewSet类与View类几乎相同，只是它们提供read或update等操作，而不是方法处理程序，如get或put。

ViewSet类仅在最后一刻绑定到一组方法处理程序，当它被实例化为一组视图时，通常使用Router类来处理为您定义URL conf的复杂性。

Refactoring to use ViewSets

让我们采用当前的一组视图，并将它们重构为视图集。

首先，让我们将UserList和UserDetail视图重构为单个UserViewSet。我们可以删除这两个视图，并用一个类替换它们：

from rest_framework import viewsets

class UserViewSet(viewsets.ReadOnlyModelViewSet):
    """
    This viewset automatically provides `list` and `detail` actions.
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer

这里我们使用ReadOnlyModelViewSet类来自动提供默认的“只读”操作。我们仍然设置queryset和serializer_class属性，就像我们使用常规视图时一样，但我们不再需要向两个单独的类提供相同的信息。

接下来，我们将替换SnippetList，SnippetDetail和SnippetHighlight视图类。我们可以删除这三个视图，并再次用一个类替换它们。

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类来获取完整的默认读写操作集。

请注意，我们还使用了@action装饰器来创建一个名为highlight的自定义操作。此装饰器可用于添加任何不适合标准create / update / delete样式的自定义端点。

默认情况下，使用@action装饰器的自定义操作将响应GET请求。如果我们想要一个响应POST请求的操作，我们可以使用methods参数。

默认情况下，自定义操作的URL取决于方法名称本身。如果要更改url的构造方式，可以将url_path作为装饰器关键字参数包含在内。

Binding ViewSets to URLs explicitly

处理程序方法仅在定义URLConf时绑定到操作。要了解幕后发生的事情，我们首先要从ViewSets中明确创建一组视图。

在snippets / urls.py文件中，我们将ViewSet类绑定到一组具体视图中。

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])
user_list = UserViewSet.as_view({
    'get': 'list'
})
user_detail = UserViewSet.as_view({
    'get': 'retrieve'
})

请注意我们如何通过将http方法绑定到每个视图所需的操作，从每个ViewSet类创建多个视图。

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

urlpatterns = format_suffix_patterns([
    url(r'^$', api_root),
    url(r'^snippets/$', snippet_list, name='snippet-list'),
    url(r'^snippets/(?P<pk>[0-9]+)/$', snippet_detail, name='snippet-detail'),
    url(r'^snippets/(?P<pk>[0-9]+)/highlight/$', snippet_highlight, name='snippet-highlight'),
    url(r'^users/$', user_list, name='user-list'),
    url(r'^users/(?P<pk>[0-9]+)/$', user_detail, name='user-detail')
])

Using Routers

因为我们使用ViewSet类而不是View类，所以我们实际上不需要自己设计URL conf。可以使用Router类自动处理将资源连接到视图和URL的协议。我们需要做的就是用路由器注册适当的视图集，然后让它完成剩下的工作。

这是我们重写的snippets / urls.py文件。

from django.conf.urls import url, include
from rest_framework.routers import DefaultRouter
from snippets import views

# Create a router and register our viewsets with it.
router = DefaultRouter()
router.register(r'snippets', views.SnippetViewSet)
router.register(r'users', views.UserViewSet)

# The API URLs are now determined automatically by the router.
urlpatterns = [
    url(r'^', include(router.urls))
]

向路由器注册视图集与提供urlpattern类似。我们包括两个参数 - 视图的URL前缀和视图集本身。

我们正在使用的DefaultRouter类也会自动为我们创建API根视图，因此我们现在可以从views模块中删除api_root方法。

Trade-offs between views vs viewsets

使用视图集可能是一个非常有用的抽象。它有助于确保URL协议在您的API中保持一致，最大限度地减少您需要编写的代码量，并使您可以专注于API提供的交互和表示，而不是URL conf的细节。

这并不意味着它始终是正确的解决方案。在使用基于类的视图而不是基于函数的视图时，需要考虑类似的一组权衡。使用视图集不如单独构建视图那么明确。

在本教程的part 7中，我们将了解如何添加API模式，并使用客户端库或命令行工具与我们的API进行交互。