Django-rest-framework中过滤器的定制-优快云博客

本文链接：https://blog.youkuaiyun.com/yu359697395/article/details/78354277

本文介绍如何在Django-rest-framework中创建自定义过滤器。通过编写自定义filter.py模块并定义新的过滤类，然后在视图处理类中指定过滤器后端，将自定义过滤器应用到API视图。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

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 = []

2.将视图处理类中的，过滤器后端重新指定，将过滤器类连接到我们自定义实现的处理类上

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,)