如何为Django现有模型的每个字段添加评论或标记字段？

免责声明：我可随时清空数据库，因此作答无需考虑迁移等事宜。

假设我有一个包含多个字段的Django模型：

class Compound(models.Model):
    color = models.CharField(max_length=20, blank=True, default="")
    brand = models.CharField(max_length=200, blank=True, default="")
    temperature = models.FloatField(null=True, blank=True)
    melting_temp = models.FloatField(null=True, blank=True)
    # more (~20) especially numeric values as model fields

现在想为该模型的每个字段值添加评论并存储，例如为temperature字段添加“冬季测量”的评论。自己梳理了几种思路，但各有问题：

1. 手动添加20个类似temperature_comment = ...的字段，不符合DRY原则；
2. 添加一个大JSON字段存储所有评论，但不知道如何为其创建表单，希望为每个关联值单独设置输入框，且不想使用JavaScript；
3. 创建一个Value模型，通过OneToOneField与Compound关联，但不知道如何为Compound创建统一表单，不想单独创建每个Value，且访问模型内的值也不如之前便捷。

推荐使用关联评论模型+动态表单字段的组合方案，既符合DRY原则，又能实现统一表单和便捷访问，具体实现如下：

1. 创建关联评论模型 #

创建FieldComment模型，专门存储每个字段的评论，通过外键关联Compound并记录对应字段名：

from django.db import models

class FieldComment(models.Model):
    compound = models.ForeignKey(Compound, on_delete=models.CASCADE, related_name='field_comments')
    field_name = models.CharField(max_length=50)  # 存储Compound模型的字段名，如'temperature'
    comment = models.TextField(blank=True, default="")

    class Meta:
        unique_together = ('compound', 'field_name')  # 确保每个Compound的单个字段仅对应一条评论

该方案优势：

• 完全遵循DRY原则，无需为每个字段手动添加评论字段
• 数据结构清晰，便于后续查询、维护和扩展（如添加评论时间、评论人字段）

2. 构建统一表单 #

自定义CompoundForm，动态为需要评论的字段生成对应输入框，实现原字段与评论字段的表单整合：

from django import forms
from .models import Compound, FieldComment

class CompoundForm(forms.ModelForm):
    # 定义需要添加评论的字段列表（可根据需求调整）
    COMMENT_FIELDS = ['color', 'brand', 'temperature', 'melting_temp']

    class Meta:
        model = Compound
        fields = '__all__'

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 编辑已有实例时，加载已存评论
        comment_dict = {}
        if self.instance.pk:
            comments = FieldComment.objects.filter(compound=self.instance).values('field_name', 'comment')
            comment_dict = {item['field_name']: item['comment'] for item in comments}

        # 为目标字段动态生成评论输入框
        for field_name in self.COMMENT_FIELDS:
            self.fields[f'{field_name}_comment'] = forms.CharField(
                label=f'{self.fields[field_name].label} 评论',
                required=False,
                initial=comment_dict.get(field_name, ''),
                widget=forms.Textarea(attrs={'rows': 2})
            )

    def save(self, commit=True):
        compound = super().save(commit=commit)
        # 保存评论逻辑
        if commit:
            # 先删除旧评论（编辑场景）
            FieldComment.objects.filter(compound=compound).delete()
            # 批量保存新评论
            for field_name in self.COMMENT_FIELDS:
                comment_text = self.cleaned_data.get(f'{field_name}_comment', '').strip()
                if comment_text:
                    FieldComment.objects.create(
                        compound=compound,
                        field_name=field_name,
                        comment=comment_text
                    )
        return compound

该表单特点：

• 自动整合原字段与评论字段的输入框，无需单独处理
• 编辑时自动加载已有评论，提交时自动完成评论的保存/更新
• 纯后端实现，无需依赖JavaScript

3. 便捷访问评论 #

在Compound模型中添加方法，快速获取指定字段的评论：

class Compound(models.Model):
    # 原有字段...

    def get_field_comment(self, field_name):
        try:
            return self.field_comments.get(field_name=field_name).comment
        except FieldComment.DoesNotExist:
            return ""

使用示例：

compound = Compound.objects.get(pk=1)
temp_comment = compound.get_field_comment('temperature')  # 获取temperature字段的评论

对原有思路的分析 #

• 思路1：手动添加评论字段违反DRY原则，后期维护成本极高，新增字段时需同步添加对应评论字段，完全不推荐。
• 思路2：JSON字段存储评论虽节省模型数量，但表单处理繁琐，需手动解析JSON，查询单个评论效率低，灵活性远不如关联模型。
• 思路3：OneToOne关联的Value模型会拆分原字段结构，导致访问原字段需通过关联模型，反而降低便捷性，表单整合也不如当前方案简洁。

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