DRF框架的视图（视图集）

本文主要是介绍DRF框架的视图（视图集），希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

把同一种http请求方法的多个业务操作放在同一个视图，比如：查询多条数据和一条数据都是get请求，想放在同一个视图实现，这时可以使用视图集解决这个问题

一、视图集的分类
1、ViewSet

继承自APIView
与APIView基本类似，提供了身份认证、权限校验、流量管理等
没有提供任何动作action方法，需要我们自己实现action方法

2、GenericViewSet

继承自GenericAPIView
作用与 GenericAPIVIew 类似，提供了get_object、get_queryset 等方法，便于列表视图与详情信息视图的开发
通常会结合 ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestroyModelMixin 中一个或多个扩展类使用

3、ModelViewSet

继承自GenericAPIVIew
包括了 ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestroyModelMixin

4、ReadOnlyModelViewSet

继承自 GenericAPIVIew
包括了 ListModelMixin、RetrieveModelMixin

二、视图集的用法
视图集类不再定义get()、post()、put()等方法，而是将对数据的一组action动作（action: 业务操作）放在一个类中：
list() 获取多条数据
retrieve() 获取一条数据
create() 创建数据
update() 修改数据
destroy() 删除数据
只在使用视图集的as_view()方法时，才会将 action操作 与 请求方式 对应上

1、ViewSet的使用
1）、定义类视图，继承ViewSet

class DepartmentViewSet(ViewSet):"""部门视图集使用ViewSet时，具体的业务逻辑还是需要开发人员编写"""def list(self, request):"""查询多条数据"""# 查询部门所有数据query_set = Department.objects.all()# 创建序列化器，当传入的是查询集需要设置many=Trues = DepartmentSerializer2(query_set, many=True)# 返回序列化后的字典数据return Response(s.data)def retrieve(self, request, pk):"""查询一条数据"""try:# 获取模型类对象dep = Department.objects.get(pk=pk)except Department.DoesNotExist:return Response(status=404)# 创建序列化器，传入需要操作的模型类对象s = DepartmentSerializer2(dep)# 返回序列化后的字典数据return Response(s.data)

2）、在对应的应用下的urls.py文件下，配置路由

# 使用视图集ViewSet
# 在as_view()中添加一个字典参数，用于将action操作与请求方式对应上
url(r'^departments4/$', views.DepartmentViewSet.as_view({'get': 'list'})), 
url(r'^departments4/(?P<pk>\d+)/$', views.DepartmentViewSet.as_view({'get': 'retrieve'}))

2、GenericViewSet + Mixin扩展类的使用
1）、定义类视图，继承GenericViewSet, ListModelMixin, RetrieveModelMixin

class DepartmentViewSet2(GenericViewSet, ListModelMixin, RetrieveModelMixin):# 指定查询集queryset = Department.objects.all()# 指定序列化器serializer_class = DepartmentSerializer2# 可以不写，因为ListModelMixin父类已经有list()方法def list(self, request, *args, **kwargs):# 返回ListModelMixin父类的list()方法return super().list(request, *args, **kwargs)# 可以不写，因为RetrieveModelMixin父类已经有retrieve()方法def retrieve(self, request, *args, **kwargs):return super().retrieve(request, *args, **kwargs)

2）、在对应的应用下的urls.py文件下，配置路由

# 使用视图集GenericViewSet + Mixin扩展类
url(r'^departments5/$', views.DepartmentViewSet2.as_view({'get': 'list'})),
url(r'^departments5/(?P<pk>\d+)/$', views.DepartmentViewSet2.as_view({'get': 'retrieve'}))

3、ModelViewSet的使用
1）、定义类视图，继承ModelViewSet

class EmployeeViewSet(ModelViewSet):"""员工视图集封装增删改查（查询一条，多条）"""# 指定视图使用的查询集queryset = Employee.objects.all()# 指定视图使用的序列化器，所使用的序列化器必须继承ModelSerializer封装了对数据库的增删改查serializer_class = EmployeeSerializer2

2）、在对应的应用下的urls.py文件下，配置路由

 # 使用视图集ModelViewSeturl(r'^employees/$', views.EmployeeViewSet.as_view({'get': 'list', 'post': 'create'})),url(r'^employees/(?P<pk>\d+)/$', views.EmployeeViewSet.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'}))

三、自定义action方法
在视图集中，除了上述默认的5个 action 外，还可以添加自定义action，实现自己需求的逻辑业务
添加自定义动作需要使用rest_framework.decorators.action装饰器，action装饰器参数如下：

methods: 支持的请求方式，列表类型
detail: 是否要根据主键操作一个模型类对象True 要根据主键操作一个模型类对象，路由需要正则配置主键，方法需要定义额外参数接收主键False 不需要根据主键操作一个模型类对象，路由不需要正则配置主键，方法不需要定义额外参数接收主键

ViewSet的 action 属性： 获取当前请求的action名称，取出的值为： list，retrieve，create，update，destroy，或者自定义的action名

# detail为False 表示不需要根据主键操作一个模型类对象
@action(methods=['get'], detail=False)
def latest(self, request):"""自定义action: 查询最新成立的部门"""# 按照成立时间获取最新的部门department = Department.objects.latest('create_date')# 使用get_serializer方法获取到当前视图使用的序列化器serializer = self.get_serializer(department)return Response(serializer.data)# detail为true表示需要根据主键操作一个模型类对象，则方法需要添加一个`pk`参数，来接收url传进来的主键
@action(methods=['put'], detail=True)
def name(self, request, pk):"""自定义action: 只修改部门名称"""# 通过get_object()根据主键pk获取到具体的数据dep = self.get_object()# 通过request.data获取修改的部门名称dep.name = request.data.get('name')# 保存数据dep.save()# 使用get_serializer方法获取到当前视图使用的序列化器serializer = self.get_serializer(dep)return Response(serializer.data)

四、 根据不同的action 属性，使用不同的序列化器
需求：当action方法不同时，就需要使用不同的序列化器

# 重写get_serializer_class方法，判断不同的action，使用不同的序列化器
def get_serializer_class(self):"""使用不同的序列化器"""if self.action == 'name':  # name为自定义的action(修改部门名称)# 如果是修改部门名称,就使用一个特殊的序列化器return DepartmentNameSerializerelse:# 其它请求, 使用默认的序列化器return DepartmentSerializer2

五、视图集的路由配置
作用：简化视图集的路由操作

---

REST framework提供了两个router，来动态生成url
1、SimpleRouter
2、DefaultRouter
DefaultRouter与SimpleRouter的区别是，DefaultRouter会多附带一个默认的API根视图，返回一个包含所有列表视图的超链接响应数据。

---

使用方法：
1、在对应的应用下的urls.py中创建router对象，并注册视图集，并追加路由配置

# 创建router对象
router = SimpleRouter()
# 注册视图集
# 参数1：prefix  该视图集的路由前缀，加r是为了不转义，当没有特殊字符时可不加
# 参数2：viewset  视图集
# 参数3：base_name 路由名称的前缀，只指定可不指定，紧紧是一个标识
router.register(r'departments', DepartmentViewSet2, base_name='dep')
# 追加路由配置
urlpatterns += router.urls

2、测试： 在python console中输出 urlpatterns 变量的值，查看生成的路由信息

这篇关于DRF框架的视图（视图集）的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！

---