如何将Django模型ManyToMany字段的多选组件改为支持多选的下拉列表

现有代码错误点 #

• 表单关联模型错误：你需要修改的多对多字段brg_benchmark属于Brg模型，但你定义的是Chain模型对应的表单，配置完全不生效
• 语法错误：Meta类中给model赋值应该用等号=，你写的model: Chain是无效语法
• 配置字段错误：你修改的控件对应字段是chain_name，和你要调整的brg_benchmark字段无关
• 字段配置缺失：你注释掉了fields参数，Django ModelForm不会默认渲染任何字段，必须显式指定要展示的字段

正确实现方式 #

1. 原生Django实现多选下拉 #

修改你的forms.py代码如下：

from django import forms
from .models import Brg

class BrgForm(forms.ModelForm):
    class Meta:
        model = Brg
        # 放开字段配置，指定要渲染的字段
        fields = ('campaign_tracking', 'brg_name', 'brg_benchmark',)
        widgets = {
            # 给多对多字段指定多选下拉控件，size设为1即展示为下拉样式
            'brg_benchmark': forms.SelectMultiple(attrs={'size': 1})
        }

渲染后前端为下拉样式的多选框，按住Ctrl即可多选多个选项。

2. 大数据量优化方案（带搜索的多选下拉） #

如果选项数量极大，推荐使用带搜索功能的多选下拉，适配你的场景：

1. 安装依赖：pip install django-select2
2. 在项目settings.py的INSTALLED_APPS中添加django_select2
3. 修改forms.py代码：

from django import forms
from django_select2.forms import ModelSelect2MultipleWidget
from .models import Brg, Chain

class BrgForm(forms.ModelForm):
    class Meta:
        model = Brg
        fields = ('campaign_tracking', 'brg_name', 'brg_benchmark',)
        widgets = {
            'brg_benchmark': ModelSelect2MultipleWidget(
                model=Chain,
                # 配置搜索字段，支持按连锁名称模糊搜索
                search_fields=['chain_name__icontains'],
                # 配置最多选5个，和你模型的提示保持一致
                max_results=5
            )
        }

实现后可以直接在下拉框搜索对应选项，不用滚动查找，适配大数量级的选项场景。

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