Django REST Framework 教程：深入理解 ViewSets 和 Routers

原创于 2025-06-01 09:03:08 发布 · 318 阅读

CC 4.0 BY-SA版权

Django REST Framework 教程：深入理解 ViewSets 和 Routers

什么是 ViewSets

在 Django REST Framework (DRF) 中，ViewSets 提供了一种高级抽象，它将常见的视图逻辑组织在一起。与传统的基于类的视图不同，ViewSet 不是处理特定的 HTTP 方法（如 GET 或 POST），而是提供操作（如 retrieve 或 update）。

ViewSet 的主要优势在于：

自动处理 URL 路由配置
减少重复代码
保持 API 端点的一致性
简化复杂 API 的实现

ViewSet 的核心类型

DRF 提供了几种内置的 ViewSet 类：

ViewSet：基础类，不提供任何默认操作
GenericViewSet：继承自 GenericAPIView，提供基本视图行为
ModelViewSet：提供完整的 CRUD 操作（list, create, retrieve, update, destroy）
ReadOnlyModelViewSet：仅提供只读操作（list, retrieve）

实战：重构视图为 ViewSet

让我们通过实际例子来理解如何将传统视图重构为 ViewSet。

用户视图重构

原始实现可能有两个视图类：

UserList：处理用户列表和创建
UserDetail：处理单个用户的检索、更新和删除

重构后可以使用一个 UserViewSet：

from rest_framework import viewsets

class UserViewSet(viewsets.ReadOnlyModelViewSet):
    """
    自动提供 list 和 retrieve 操作
    """
    queryset = User.objects.all()
    serializer_class = UserSerializer

代码片段视图重构

更复杂的例子是代码片段视图，可能包含：

SnippetList：列表和创建
SnippetDetail：检索、更新、删除
SnippetHighlight：高亮显示

重构为 ViewSet：

from rest_framework import permissions, renderers
from rest_framework.decorators import action

class SnippetViewSet(viewsets.ModelViewSet):
    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)

自定义操作

@action 装饰器是 ViewSet 的强大特性，它允许你添加不符合标准 CRUD 模式的自定义端点。关键参数包括：

detail：布尔值，决定是集合级别还是实例级别操作
methods：支持的 HTTP 方法列表
url_path：自定义 URL 路径
renderer_classes：指定渲染器

路由配置

手动绑定 URL

虽然不推荐，但可以手动将 ViewSet 绑定到 URL：

from snippets.views import SnippetViewSet

snippet_list = SnippetViewSet.as_view({
    'get': 'list',
    'post': 'create'
})
snippet_detail = SnippetViewSet.as_view({
    'get': 'retrieve',
    'put': 'update',
    'delete': 'destroy'
})

urlpatterns = [
    path('snippets/', snippet_list),
    path('snippets/<int:pk>/', snippet_detail),
]

使用 Router 自动路由

更推荐的方式是使用 DRF 的 Router：

from rest_framework.routers import DefaultRouter

router = DefaultRouter()
router.register(r'snippets', SnippetViewSet)
router.register(r'users', UserViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

DefaultRouter 提供以下功能：