第六章 ViewSets和Routers
写在前面:
本文翻译于django rest framework官方文档,由于网上大多数django rest framework中文翻译文档都有较为多的删减行为,笔者在学习的时候就觉得不是太方便,故笔者将官方文档较为完善的为大家翻译下,仅供大家学习参考。++由于笔者文笔有限,若有写得不当之处,敬请各位同仁指出;若涉及到侵权,请联系笔者,笔者将立即删除。++
REEST Framework
包括了一个用于处理ViewSets
的机制,能够让开发人员集中精力于对API的状态和交互进行建模,并根据约定自动处理URL构造。
可以说ViewSets
类和View
类几乎是一样的,他们提供read
和update
之类的操作外,而不是get
和put
等方法处理程序
一个ViewSets
类只在最后时刻绑定到一组方法处理程序中,当他被实例化为一组视图时,通常会用到一个叫Router
的类来定义URL conf的复杂性。
1. 重构代码以使用ViewSets
我们现在重构我们的UserList
和UserDetail
,使用一个简单的UserViewSets
。我们可以移除这两个视图,用一个简单的类来替换他们
from rest_framework import viewSets
class UserViewSet(viewsets.ReadOnlyModelViewSet):
'''
这个视图集自动的提供了“list”和“detail“操作
'''
queryset = User.objects.all()
serializer_class = UserSerializer
在这里我们使用ReadOnlyModelViewSet
来自动提供默认的read-only操作,我们需要和使用常规视图一样设置queryset
和serializer_class
属性。但我们不需要将同样的信息分割到两个类中去。
同理,我们在使用SnippetViewSet
来代替SnippetListView
和SnippetDetailView
class SnippetViewSet(viewsets.ModelViewSet):
"""
这个视图集自动的提供了增删查改的功能
"""
queryset = Snippet.objects.all()
serializer_class = SnippetSerializer
permission_classes = (permissions.IsAuthenticatedOrReadOnly,
IsOwnerOrReadOnly,)
def perform_create(self, serializer):
serializer.save(owner=self.request.user)
这次我们使用了ModelViewSet
类来获得一组完整的默认读写操作,因为这个类不像用户类一样,这个类是可读可写的。
2. 显式的将ViewSets绑定到URL
当我们定义到URL Conf时,处理程序方法只绑定到动作。
urls.py
from snippets.views import SnippetViewSet, UserViewSet, api_root
snippet_list = SnippetViewSet.as_view({
'get': 'list',
'post': 'create'
})
snippet_detail = SnippetViewSet.as_view({
'get': 'retrieve',
'put': 'update',
'patch': 'partial_update',
'delete': 'destroy'
})
user_list = UserViewSet.as_view({
'get': 'list'
})
user_detail = UserViewSet.as_view({
'get': 'retrieve'
})
可以注意到我们在一个ViewSet
类里都创建了很多个视图,通过将http方法和每个视图所需要的操作相绑定来完成指定的操作。
现在我们已经将我们的资源绑定到了具体的视图当中,我们可以像往常一样使用URL conf来注册视图。
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'^users/$', user_list, name='user-list'),
url(r'^users/(?P<pk>[0-9]+)/$', user_detail, name='user-detail')
])
3. 使用Routers
因为我们现在是用的是ViewSets而不是View,所以我们不需要自己去设计URL Conf。将资源接入视图和网址的约定可以使用Router类来自动处理。所有我们需要做的就是使用一个router来注册适当,它自己就会把其他的都做了。
接下来的就是我们重新接入的 urls.py 文件。
from django.conf.urls import url, include
from snippets import views
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
router.register(r'snippets', views.SnippetViewSet)
router.register(r'users', views.UserViewSet)
urlpatterns = [
url(r'^', include(router.urls.)),
url(r'^api-auth/', include("rest_framework.urls", namespace="rest_framework"))
]
用router注册视图集类似于提供urlpatterns,我们包括了两个参数,视图的URL前缀和视图集本身
我们使用的DefaultRouter
类会为我们自动创建API根视图,因此我们可以从视图模块中删除api_root方法
4. 视图与视图集之间的平衡
使用视图集是一种很好的方式,它有助于确保URL约定在你的API之间保持一致,最大限度的减少您需要编写的代码量,并且允许你专注于API提供的交互和表示,而不是具体的URL conf。
但这并不意味着它总是最好的方法。当使用基于类的视图的时候,需要考虑一组类似的权衡,与单独构建的视图相比,使用视图集不够明确。
5. 下一步
在本教程的第七部分,我们将讨论如何添加API模式,并使用客户端或命令行工具与我们的API进行交互