如何为JSONField的Django Filter填充选择下拉框？

初始问题 #

模型中JSONField字段定义：

payload = models.JSONField()

已实现精确匹配逻辑，但ChoiceFilter的下拉框为空，过滤器代码如下：

class EventFilter(django_filters.FilterSet):

    class Meta:
        model = Message
        fields = ('event_type', 'origin')

    event_type = django_filters.ChoiceFilter(
        method='type_filter',
        label='type'
    )

    origin = django_filters.CharFilter(
        method='origin_filter',
        label='origin'
    )

    def event_type_filter(self, queryset, name, value):
        return queryset.filter(payload__event_type__exact=value)

    def origin_filter(self, queryset, name, value):
        return queryset.filter(payload__origin__exact=value)

疑问：如何填充ChoiceFilter的选择下拉框？

更新问题（2022.11.24） #

改用ModelMultipleChoiceFilter后下拉框显示值，但过滤功能失效，代码如下：

event_type = django_filters.ModelMultipleChoiceFilter(
    label='Event Type',
    lookup_expr='exact',
    field_name='payload__event_type',
    queryset=Message.objects.all().values_list('payload__event_type', flat=True).distinct(),
)

疑问：本以为distinct()会去除重复值，但用法似乎有误，求解决办法？

解决方案 #

1. 解决初始问题：填充ChoiceFilter下拉选项 #

ChoiceFilter需要明确指定choices参数生成下拉选项，可通过查询数据库中payload__event_type的去重值来生成选项列表：

修改过滤器代码如下：

class EventFilter(django_filters.FilterSet):
    # 预获取去重且非空的event_type选项，同时排序
    EVENT_TYPE_CHOICES = [
        (item, item) 
        for item in Message.objects.values_list('payload__event_type', flat=True).distinct().order_by('payload__event_type') 
        if item
    ]

    class Meta:
        model = Message
        fields = ('event_type', 'origin')

    event_type = django_filters.ChoiceFilter(
        method='event_type_filter',
        label='type',
        choices=EVENT_TYPE_CHOICES
    )

    def event_type_filter(self, queryset, name, value):
        return queryset.filter(payload__event_type__exact=value)

    origin = django_filters.CharFilter(
        method='origin_filter',
        label='origin'
    )

    def origin_filter(self, queryset, name, value):
        return queryset.filter(payload__origin__exact=value)

• 添加if item过滤空值，避免下拉框出现无效选项
• 用order_by对选项排序，提升用户体验

2. 解决更新后的问题：过滤失效与去重错误 #

你误用了ModelMultipleChoiceFilter，该过滤器针对关联模型实例设计，不适合JSONField中的字符串值，需改用ChoiceFilter或MultipleChoiceFilter，同时正确处理去重：

方案一：使用MultipleChoiceFilter（支持多选）

class EventFilter(django_filters.FilterSet):
    # 动态生成选项，确保每次加载都获取最新数据
    def get_event_type_choices(self):
        return [
            (item, item) 
            for item in Message.objects.values_list('payload__event_type', flat=True).distinct().order_by('payload__event_type') 
            if item
        ]

    event_type = django_filters.MultipleChoiceFilter(
        label='Event Type',
        lookup_expr='exact',
        field_name='payload__event_type',
        choices=get_event_type_choices,
    )

    # 其他字段定义保持不变

方案二：无需多选时用ChoiceFilter

class EventFilter(django_filters.FilterSet):
    event_type = django_filters.ChoiceFilter(
        label='Event Type',
        lookup_expr='exact',
        field_name='payload__event_type',
        # 用lambda动态生成选项
        choices=lambda: [
            (item, item) 
            for item in Message.objects.values_list('payload__event_type', flat=True).distinct().order_by('payload__event_type') 
            if item
        ],
    )

    # 其他字段定义保持不变

关键注意点

• ModelMultipleChoiceFilter要求queryset返回模型实例，而你传入的是字符串值，导致过滤逻辑不匹配，这是过滤失效的核心原因
• values_list('payload__event_type', flat=True).distinct()可以正确获取去重的字符串值，但需过滤空值避免无效选项
• 用lambda或类方法动态生成choices，能保证每次加载过滤器时获取最新的选项数据

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