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=True
        s = 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文件下,配置路由

 # 使用视图集ModelViewSet
 url(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 DepartmentNameSerializer
    else:
        # 其它请求, 使用默认的序列化器
        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 变量的值,查看生成的路由信息
这里写图片描述

  • 1
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: DRF(Django Rest Framework)框架可以让你自定义错误处理。你可以定义一个自定义异常类来处理特定的错误,并在视图中抛出该异常。然后,在配置的异常处理器中对该异常进行处理。你也可以重写DRF的默认异常处理器来处理所有错误。 ### 回答2: 在DRF框架中,我们可以通过自定义错误处理来提供更加友好和详细的错误提示信息。自定义错误处理可以帮助我们在API开发过程中能够迅速定位和解决问题,提高开发效率。 首先,我们可以通过重写DRF中的异常处理器来自定义错误响应。通过继承`exception_handler`方法,我们可以在该方法中检查不同的异常类型,并返回相应的错误响应。可以处理的异常类型包括`APIException`、`PermissionDenied`、`AuthenticationFailed`等。 在自定义错误响应中,我们可以设置不同的错误码、错误信息和HTTP状态码,以确保错误响应符合我们的需求。例如,我们可以根据不同的异常返回不同的错误码以及对应的错误信息,可以参考HTTP状态码的规范来制定自己的错误码。 除了自定义错误响应外,我们还可以对DRF中的验证器进行自定义。通过继承DRF中的验证器类,我们可以自定义各种验证规则,以满足不同的业务需求。在自定义验证器中,我们可以通过重写验证方法来实现特定的验证逻辑。 另外,我们还可以自定义错误处理的日志记录。通过重写`handle_exception`方法,我们可以在捕获异常时,将异常的相关信息记录到日志中,便于后续排查问题。在日志记录中,我们可以输出异常的类型、错误信息、请求参数等,以便于定位问题所在。 总之,通过DRF框架的自定义错误处理功能,我们可以灵活地定制错误响应、验证规则和日志记录等,提高API开发的可维护性和稳定性。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值