第07篇 视图集和路由器

教程 6：视图集和路由器

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

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

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

重构以使用 ViewSet

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

首先，让我们将我们的UserListandUserDetail视图重构为一个UserViewSet. 我们可以删除这两个视图，并将它们替换为一个类：

from rest_framework import viewsets

class UserViewSet(viewsets.ReadOnlyModelViewSet):
    """
    This viewset automatically provides `list` and `retrieve` 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
from rest_framework import permissions

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请求。methods如果我们想要一个响应POST请求的动作，我们可以使用这个参数。

默认情况下，自定义操作的 URL 取决于方法名称本身。如果你想改变 url 的构造方式，你可以包含url_path一个装饰器关键字参数。

将 ViewSet 显式绑定到 URL

处理程序方法仅在我们定义 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'
})

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

现在我们已经将资源绑定到具体的视图中，我们可以像往常一样使用 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')
])

使用路由器

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

这是我们重新连接的snippets/urls.py文件。

from django.urls import path, 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,basename="snippets")
router.register(r'users', views.UserViewSet,basename="users")

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

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

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

视图与视图集之间的权衡

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

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