Django表单集更新记录触发唯一字段重复错误如何解决

问题场景 #

编写了一个FBV用于批量更新选中的AccountsPlan记录，页面加载和表单填充正常，但保存时只要不修改name字段（该字段设置了unique约束），就会触发重复值错误；修改name为数据库中不存在的新值则可正常保存。

原视图核心代码：

def edit_selected_accountsplan(request):
    selected_items_str = request.GET.get('items', '')
    selected_items = [int(item) for item in selected_items_str.split(',') if item.isdigit()]
    accountsplan_to_edit = AccountsPlan.objects.filter(id__in=selected_items)

    AccountsPlanFormSet = formset_factory(form=AccountsPlanForm, extra=0)

    if request.method == 'POST':
        formset = AccountsPlanFormSet(request.POST)
        if formset.is_valid():
            # 最初的保存逻辑
            for form, accountplan in zip(formset, accountsplan_to_edit):
                accountplan.subgroup = form.cleaned_data['subgroup']
                accountplan.name = form.cleaned_data['name']
                accountplan.active = form.cleaned_data['active']
                accountplan.save()
            # 尝试过的修改逻辑
            # for form, accountplan in zip(formset, accountsplan_to_edit):
            #     form.instance = accountplan
            #     form.save()
            return redirect('confi:list_accountsplan')
    else:
        initial_data = []
        for accountplan in accountsplan_to_edit:
            initial_data.append({
                'subgroup': accountplan.subgroup,
                'name': accountplan.name,
                'active': accountplan.active,
            })
        formset = AccountsPlanFormSet(initial=initial_data)
    return render(request, 'confi/pages/accountsplan/edit_selected_accountsplan.html', context={'formset': formset})

AccountsPlan模型代码：

class AccountsPlan(models.Model):
    subgroup = models.ForeignKey(Subgroups, on_delete=models.PROTECT)
    name = models.CharField(
        max_length=100,
        unique=True,
        error_messages={
            'unique': "An account with this name already exists. Please, choose another.",
        }
    )
    active = models.BooleanField(default=True)
    show_acc = models.BooleanField(default=True)
    show_man = models.BooleanField(default=True)

    class Meta:
        verbose_name_plural = 'AccountPlans'

    def __str__(self):
        return self.name

问题原因 #

1. 使用formset_factory创建的是普通表单集，而非模型表单集，表单默认不知道要更新的是现有实例，执行unique验证时会检查整个数据库，包括当前要更新的实例本身。
2. 即使手动设置form.instance = accountplan，普通表单的验证逻辑依然不会自动排除当前实例，导致提交原有name时，系统误判为存在重复记录。

解决方案 #

方案一：改用modelformset_factory（推荐） #

直接使用模型表单集，它会自动绑定实例，验证时排除当前实例，无需手动处理初始数据和实例绑定：

修改后的视图代码：

from django.forms import modelformset_factory

def edit_selected_accountsplan(request):
    selected_items_str = request.GET.get('items', '')
    selected_items = [int(item) for item in selected_items_str.split(',') if item.isdigit()]
    
    # 使用modelformset_factory，指定查询集为选中的记录
    AccountsPlanFormSet = modelformset_factory(
        AccountsPlan,
        form=AccountsPlanForm,
        extra=0,
        fields=('subgroup', 'name', 'active')  # 指定要编辑的字段
    )

    if request.method == 'POST':
        formset = AccountsPlanFormSet(request.POST, queryset=AccountsPlan.objects.filter(id__in=selected_items))
        if formset.is_valid():
            formset.save()  # 直接保存整个表单集，无需手动循环
            return redirect('confi:list_accountsplan')
    else:
        # 初始化时传入查询集，自动填充表单数据
        formset = AccountsPlanFormSet(queryset=AccountsPlan.objects.filter(id__in=selected_items))
    
    return render(request, 'confi/pages/accountsplan/edit_selected_accountsplan.html', context={'formset': formset})

方案二：修改表单的clean_name方法（适用于必须用普通formset的场景） #

如果坚持使用普通表单集，需要在AccountsPlanForm中重写clean_name方法，验证时排除当前要更新的实例：

首先修改表单：

from django import forms
from .models import AccountsPlan

class AccountsPlanForm(forms.ModelForm):
    class Meta:
        model = AccountsPlan
        fields = ('subgroup', 'name', 'active')

    def __init__(self, *args, **kwargs):
        self.instance_id = kwargs.pop('instance_id', None)  # 接收实例ID
        super().__init__(*args, **kwargs)

    def clean_name(self):
        name = self.cleaned_data.get('name')
        if self.instance_id:
            # 排除当前实例，检查是否有其他同名记录
            exists = AccountsPlan.objects.exclude(id=self.instance_id).filter(name=name).exists()
            if exists:
                raise forms.ValidationError("An account with this name already exists. Please, choose another.")
        return name

然后修改视图，初始化表单时传入instance_id：

def edit_selected_accountsplan(request):
    selected_items_str = request.GET.get('items', '')
    selected_items = [int(item) for item in selected_items_str.split(',') if item.isdigit()]
    accountsplan_to_edit = AccountsPlan.objects.filter(id__in=selected_items)

    # 自定义表单集，传递instance_id到每个表单
    AccountsPlanFormSet = formset_factory(form=AccountsPlanForm, extra=0)

    if request.method == 'POST':
        formset = AccountsPlanFormSet(request.POST)
        if formset.is_valid():
            for form, accountplan in zip(formset, accountsplan_to_edit):
                accountplan.subgroup = form.cleaned_data['subgroup']
                accountplan.name = form.cleaned_data['name']
                accountplan.active = form.cleaned_data['active']
                accountplan.save()
            return redirect('confi:list_accountsplan')
    else:
        initial_data = []
        form_kwargs_list = []
        for accountplan in accountsplan_to_edit:
            initial_data.append({
                'subgroup': accountplan.subgroup_id,  # 外键字段需传递ID
                'name': accountplan.name,
                'active': accountplan.active,
            })
            form_kwargs_list.append({'instance_id': accountplan.id})
        
        # 初始化表单集时传入form_kwargs
        formset = AccountsPlanFormSet(initial=initial_data, form_kwargs=form_kwargs_list)
    
    return render(request, 'confi/pages/accountsplan/edit_selected_accountsplan.html', context={'formset': formset})

关键说明 #

• modelformset_factory是Django专门用于处理模型实例批量编辑的工具，会自动处理实例绑定、验证排除自身等逻辑，是批量更新模型实例的首选方案。
• 如果使用普通表单集，必须手动在表单验证中排除当前实例，否则unique约束会误判为重复。

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