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

在 Django 项目开发中，我们经常需要为模型数据提供灵活的过滤功能。django-filter 作为 Django 生态中强大的过滤组件，为开发者提供了便捷的 API 来实现各种过滤需求。本文将介绍如何扩展 django-filter 的功能，实现支持多种查询条件的自定义过滤器。

需求背景

在实际开发中，我们经常会遇到这样的场景：对于同一个字段，需要支持多种查询方式。例如，一个数值字段可能需要同时支持大于、小于、等于等多种比较方式。按照传统做法，我们需要为每种查询条件单独定义一个过滤器，这会导致代码重复和维护困难。

解决方案

我们可以通过创建自定义过滤器类 MultipleLookupFilter 来解决这个问题。这个过滤器类能够根据配置自动生成多个具有不同查询条件的过滤器。

核心实现

首先，我们创建一个继承自 Filter 的自定义过滤器类：

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

这个类的核心思想是：

1. 接收一个字段类型（如 NumberFilter）和一组查询表达式（如 ['gte', 'lte']）
2. 根据这些参数动态生成多个过滤器实例
3. 返回一个包含所有生成过滤器的字典

集成到 FilterSet

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

@classmethod
def get_declared_filters(cls, bases, attrs):
    filters = super().get_declared_filters(bases, attrs)

    # 收集并处理 MultipleLookupFilters
    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.update(filter_obj.get_filters(field_name))

    return filters

这段代码会：

1. 获取所有已声明的过滤器
2. 找出所有 MultipleLookupFilter 实例
3. 将它们转换为实际的过滤器并合并到最终结果中

实际应用

使用这个自定义过滤器非常简单：

activity_heat = MultipleLookupFilter(
    field_class=filters.NumberFilter,
    lookup_expr=["gte", "lte"],
    label="Activity Heat",
    precision=2,
    field_name="activity_heat",
)

这样就会自动生成两个过滤器：

• activity_heat__gte：用于大于等于查询
• activity_heat__lte：用于小于等于查询

优势与扩展

这种实现方式具有以下优点：

1. 代码简洁：避免了为每个查询条件重复定义相似的过滤器
2. 维护方便：修改查询条件只需在一个地方调整
3. 扩展性强：可以轻松支持更多查询条件

如果需要进一步扩展功能，可以考虑：

1. 支持自定义每个查询条件的标签
2. 添加验证逻辑确保查询条件的有效性
3. 支持动态生成查询条件

总结

通过自定义 MultipleLookupFilter，我们能够优雅地实现 django-filter 中多条件查询的需求。这种方法不仅提高了代码的可维护性，还能让 API 接口更加灵活和强大。对于需要提供复杂过滤功能的 Django 项目来说，这是一个值得考虑的实现方案。