非外键Char字段使用django-select2实现自动补全与存储问题

可行性说明 #

完全可以用非外键Char字段实现django-select2的自动补全+存储新输入内容，不需要依赖外键字段。你之前的问题出在选错了widget类型。

问题根源 #

你使用的ModelSelect2Widget是为关联外键模型设计的，它会返回整个SinglePayment实例，下拉选项自然显示模型__str__方法的返回内容，选择后也会把实例的字符串表示填充到字段里，这和你要的仅显示payee/reference字段值的需求不符。

解决方案 #

根据数据量大小，有两种实现方式：

方式1：适合数据量较小的场景（本地选项）

使用Select2TagWidget，它支持自动补全现有字段值，同时允许输入新内容。在表单的__init__方法中动态获取已有的唯一字段值作为选项：

class SinglePaymentForm(forms.ModelForm):
    today = datetime.date.today()
    booking_date = forms.DateField(
        widget=DateInput(format=('%Y-%m-%d')),
        initial=today,
    )

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 获取所有非空且唯一的payee值作为补全选项
        payee_options = [(val, val) for val in SinglePayment.objects.values_list('payee', flat=True).distinct().order_by('payee') if val]
        self.fields['payee'].widget = s2forms.Select2TagWidget(choices=payee_options, attrs={'data-tags': 'true'})
        
        # 同样处理reference字段
        reference_options = [(val, val) for val in SinglePayment.objects.values_list('reference', flat=True).distinct().order_by('reference') if val]
        self.fields['reference'].widget = s2forms.Select2TagWidget(choices=reference_options, attrs={'data-tags': 'true'})

    class Meta:
        model = SinglePayment
        fields = ['account', 'booking_date', 'payee', 'reference', 'amount', 'category', 'tax_relevant', 'division', 'booked', 'to_pay', 'periodicpayment']
        widgets = {
            'booking_date': DateInput(format=('%Y-%m-%d')),
        }

方式2：适合数据量较大的场景（AJAX动态加载）

使用Select2AjaxWidget，通过后端接口动态返回匹配的字段值，避免一次性加载大量数据：

1. 先在urls.py中添加自动补全接口：

from django.http import JsonResponse
from .models import SinglePayment

def payee_autocomplete(request):
    query = request.GET.get('term', '')
    # 匹配包含查询词的payee，返回前20个唯一值
    payees = SinglePayment.objects.filter(payee__icontains=query).values_list('payee', flat=True).distinct().order_by('payee')[:20]
    return JsonResponse(list(payees), safe=False)

def reference_autocomplete(request):
    query = request.GET.get('term', '')
    references = SinglePayment.objects.filter(reference__icontains=query).values_list('reference', flat=True).distinct().order_by('reference')[:20]
    return JsonResponse(list(references), safe=False)

2. 然后修改表单的widget配置：

class SinglePaymentForm(forms.ModelForm):
    today = datetime.date.today()
    booking_date = forms.DateField(
        widget=DateInput(format=('%Y-%m-%d')),
        initial=today,
    )

    class Meta:
        model = SinglePayment
        fields = ['account', 'booking_date', 'payee', 'reference', 'amount', 'category', 'tax_relevant', 'division', 'booked', 'to_pay', 'periodicpayment']
        widgets = {
            'booking_date': DateInput(format=('%Y-%m-%d')),
            'payee': s2forms.Select2AjaxWidget(
                data_url='/your-url/payee-autocomplete/',  # 替换成实际的接口路径
                attrs={'data-tags': 'true'}
            ),
            'reference': s2forms.Select2AjaxWidget(
                data_url='/your-url/reference-autocomplete/',  # 替换成实际的接口路径
                attrs={'data-tags': 'true'}
            ),
        }

效果说明 #

两种方式都能实现：

• 输入时下拉仅显示payee/reference字段的历史值
• 允许输入新的文本内容并直接存储到字段中

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