视图集和路由器（ViewSets & Routers）

教程6–视图集和路由器（ViewSets & Routers）

本文由wjc133翻译发布，欢迎大家转载。
英语水平有限，仅做参考。
Demo的Github地址：https://github.com/wjc133/DRF-Tutorial

注：下文中的ViewSets和Routers就不翻译了，感觉保留原文意思更清晰。

REST框架包含了一个处理ViewSets的抽象，力图让开发者专注于状态建模和API交互，把URL的创建过程依照通用的规范留给框架自动去完成。

ViewSet和View从功能上来讲其实差不多，但是ViewSet提供的是如.read()和.update()之类的方法，而不是方法处理器get和put之类的。
一个ViewSet仅在实例化成一组Views的最后时刻才会绑定到方法处理器上。通常是使用一个Router对象来处理这种复杂的URL conf定义。

使用ViewSets重构

首先，重构UserList和UserDetail两个视图为一个视图集UserViewSet。我们可以删掉原来的两个视图，然后用一个单一的类来代替它们：

from rest_framework import viewsets

class UserViewSet(viewsets.ReadOnlyModelViewSet):
    """
    视图集会自动提供`list` 和 `detail` 行为。
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer

这里我们使用的是ReadOnlyModelViewSet，所以默认只会提供与读有关的方法。我们仍然需要像之前一样提供queryset和serialzier_class，不过不再需要为两个类提供相同的信息了。

接下来我们要重构SnippetList、SnippetDetail和SnippetHighlight了。我们仍然可以用一个单一的类来代替它们：

from rest_framework.decorators import detail_route

class SnippetViewSet(viewsets.ModelViewSet):
    """
    视图集会自动提供list,create, retrieve, update & destroy这些行为，
    当然，我们也需要自己添加额外的highlight行为。
    """
    queryset = Snippet.objects.all()
    serializer_class = SnippetSerializer
    permission_classes = (permissions.IsAuthenticatedOrReadOnly,
                          IsOwnerOrReadOnly,)

    @detail_route(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，因为我们需要全面的读写功能。
注意，我们使用了@detail_route装饰器来定义一个自定义的行为，名字叫做highlight。该装饰器可以用来添加任意不适用标准create/update/delete的自定义endpoint。
使用@detail_route自定义的行为，默认都是GET请求。如果需要修改，我们可以指定methods参数。
自定义行为的URLs默认为方法名本身，如果你希望修改，你可以在装饰器中填入url_path参数。

将视图集绑定到URL配置

处理器方法只有在我们定义了URLConf的时候才会绑定到行为。
在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创建多个视图的。
现在我们来将资源绑定到具体的视图，我们可以像往常一样，注册视图到URLs 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')
])

使用Routers

因为我们正在使用ViewSet代替View，实际上已经不再需要自己来设计URL的配置了。将资源和视图、URL绑定到一起是一个可以自动完成的过程，只需要使用Router即可。我们需要做的就是将视图集注册到Router上去而已。
让我们重写一下urls.py文件。

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

# 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.
# Additionally, we include the login URLs for the browsable API.
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

将ViewSets注册到Routers的过程实际上类似于提供一个urlpattern。我们引入了两个参数，一个是views的URL prefix，另一个是viewset本身。
我们使用的DefaultRouter也会自动地帮我们创建API root视图，所以我们可以删除掉api_root方法了。

Views vs ViewSets

使用视图集是一个非常有效的行为。它有助于确保您所有的API的URL风格都是一致的，最大限度地减少你所需要编写的代码量，并是你专注于交互和业务逻辑，而不是URL conf的一些细节。
但这并不代表在所有场景下使用视图集都是好的。在讨论使用基于类的视图还是基于函数的视图时，也有一些类似的权衡。使用视图集没有自己构建View时那样明确。
在最后一个章节里，我们一起来看看如何添加API schema，并且尝试使用客户端库或者命令行工具来和我们的API进行交互。