Django DRF中DateFromToRangeFilter日期范围过滤失效求助

核心问题分析 #

你的代码存在三个关键问题导致过滤失效：

1. 视图未指定自定义FilterSet类，自定义的日期范围过滤逻辑未被加载
2. DateFromToRangeFilter参数配置错误，且与你期望的start_date/end_date参数名不匹配
3. 存在拼写错误：lable应为label

分步修复 #

1. 修正FilterSet配置（filter.py） #

如果要直接用start_date和end_date作为请求参数，推荐用两个DateFilter分别处理起始、结束日期，更贴合需求：

from django_filters import FilterSet, DateFilter

class ConsumeDetailsFilter(FilterSet):
    start_date = DateFilter(field_name='date', lookup_expr='gte', label='起始日期')
    end_date = DateFilter(field_name='date', lookup_expr='lte', label='结束日期')
    category = filters.CharFilter(field_name='category', lookup_expr='icontains')
    subcategory = filters.CharFilter(field_name='subcategory', lookup_expr='icontains')
    vendor = filters.CharFilter(field_name='vendor', lookup_expr='icontains')
    item = filters.CharFilter(field_name='item', lookup_expr='icontains')

    class Meta:
        model = ConsumeDetails
        fields = ['start_date', 'end_date', 'category', 'subcategory', 'vendor', 'item', 'price', 'remarks']

若坚持使用DateFromToRangeFilter，需注意它的默认参数格式为RegDate_after和RegDate_before，修正后配置如下：

from django_filters import FilterSet, DateFromToRangeFilter

class ConsumeDetailsFilter(FilterSet):
    RegDate = DateFromToRangeFilter(field_name='date', label='日期范围')
    category = filters.CharFilter(field_name='category', lookup_expr='icontains')
    subcategory = filters.CharFilter(field_name='subcategory', lookup_expr='icontains')
    vendor = filters.CharFilter(field_name='vendor', lookup_expr='icontains')
    item = filters.CharFilter(field_name='item', lookup_expr='icontains')

    class Meta:
        model = ConsumeDetails
        fields = ['RegDate','category', 'subcategory', 'vendor', 'item', 'price', 'remarks']

2. 修正视图配置（views.py） #

必须指定filterset_class加载自定义FilterSet，替换原filterset_fields：

from .filters import ConsumeDetailsFilter

class ConsumeDetailsViewSet(ModelViewSet):
    queryset = ConsumeDetails.objects.all()
    serializer_class = ConsumeDetailsSerializer
    filterset_class = ConsumeDetailsFilter
    search_fields = ['category','subcategory','vendor','item']
    pagination_class = MyPageNumberPagination

测试请求 #

方案1（start_date/end_date参数） #

请求链接：

http://127.0.0.1:8000/accounts/consumedetails/?start_date=2024-06-01&end_date=2024-06-30

方案2（DateFromToRangeFilter参数） #

请求链接：

http://127.0.0.1:8000/accounts/consumedetails/?RegDate_after=2024-06-01&RegDate_before=2024-06-30

额外注意事项 #

确保项目已正确配置django-filter：

# settings.py
INSTALLED_APPS = [
    # ...
    'django_filters',
]

REST_FRAMEWORK = {
    'DEFAULT_FILTER_BACKENDS': [
        'django_filters.rest_framework.DjangoFilterBackend',
        # 其他后端
    ]
}

内容的提问来源于stack exchange，提问作者New