Django-filter中实现多条件查询过滤器的技巧

在Django开发中，django-filter是一个非常实用的库，它可以帮助我们快速构建复杂的查询过滤器。在实际项目中，我们经常会遇到需要为同一个字段提供多种查询方式的需求，比如精确匹配、模糊匹配、范围查询等。本文将介绍如何在django-filter中优雅地实现这种多条件查询功能。

传统实现方式的局限性

在django-filter中，我们通常会这样定义过滤器：

class MyFilterSet(FilterSet):
    filter1 = CharFilter(label="精确匹配", lookup_expr="exact")
    filter2 = CharFilter(label="模糊匹配", lookup_expr="icontains")

这种方式虽然直观，但当我们需要为同一个字段提供多种查询方式时，代码会显得重复且难以维护。特别是当这些过滤器共享大部分参数（如label、method等）时，重复定义显然不够优雅。

使用LookupChoiceFilter的解决方案

django-filter提供了一个内置的LookupChoiceFilter，可以很好地解决这个问题：

price = LookupChoiceFilter(
    field_class=forms.DecimalField,
    lookup_choices=[
        ('exact', '等于'),
        ('gt', '大于'),
        ('lt', '小于'),
    ]
)

这种方式会在前端呈现一个下拉选择框，用户可以选择不同的查询条件。虽然这解决了后端代码重复的问题，但前端交互方式可能不符合所有项目的需求。

自定义MultipleLookupFilter实现

为了更灵活地控制前端表现，我们可以创建一个自定义的MultipleLookupFilter：

from django_filters import Filter

class MultipleLookupFilter(Filter):
    def __init__(self, field_class, lookup_expr, **kwargs):
        self.field_class = field_class
        self.lookup_expr = lookup_expr
        self.kwargs = kwargs

    def get_filters(self, field_name) -> dict[str, Filter]:
        filters = {}
        for lookup_expr in self.lookup_expr:
            filters[f"{field_name}__{lookup_expr}"] = self.field_class(
                lookup_expr=lookup_expr,
                **self.kwargs,
            )
        return filters

这个自定义过滤器会为每个查询表达式生成一个独立的过滤器，保持前端表单字段的独立性。

集成到FilterSet中

为了让自定义过滤器正常工作，我们需要重写FilterSet的get_declared_filters方法：

@classmethod
def get_declared_filters(cls, bases, attrs):
    filters = super().get_declared_filters(bases, attrs)
    
    multi_filters = [
        (filter_name, attrs.pop(filter_name))
        for filter_name, obj in list(attrs.items())
        if isinstance(obj, MultipleLookupFilter)
    ]

    for field_name, filter_obj in multi_filters:
        filters |= filter_obj.get_filters(field_name)

    return filters

实际应用示例

现在我们可以这样使用自定义的多条件过滤器：

activity_heat = MultipleLookupFilter(
    field_class=filters.NumberFilter,
    lookup_expr=["gte", "lte"],
    label="活动热度",
    precision=2,
    field_name="activity_heat",
)

这相当于同时创建了两个过滤器：

• activity_heat__gte：大于等于指定值
• activity_heat__lte：小于等于指定值

总结

在django-filter中实现多条件查询有多种方式，开发者可以根据项目需求选择最适合的方案：

1. LookupChoiceFilter：内置解决方案，适合需要下拉选择查询条件的场景
2. MultipleLookupFilter：自定义解决方案，适合需要独立表单字段的场景
3. Meta类fields定义：适合简单的模型字段过滤需求

自定义MultipleLookupFilter的优势在于保持了代码的DRY原则，同时提供了灵活的前端展示方式。这种模式可以进一步扩展，支持更复杂的查询场景，如多字段联合查询、自定义查询方法等。

在实际项目中，合理使用这些技术可以显著提高代码的可维护性和开发效率，特别是在构建复杂查询接口时。