教程 6:ViewSets 和 Routers
REST framework 提供了一种叫做ViewSets
的抽象行为,它可以使开发人员聚焦于 API 的状态和实现,基于常见的约定而自动进行 URL 配置。
ViewSet
和View
很像,除了它提供的是read
以及update
操作而不是 HTTP 的get
或者post
。
ViewSet
仅在被调用的时候才会和对应的方法进行绑定,当它被实例化时——通常是在使用Route
类管理 URL 配置的时候。
# 使用 ViewSet 重构代码
首先我们使用但一个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
2
3
4
5
6
7
8
现在我们使用ReadOnlyModelViewSet
自动提供了“只读”方法,并且依然想使用常规视图是那样设置了queryset
和seriallizer_class
属性,但我们不需要写 2 个类了。
下面我们修改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)
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
这次我们使用ModelViewSet
来获取完整的读和写操作。
注意,我们还使用了@action
装饰器来创建一个名为highlight
的自定义操作。这个装饰器可以用来添加任何不符合标准create/update/delete
类型的自定义端点。
默认情况下,使用@action
装饰器的自定义操作将响应GET
请求。如果我们想要一个响应POST
请求的操作,我们可以使用methods
参数指定。
默认情况下,自定义操作的 url 取决于方法名称本身。如果你想改变 url 的构造方式,你可以把url_path
作为装饰器关键字参数。
# 显式绑定 URL 和 ViewSets
仅仅在我们定义 URL 配置时 HTTP 方法才会和我们定义的行为进行绑定。为了理解细节,我们先显式的在urls.py
中进行操作:
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'
})
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
注意我们为每个ViewSet
都创建了多个 View,并且为每个 View 的行为和 HTTP 方法进行了绑定。
绑定后,我们可以像平常那样定义 URL:
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')
])
2
3
4
5
6
7
8
# 使用 Routers
因为我们使用了ViewSet
而不是View
,实际上我们不需要自己定义 URL。使用Router
类可以自动的进行上述操作,我们需要做的仅仅是正确的注册 View 到 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)),
]
2
3
4
5
6
7
8
9
10
11
12
13
向路由器注册视图集类似于提供 urlpattern。我们包含两个参数——视图的 URL 前缀和 Viewset 本身。
我们正在使用的DefaultRouter
类也会自动为我们创建 API 根视图,所以我们现在可以从views
模块中移除api_root
方法。
# 权衡 Views 和 Viewsets
viewsets 是一种很用的抽象,它帮助我们确保 URL 符合惯例,减少代码编写量,使你专注于 API 交互和设计而不是 URL 配置上。
但这并不意味这总是一种好的选择,就好象函数视图和类视图之间的权衡一样,使用 viewsets 相比于显式构建 vews,有些隐晦。
# 总结
通过少量的代码,我们构建出一个完备的 Web API,完美支持浏览器访问、用户认证、权限管理,并且支持多种返回格式。
我们经历了每步设计的过程,并且知道了如果我们需要自定义功能,可以方便的使用 Django 原生的 views.
你可以在github (opens new window)上找到最终的代码,以及模拟程序 (opens new window)。
# 展望
整个教程到这就结束了,如果你想得到更多信息,这里有几点建议:
- 在Github (opens new window)提问并且提交 pull requests。
- 加入[REST framework discussion 组](https://groups.google.com/forum/?fromgroups target=)并为社区做贡献。
- 在 Twitter 上跟随作者 (opens new window)并 say hi。