DRF的过滤与排序

Posted tangda

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了DRF的过滤与排序相关的知识,希望对你有一定的参考价值。

  • 过滤

对于列表数据可能需要根据字段进行过滤,我们可以通过添加 django-filter 扩展来增强支持。

pip install django-filter

在配置文件中增加过滤后端的设置:

  1.  
    INSTALLED_APPS = [
  2.  
    ...
  3.  
    ‘django_filters‘, # 需要注册应用,
  4.  
    ]

 

  • 全局配置

在settings文件中配置:

REST_FRAMEWORK = {
    DEFAULT_FILTER_BACKENDS: (django_filters.rest_framework.DjangoFilterBackend,)  # 全局配置,对全部视图的查询多条接口都有过滤功能,但是视图里要指定字段
}

视图中指定要过滤的字段:

class EmployeeViewSet(ModelViewSet):
    queryset = Employee.objects.all()
    serializer_class = EmployeeSerializer
    # 指定可以根据哪些字段进行列表数据的过滤
    filter_fields = (gender, department)

 

  • 针对某个视图进行过滤(比较常用)

class EmployeeViewSet(ModelViewSet):
    queryset = Employee.objects.all()
    serializer_class = EmployeeSerializer

    # 指定过滤器
    filter_backends = [DjangoFilterBackend]
    # 指定可以根据哪些字段进行列表数据的过滤
    filterset_fields = (gender, department)

 

  • 使用

访问127.0.0.1/employees?gender=1时可以过滤出性别字段是1的数据。

===================================================================================================================================

  • 排序

对于列表数据,REST framework 提供了 OrderingFilter 过滤器 来实现按指定字段进行排序的功能

使用方法:

  • 在类视图中设置filter_backends,使用 rest_framework.filters.OrderingFilter(自带的模块,导包时注意) 过滤器:REST framework会在请求的查询字符串参数中检查是否包含了 ordering 参数,如果包含,则按照 ordering 参数指定的字段对数据集进行排序。
  • 在类视图中指定 ordering_fields属性,表示前端请求列表数据时,可以通过哪些字段进行排序

 

设置示例:

class EmployeeViewSet(ModelViewSet):

    queryset = Employee.objects.all()
    serializer_class = EmployeeSerializer

    # 新增排序的过滤器
    filter_backends = [..., OrderingFilter]
    # 指定可以根据哪此字段进行排序
    ordering_fields = (age, salary)

 

使用示例:

访问127.0.0.1/employees/?ordering=age(年龄升序)

访问127.0.0.1/employees/?ordering=-age(年龄降序)

访问127.0.0.1/employees/?ordering=age,-salary(先安装年龄升序来排,如果年龄一样,按工资升序来排)

以上是关于DRF的过滤与排序的主要内容,如果未能解决你的问题,请参考以下文章

DRF框架——drf-jwt手动签发与校验过滤组件筛选组件排序组件分页组件

drf框架 token签发与校验过滤/筛选/排序/分页组件

Django DRF:过滤&搜索&排序功能

DRF的分页组件,过滤组件

drf过滤和排序及异常处理的包装

drf-认证权限频率过滤排序分页