Django Models问题：多外键场景下related_name的设置方法

为什么会出现冲突 #

当多个外键关联到同一个模型时，Django默认会生成格式为{模型名小写}_set的反向关联名称。如果不同外键的默认反向名称重复（比如同一模型内多个外键指向同一目标模型，或不同模型的外键指向同一目标模型但默认命名逻辑导致重复），就会抛出冲突错误，此时必须手动指定related_name。

related_name的取值规则 #

• 必须是合法的Python标识符：不能包含空格、特殊字符（下划线除外），不能以数字开头，符合Python变量命名规范。
• 不能与目标模型的字段名、方法名重名：避免反向关联调用时和模型自身的成员混淆。
• 语义化优先：名称要清晰体现反向关联的来源，比如从Province看关联的User，可以叫users；从Province看关联的District，可以叫districts，一眼就能区分不同的反向关联。
• 支持+号：如果不需要生成反向关联，可以设置related_name="+"，Django会跳过该外键的反向关联创建。

多外键场景的具体配置示例 #

结合你的模型结构，以下是正确的配置方式：

from django.db import models

class Province(models.Model):
    name = models.CharField(max_length=100)

class District(models.Model):
    name = models.CharField(max_length=100)
    # 明确Province下的地区反向关联名为districts
    province = models.ForeignKey(Province, on_delete=models.CASCADE, related_name="districts")

class School(models.Model):
    name = models.CharField(max_length=100)
    # 明确District下的学校反向关联名为schools
    district = models.ForeignKey(District, on_delete=models.CASCADE, related_name="schools")

class User(models.Model):
    name = models.CharField(max_length=100)
    # User关联Province的反向命名为users，和District的反向districts区分开
    province = models.ForeignKey(Province, on_delete=models.CASCADE, related_name="users")
    # User关联District的反向命名为user_profiles，和School的反向schools区分开
    district = models.ForeignKey(District, on_delete=models.CASCADE, related_name="user_profiles")
    # User关联School的反向命名为enrolled_users，明确是学校的就读用户
    school = models.ForeignKey(School, on_delete=models.CASCADE, related_name="enrolled_users")

配置后的使用示例 #

设置完成后，你可以通过反向关联轻松查询：

• 查询某省份下的所有地区：province.districts.all()
• 查询某省份下的所有用户：province.users.all()
• 查询某地区下的所有学校：district.schools.all()
• 查询某学校的所有就读用户：school.enrolled_users.all()

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