Django中ModelVoiture关联Carburant多外键冲突问题咨询

问题背景 #

在ModelVoiture模型中添加两个指向Carburant的外键字段后，出现反向访问器冲突错误，原因是Django默认生成的反向访问器名称重复。

错误信息 #

coutcarbur.ModelVoiture.prixCarburant: (fields.E304) Reverse accessor 'Carburant.modelvoiture_set' for 'coutcarbur.ModelVoiture.prixCarburant' clashes with reverse accessor for 'coutcarbur.ModelVoiture.typeCarburant'.
        HINT: Add or change a related_name argument to the definition for 'coutcarbur.ModelVoiture.prixCarburant' or 'coutcarbur.ModelVoiture.typeCarburant'.
coutcarbur.ModelVoiture.typeCarburant: (fields.E304) Reverse accessor 'Carburant.modelvoiture_set' for 'coutcarbur.ModelVoiture.typeCarburant' clashes with reverse accessor for 'coutcarbur.ModelVoiture.prixCarburant'.
        HINT: Add or change a related_name argument to the definition for 'coutcarbur.ModelVoiture.typeCarburant' or 'coutcarbur.ModelVoiture.prixCarburant'.

现有模型代码 #

class MarqueVoiture(models.Model):
    name = models.CharField(max_length=50)

    def __str__(self):
        return self.name


class Carburant(models.Model):
    name = models.CharField(max_length=50)
    prixCarburant = models.DecimalField(max_digits=6, decimal_places=2)
    typeCarburant = models.CharField(max_length=50)

    def __str__(self):
        return self.name


class ModelVoiture(models.Model):
    name = models.CharField(max_length=50)
    consolitre = models.DecimalField(
        max_digits=6, decimal_places=2)
    prixCarburant = models.ForeignKey(Carburant, on_delete=models.CASCADE)
    typeCarburant = models.ForeignKey(Carburant, on_delete=models.CASCADE)    
    marque = models.ForeignKey(MarqueVoiture, on_delete=models.CASCADE)

    def __str__(self):
        return self.name

解决方案 #

1. 使用related_name解决冲突 #

Django默认给每个外键生成的反向访问器名称为{模型名}_set，两个外键同时指向Carburant时，会生成相同的modelvoiture_set导致冲突。只需给每个外键指定唯一的related_name即可：

修改ModelVoiture中的外键定义：

class ModelVoiture(models.Model):
    name = models.CharField(max_length=50)
    consolitre = models.DecimalField(
        max_digits=6, decimal_places=2)
    # 给每个外键添加唯一的related_name
    prixCarburant = models.ForeignKey(Carburant, on_delete=models.CASCADE, related_name='voitures_par_prix')
    typeCarburant = models.ForeignKey(Carburant, on_delete=models.CASCADE, related_name='voitures_par_type')    
    marque = models.ForeignKey(MarqueVoiture, on_delete=models.CASCADE)

    def __str__(self):
        return self.name

之后从Carburant反向查询时，可以通过carburant.voitures_par_prix.all()和carburant.voitures_par_type.all()分别获取关联的车型。

2. 优化模型结构（更推荐） #

当前模型设计存在逻辑问题：一个车型应该对应一种燃油类型，而燃油的类型和价格是绑定在Carburant实例中的，拆分两个外键可能导致车型关联不同的Carburant（比如类型关联汽油，价格关联柴油），违背业务逻辑。

建议合并外键，只保留一个指向Carburant的外键：

class ModelVoiture(models.Model):
    name = models.CharField(max_length=50)
    consolitre = models.DecimalField(max_digits=6, decimal_places=2)
    # 单个外键关联Carburant
    carburant = models.ForeignKey(Carburant, on_delete=models.CASCADE)    
    marque = models.ForeignKey(MarqueVoiture, on_delete=models.CASCADE)

    def __str__(self):
        return self.name

这样访问燃油的类型和价格时，直接通过model_voiture.carburant.typeCarburant和model_voiture.carburant.prixCarburant即可，既解决了冲突问题，又符合业务逻辑。

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