6-视图集和路由器-Django REST框架

教程6：视图集和路由器

REST框架包括用于处理ViewSets，这使开发人员能够集中精力对API的状态和交互进行建模，并根据常见约定自动处理URL构造。

ViewSet类几乎与View类，但它们提供的操作如下：read，或update，而不是方法处理程序，例如get或put.

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

重构以使用ViewSet

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

首先，让我们重构我们的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默认情况下请求。我们可以使用methods如果我们想要一个回应的行动POST请求。

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

显式地将ViewSets绑定到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内容。将资源连接到视图和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)
router.register(r'users', views.UserViewSet)

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

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

这个DefaultRouter类还会自动为我们创建API根视图，因此我们现在可以删除api_root我们的方法views模块。

视图与视图集之间的权衡

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

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