Django REST Framework 自定义过滤器实现指南

自定义过滤器的定义与配置

首先，需要创建一个名为 filter.py 的模块，并在其中定义一个新的过滤类。这是实现自定义过滤功能的基础步骤。

import django_filters
#这个Q可以支持表查询，单下划线获取表字段，双下划线获取关联表，
from django.db.models import Q
#引入自己的模型
from app.item.models import ItemCategory
#自定义的过滤类，需要继承django_filter.rest_framework中的FilterSet类
class ItemCategoryFilter(django_filters.rest_framework.FilterSet):
  Filter_category = django_filters.NumberFilter(method='category_filter', label='Filter_category')
  #django_filters.NumberFilter类似，ModelForm中字段类型的控制
  #其中method指向自己定义的过滤函数，label用于标识在测试API界面中的过滤界面字段，Filter_category控制查询字段
  def category_filter(self, queryset, name, value):
    #这里用到多级联表查询
    return queryset.filter(Q(category_id=value)|Q(category__parent_id=value)|Q(category__parent__parent_id=value)|Q(category__parent__parent__parent_id=value))
  class Meta:
    model = ItemCategory
    fields = []

接下来，在视图处理类中重新指定过滤器后端。将之前自定义实现的过滤类与视图中的 filter_backends 和 filter_class 属性关联起来，使视图能够调用该自定义过滤逻辑。

class ItemsListByCategory(generics.ListCreateAPIView):
  '''
    根据category编号获取相关模型no。
    请求中请带有参数category
    @:require param: category
    such as: GET /itemsListByCategory/?Filter_category=2
  '''
  from django_filters.rest_framework import DjangoFilterBackend
  from app.item.filters import ItemCategoryFilter

  queryset = ItemCategory.objects.all()
  serializer_class = ItemCategorySerializer
  pagination_class = CommonPagination
  # 在这里哦
  filter_backends = (DjangoFilterBackend,)
  filter_class =ItemCategoryFilter
  permission_classes = (ReadOnly,)

补充知识：在 Django REST Framework 中，自定义过滤器允许开发者通过继承 FilterSet 类来定义特定的过滤规则。利用 Django 的 Q 对象，可以构建复杂的查询条件，支持单下划线获取表字段或双下划线获取关联表字段，从而实现多级联表查询。

class AlertFilter(django_filters.rest_framework.FilterSet):
  
   .......
  to_bearer_service = django_filters.rest_framework.CharFilter(method='to_bearer_service_filter', label='bearer_service')

  class Meta:
    model = Alert
    fields = [......, 'to_bearer_service']

  @staticmethod  # 如果想获取请求信息可以去掉这个静态方法的装饰器，为什么要加静态方法装饰器我也不清楚
  def to_bearer_service_filter(queryset, name, value):
    Q_id = Q()
    for i in value.split(","):
      if i == "0":
        Q_id.add(Q(**{'to_bearer_service':None}), Q.OR)
      else:
        Q_id.add(Q(**{'to_bearer_service_id': int(i)}), Q.OR)
    queryset = queryset.filter(Q_id)
    return queryset
 
 
  def to_bearer_service_filter(self, queryset, name, value):
    Q_id = Q()
    for i in value.split(","):
      if i == "0":
        Q_id.add(Q(**{'to_bearer_service':None}), Q.OR)
      else:
        Q_id.add(Q(**{'to_bearer_service_id': int(i)}), Q.OR)
    queryset = queryset.filter(Q_id)
    return queryset

以上内容涵盖了 Django REST Framework 中过滤器定制的核心步骤，包括自定义过滤类的定义、视图中的配置以及具体的查询逻辑实现。希望这些内容能为开发者提供有效的参考，助力更高效地构建灵活的 API 接口。