Django中编辑含一对多关联对象的表单最佳实践

下面是实现父模型与可变长度子对象表单同页编辑的标准流程：

1. 定义模型、表单及Formset #

假设你有一对多关联的模型，比如订单和订单项：

# models.py
from django.db import models

class Order(models.Model):
    customer_name = models.CharField(max_length=100)
    order_date = models.DateField()

class OrderItem(models.Model):
    order = models.ForeignKey(Order, on_delete=models.CASCADE, related_name="items")
    product_name = models.CharField(max_length=100)
    quantity = models.IntegerField()

接下来定义父表单和子表单，再通过formset_factory创建子对象的formset：

# forms.py
from django import forms
from django.forms import formset_factory
from .models import Order, OrderItem

class OrderForm(forms.ModelForm):
    class Meta:
        model = Order
        fields = ["customer_name", "order_date"]

class OrderItemForm(forms.ModelForm):
    class Meta:
        model = OrderItem
        fields = ["product_name", "quantity"]
        # 隐藏外键字段，后续在视图中关联父对象
        widgets = {"order": forms.HiddenInput()}

# 创建formset，设置额外显示的空表单数量
OrderItemFormSet = formset_factory(OrderItemForm, extra=1)

如果是编辑场景，更推荐用modelformset_factory，它会自动关联父对象的子对象queryset：

from django.forms import modelformset_factory

OrderItemFormSet = modelformset_factory(
    OrderItem,
    form=OrderItemForm,
    extra=1,
    # 限制只能编辑当前订单的子对象
    queryset=OrderItem.objects.none()
)

2. 视图中处理表单与Formset的逻辑 #

无论是创建还是编辑，核心逻辑是同时处理父表单和formset的验证与保存：

创建新对象的视图 #

# views.py
from django.shortcuts import render, redirect
from .forms import OrderForm, OrderItemFormSet
from .models import Order

def create_order(request):
    if request.method == "POST":
        order_form = OrderForm(request.POST)
        item_formset = OrderItemFormSet(request.POST)
        
        if order_form.is_valid() and item_formset.is_valid():
            # 先保存父对象
            order = order_form.save()
            # 遍历formset，给每个子对象设置父实例后保存
            for form in item_formset:
                if form.cleaned_data:  # 跳过空表单
                    item = form.save(commit=False)
                    item.order = order
                    item.save()
            return redirect("order_detail", pk=order.pk)
    else:
        order_form = OrderForm()
        item_formset = OrderItemFormSet()
    
    return render(request, "create_order.html", {
        "order_form": order_form,
        "item_formset": item_formset
    })

编辑现有对象的视图 #

def edit_order(request, pk):
    order = Order.objects.get(pk=pk)
    if request.method == "POST":
        order_form = OrderForm(request.POST, instance=order)
        # 初始化formset时传入当前订单的子对象queryset
        item_formset = OrderItemFormSet(
            request.POST,
            queryset=order.items.all()
        )
        
        if order_form.is_valid() and item_formset.is_valid():
            order_form.save()
            # 处理formset的保存，包括新增、修改、删除
            for form in item_formset:
                if form.cleaned_data:
                    item = form.save(commit=False)
                    item.order = order
                    item.save()
            # 删除标记为删除的对象（如果启用了can_delete）
            for deleted_form in item_formset.deleted_forms:
                deleted_form.delete()
            return redirect("order_detail", pk=order.pk)
    else:
        order_form = OrderForm(instance=order)
        item_formset = OrderItemFormSet(queryset=order.items.all())
    
    return render(request, "edit_order.html", {
        "order_form": order_form,
        "item_formset": item_formset
    })

如果用modelformset_factory，可以启用can_delete参数，自动生成删除复选框：

OrderItemFormSet = modelformset_factory(
    OrderItem,
    form=OrderItemForm,
    extra=1,
    can_delete=True
)

3. 模板中渲染表单与Formset #

模板需要同时渲染父表单和formset，注意必须渲染formset的management_form（Django用来跟踪表单数量和索引的隐藏字段）：

<!-- create_order.html -->
<form method="post">
    {% csrf_token %}
    
    <h3>订单信息</h3>
    {{ order_form.as_p }}
    
    <h3>订单项</h3>
    <!-- 必须渲染management_form -->
    {{ item_formset.management_form }}
    
    {% for form in item_formset %}
        <div class="item-form">
            {{ form.as_p }}
            <!-- 如果启用了can_delete，渲染删除复选框 -->
            {% if item_formset.can_delete %}
                {{ form.DELETE }} 删除
            {% endif %}
        </div>
    {% endfor %}
    
    <button type="submit">保存</button>
</form>

4. 常见优化：动态添加/删除Formset表单 #

如果需要让用户动态添加更多子表单，可以用JavaScript实现：

// 模板中添加JS代码
<script>
document.addEventListener('DOMContentLoaded', function() {
    const addButton = document.createElement('button');
    addButton.textContent = '添加订单项';
    document.querySelector('form').appendChild(addButton);
    
    addButton.addEventListener('click', function(e) {
        e.preventDefault();
        const formContainer = document.querySelector('.item-form').parentNode;
        const totalForms = document.getElementById('id_form-TOTAL_FORMS');
        const formIndex = parseInt(totalForms.value);
        
        // 克隆现有表单，替换索引
        const newForm = document.querySelector('.item-form').cloneNode(true);
        newForm.innerHTML = newForm.innerHTML.replace(/form-\d-/g, `form-${formIndex}-`);
        
        // 清空克隆表单的输入值
        newForm.querySelectorAll('input').forEach(input => {
            if (input.type !== 'hidden') input.value = '';
        });
        
        // 添加到页面
        formContainer.appendChild(newForm);
        totalForms.value = formIndex + 1;
    });
});
</script>

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