Django 之REST framework学习6:视图集合类和路由器（ViewSets & Routers）-CSDN博客

声明：

如果你不小心刚好看到此文，然后又刚好感到恶心呕吐头昏眼花，说明两点：一你刚好怀上了，二你刚好病了，为解决不适，请离开这里抓紧就医！！！
如有不明白的地方，请移步：
http://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/

REST framework在处理ViewSets时包含一种抽象，这种抽象可以使开发者专注于API的交互和状态的塑造，而URL的结构会基于人们的惯例被自动处理（这个。。。我已经很努力的翻译了，不知道你们懂了没？，其实可以忽略！）
ViewSet类和View类差不多，它们提供了read和update操作，没有提供get和put请求方法的处理操作。
当一个ViewSet类通常会使用一个用来处理定义URL配置时复杂性的Router类来初始化为一系列的视图，并在最后绑定给一系列的方法处理上。（昨晚想了想怎么组织语句，心里明白不会表达~）

Let’s roll

使用ViewSets重构代码：

首先我们需要将UserList视图类和UserDetail视图类整合到UserViewSet中，现在把两个视图类移除掉，并用一个单一类来替代：

from rest_framework import viewsets

class UserViewSet(viewsets.ReadOnlyModelViewSet):
    """
    #这个viewset 会自动提供list和detail操作
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer

这里我们使用ReadOnlyModelViewSet来自动提供默认的只读操作，但是就像我们使用常规的视图类一样，我们还需要提供queryset和serializer_class属性，只是我们不再需要给两个各自的类提供相同的信息。

from rest_framework.decorators import detail_route
from rest_framework.response import Response

class SnippetViewSet(viewsets.ModelViewSet):
    """
    这个viewset 自动提供
    `list`, `create`, `retrieve`,
    `update` and `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操作，这个装饰器可以用来添加任何自定义的endpoints ，但是不适用于标准的create/update/delete形式。
使用@detail_route自定义的操作默认是给GET请求使用的，如果想要给POST请求使用，可以使用methods参数。
自定义操作的URLs默认依赖于方法名本身，如果你想改变url构建的方式，我们需要使用url_path作为装饰器的关键字参数。

把 ViewSets 绑定给具体的 URLs

当我们定义好URLConf（url路由）时，处理请求方法只会绑定给操作。让我们看下第一次使用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类来生成多个视图的。
既然我们给具体的视图绑定好了需要的东西，那么现在我们需要在路由中注册一下我们的视图：

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类，把视图和资源联系起来的协议和urls会被自动处理。我们只需要使用router来注册合适的视图，剩余的交给router来做就行。
在snippets/urls.py中：

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

# 实例化一个 router 并用它注册我们的 viewsets 
router = DefaultRouter()
router.register(r'snippets', views.SnippetViewSet)
router.register(r'users', views.UserViewSet)

#  API URLs 现在由 router 自动配置.
urlpatterns = [
    url(r'^', include(router.urls))
]