如何让Django表单生成ID时用连字符替代下划线？

当然可以！Django默认会把模型字段名直接转换为带下划线的HTML ID，但你完全可以通过几种简单的方式覆盖这个默认行为，贴合HTML ID使用连字符的最佳实践。下面是几种实用方案：

1. 手动为表单字段指定自定义ID #

这是最直接的方式，在定义表单类时，给目标字段的widget手动设置attrs里的id属性，直接用连字符命名：

from django import forms
from .models import YourModel

class YourModelForm(forms.ModelForm):
    class Meta:
        model = YourModel
        fields = ['user_name', 'email_address']
        widgets = {
            'user_name': forms.TextInput(attrs={'id': 'user-name'}),
            'email_address': forms.EmailInput(attrs={'id': 'email-address'}),
        }

这种方式精准可控，适合只需要修改个别字段ID的场景。

2. 批量修改表单字段的ID生成逻辑 #

如果你的表单有很多字段，不想逐个手动设置，可以自定义表单基类，批量把下划线替换成连字符：

方法A：重写add_prefix方法 #

class HyphenatedIDModelForm(forms.ModelForm):
    def add_prefix(self, field_name):
        # 调用父类方法获取默认前缀，再替换下划线为连字符
        default_prefix = super().add_prefix(field_name)
        return default_prefix.replace('_', '-')
    
    class Meta:
        model = YourModel
        fields = '__all__'

方法B：在__init__中遍历字段修改 #

class HyphenatedIDModelForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 遍历所有字段，替换ID里的下划线
        for field_name, field in self.fields.items():
            field.widget.attrs['id'] = field_name.replace('_', '-')
    
    class Meta:
        model = YourModel
        fields = '__all__'

这两种方式都能一次性处理所有字段，节省重复代码。

3. 模板层面修改ID #

如果不想修改Python代码，也可以在模板里直接处理：

方式A：手动渲染字段并指定ID #

<!-- 代替默认的 {{ form.user_name }} -->
<div class="form-group">
    <label for="user-name">{{ form.user_name.label }}</label>
    <input type="text" id="user-name" name="{{ form.user_name.name }}" 
           value="{{ form.user_name.value|default:'' }}" 
           class="{{ form.user_name.css_classes }}">
    {% if form.user_name.errors %}
        <div class="error">{{ form.user_name.errors }}</div>
    {% endif %}
</div>

方式B：自定义模板过滤器批量转换 #

先在你的app下创建templatetags/hyphenate_filters.py：

from django import template

register = template.Library()

@register.filter
def hyphenate_id(id_string):
    return id_string.replace('_', '-')

然后在模板里加载过滤器并使用：

{% load hyphenate_filters %}

{{ form.user_name.id_for_label|hyphenate_id }}
<!-- 渲染出来就是 user-name 而非 user_name -->

重要提示 #

不管用哪种方式，请不要修改字段的name属性！Django的表单处理依赖name属性和模型字段名的匹配（下划线格式），如果修改了name，表单提交后可能无法正确绑定到模型字段，导致数据无法保存。我们只需要修改id属性即可，兼顾HTML规范和Django的表单逻辑。

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