视图集和路由器(ViewSets & Routers)
来源:互联网 发布:java九九乘法表打印 编辑:程序博客网 时间:2024/05/17 02:57
教程6–视图集和路由器(ViewSets & Routers)
本文由wjc133翻译发布,欢迎大家转载。
英语水平有限,仅做参考。
Demo的Github地址:https://github.com/wjc133/DRF-Tutorial
注:下文中的ViewSets和Routers就不翻译了,感觉保留原文意思更清晰。
REST框架包含了一个处理ViewSets
的抽象,力图让开发者专注于状态建模和API交互,把URL的创建过程依照通用的规范留给框架自动去完成。
ViewSet
和View
从功能上来讲其实差不多,但是ViewSet
提供的是如.read()
和.update()
之类的方法,而不是方法处理器get
和put
之类的。
一个ViewSet
仅在实例化成一组Views的最后时刻才会绑定到方法处理器上。通常是使用一个Router
对象来处理这种复杂的URL conf定义。
使用ViewSets重构
首先,重构UserList
和UserDetail
两个视图为一个视图集UserViewSet
。我们可以删掉原来的两个视图,然后用一个单一的类来代替它们:
from rest_framework import viewsetsclass UserViewSet(viewsets.ReadOnlyModelViewSet): """ 视图集会自动提供`list` 和 `detail` 行为。 """ queryset = User.objects.all() serializer_class = UserSerializer
这里我们使用的是ReadOnlyModelViewSet
,所以默认只会提供与读有关的方法。我们仍然需要像之前一样提供queryset和serialzier_class,不过不再需要为两个类提供相同的信息了。
接下来我们要重构SnippetList
、SnippetDetail
和SnippetHighlight
了。我们仍然可以用一个单一的类来代替它们:
from rest_framework.decorators import detail_routeclass SnippetViewSet(viewsets.ModelViewSet): """ 视图集会自动提供list,create, retrieve, update & destroy这些行为, 当然,我们也需要自己添加额外的highlight行为。 """ queryset = Snippet.objects.all() serializer_class = SnippetSerializer permission_classes = (permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly,) @detail_route(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
,因为我们需要全面的读写功能。
注意,我们使用了@detail_route
装饰器来定义一个自定义的行为,名字叫做highlight
。该装饰器可以用来添加任意不适用标准create
/update
/delete
的自定义endpoint。
使用@detail_route
自定义的行为,默认都是GET
请求。如果需要修改,我们可以指定methods
参数。
自定义行为的URLs默认为方法名本身,如果你希望修改,你可以在装饰器中填入url_path参数。
将视图集绑定到URL配置
处理器方法只有在我们定义了URLConf的时候才会绑定到行为。
在urls.py
文件中,我们把ViewSet
绑定到一些具体的视图上:
from snippets.views import SnippetViewSet, UserViewSet, api_rootfrom rest_framework import rendererssnippet_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'})
这里注意观察我们是通过绑定http方法和需要的行为,从ViewSet
创建多个视图的。
现在我们来将资源绑定到具体的视图,我们可以像往常一样,注册视图到URLs 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'^snippets/(?P<pk>[0-9]+)/highlight/$', snippet_highlight, name='snippet-highlight'), url(r'^users/$', user_list, name='user-list'), url(r'^users/(?P<pk>[0-9]+)/$', user_detail, name='user-detail')])
使用Routers
因为我们正在使用ViewSet
代替View
,实际上已经不再需要自己来设计URL的配置了。将资源和视图、URL绑定到一起是一个可以自动完成的过程,只需要使用Router
即可。我们需要做的就是将视图集注册到Router上去而已。
让我们重写一下urls.py
文件。
from django.conf.urls import url, includefrom snippets import viewsfrom rest_framework.routers import DefaultRouter# 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.# Additionally, we include the login URLs for the browsable API.urlpatterns = [ url(r'^', include(router.urls)), url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))]
将ViewSets注册到Routers的过程实际上类似于提供一个urlpattern。我们引入了两个参数,一个是views的URL prefix,另一个是viewset本身。
我们使用的DefaultRouter
也会自动地帮我们创建API root视图,所以我们可以删除掉api_root
方法了。
Views vs ViewSets
使用视图集是一个非常有效的行为。它有助于确保您所有的API的URL风格都是一致的,最大限度地减少你所需要编写的代码量,并是你专注于交互和业务逻辑,而不是URL conf的一些细节。
但这并不代表在所有场景下使用视图集都是好的。在讨论使用基于类的视图还是基于函数的视图时,也有一些类似的权衡。使用视图集没有自己构建View时那样明确。
在最后一个章节里,我们一起来看看如何添加API schema,并且尝试使用客户端库或者命令行工具来和我们的API进行交互。
- 视图集和路由器(ViewSets & Routers)
- Django编写RESTful API(六):ViewSets和Routers
- Django编写RESTful API(六):ViewSets和Routers
- Django-Rest-Framework 教程: 6. ViewSets 和 Routers
- Django REST framework-教程06-ViewSets and Routers 原创翻译
- Django REST FrameWork中文教程6: ViewSets&Routers
- Akka(4): Routers
- Mysql To Charts(五)--routers文件
- Routers & switches
- Linking Routers
- Django-restframework13 ViewSets
- 路由器和交换机的区别(转)
- (五)路由器破密码和重置
- 数据库视图(普通视图和物化视图)
- Django rest framework --- Routers
- 无线路由器介绍和有线路由器上网
- 路由器和无线路由器的区别
- 路由器和交换机的区别 -- 路由器
- 使用Alluxio提升HDFS集群的性能和SLA稳定性
- ChangeTabLayout实现过程
- 用vmware导入已经装好的linux 忘记密码怎么办
- STM32之CAN---接收管理分析
- Jenkins服务器磁盘空间管理策略
- 视图集和路由器(ViewSets & Routers)
- 主要的排序算法介绍
- 序列检测
- 一个程序汪的历程
- LoadRunner监控window系统各项指标详解
- [图像]用Matlab在图像上画矩形框
- vim使用记录
- linux mount cmd
- jQuery 效果