Tutorial 6: 视图集(ViewSets)和路由(Routers)

REST框架包括对ViewSets的简短描述，这可以让开发者把精力集中在构建状态和交互的API模型，而且它可以基于一般规范自动构建URL。 ViewSet类几乎和View类一样，除了他们提供像read或update的操作，而不是像get和put的方法。目前，一个ViewSet类只绑定一个方法的集合，当它初始化一个视图的集合时，一般使用为你处理复杂的URL定义的Router类。

使用视图集(ViewSets)重构

让我们来用视图集重写当前视图。首先，我们要把我们的UserList和UserDetail视图重写成单个UserViewSet。我们可以UserViewSet代替UserList和UserDetail。

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属性，但是我们不在需要为两个分开的类提供同样的信息。接下来，我们将用SnippetHighlight视图类来代替SnippetList和SnippetDetail。我们可以用一个类代替之前的三个类。

from rest_framework.decorators import detail_route

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,)

    @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方式。使用@detail_route装饰器的自定义动作会响应GET请求。如果我们让动作响应POST请求，我们可以使用methods参数。自定义动作的URL在默认情况下是依赖于方法本身。如果你想改变url本来创建的方式，你可以将url_path包含在装饰器关键参数中。

明确绑定视图集到URL

我们定义URLConf的时候，处理方法只绑定了动作。为了看看发生了什么，我们必须从我们的视图集(ViewSets)创建一个视图集合。在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配置中。

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')
])

使用路由

因为我们使用ViewSet类而不是View类，所以实际上我们不需要自己设计URL配置。按惯例，使用Router类就可以自动将资源与视图(views)、链接(urls)联系起来。我们需要做的只是用一个路由注册合适的视图集合。现在，我们把剩下的做完。我们重写了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'))
]

用路由注册视图和提供一个urlpattern是相似的，包括两个参数--视图的URL前缀和视图本身。我们使用的默认路由(DefaultRouter)类会自动为我们创建API根视图，所以我们就可以从我们的views模块删除api_root方法。

可以在Github通过评论、提交问题、拉取请求来为项目做贡献。
加入REST框架讨论组，帮助搭建社区。
在Twitter上关注并问候作者。

现在，做一些很棒的东西吧。

django-rest-framework-tutorial-cn

Tutorial 6: 视图集(ViewSets)和路由(Routers)

使用视图集(ViewSets)重构

明确绑定视图集到URL

使用路由

views和viewsets的比较

回顾

继续向前