Django 3.2中如何支持含复合主键的中间表？

问题背景 #

在Django 3.2中定义了如下模型，使用Admin UI添加新Challenge时，出现错误：column challenge_countries.id does not exist。challenge_countries表无id列，以challenge_id和country_id作为复合主键，且无法为该表添加id列。

此前尝试移除ChallengeCountry中的unique_together，并给challenge和country字段设置primary_key=True，但迁移时触发双重错误：

• challenges.ChallengeCountry: (models.E026) The model cannot have more than one field with 'primary_key=True'
• <class 'challenges.admin.ChallengesAdmin'>: (admin.E013) The value of 'fieldsets[1][1]["fields"]' cannot include the ManyToManyField 'countries', because that field manually specifies a relationship model

原模型代码 #

import uuid
from django.db import models

class Country(models.Model):
    id = models.UUIDField(
        primary_key=True,
        default=uuid.uuid4,
        editable=False,
    )
    country_name = models.TextField(blank=False, null=True)
    country_iso = models.TextField(blank=False, null=True)

    class Meta:
        managed = False
        db_table = "countries"

class ChallengeCountry(models.Model):
    challenge = models.ForeignKey(
        "Challenge",
        on_delete=models.CASCADE,
        related_name="challenge",
        db_column="challenge_id"
    )
    country = models.ForeignKey(
        Country,
        on_delete=models.DO_NOTHING,
        related_name="country",
        db_column="country_id"
    )

    class Meta:
        managed = False
        db_table = "challenge_countries"
        unique_together = ["challenge", "country"]

class Challenge(models.Model):
    id = models.UUIDField(
        primary_key=True,
        default=uuid.uuid4,
        editable=False,
    )
    name = models.TextField(blank=False, null=True)
    countries = models.ManyToManyField(
        Country,
        related_name="challenges",
        verbose_name="country",
        blank=True,
        through=ChallengeCountry,
        through_fields=("challenge", "country")
    )

    class Meta:
        managed = False
        db_table = "challenges"

原Admin代码片段 #

class ChallengesAdmin(admin.ModelAdmin):
    form = ChallengeForm
    ...
    filter_horizontal = [
        "countries",
    ]
    fieldsets = [
        (
            None,
            {
                "fields": [
                    "id",
                    "name",
                    ...
                ]
            },
        ),
        (
            "Countries",
            {
                "fields": ["countries"],
                "description": """
                    If no countries are selected,
                    the challenge will be visible to all users
                """,
            },
        ),
    ]
    ...

解决方案 #

1. 正确映射复合主键 #

Django不允许单个模型存在多个primary_key=True字段，对于非托管的复合主键表，需通过Meta类的primary_key_together定义主键结构，同时修正容易冲突的related_name：

修改ChallengeCountry模型：

class ChallengeCountry(models.Model):
    challenge = models.ForeignKey(
        "Challenge",
        on_delete=models.CASCADE,
        related_name="challenge_countries",  # 修正反向关联名称，避免冲突
        db_column="challenge_id"
    )
    country = models.ForeignKey(
        Country,
        on_delete=models.DO_NOTHING,
        related_name="challenge_countries",
        db_column="country_id"
    )

    class Meta:
        managed = False
        db_table = "challenge_countries"
        primary_key_together = ("challenge", "country")  # 定义复合主键

2. 修复Admin配置错误 #

由于手动指定了through模型的ManyToMany字段，无法直接在fieldsets或filter_horizontal中使用countries，需改用Inline组件管理关联数据：

步骤1：创建Inline类

class ChallengeCountryInline(admin.TabularInline):
    model = ChallengeCountry
    extra = 1  # 默认显示1个新增行
    raw_id_fields = ("country",)  # 若Country数据量大，用raw_id提升体验
    verbose_name = "关联国家"
    verbose_name_plural = "关联国家"

步骤2：更新ChallengesAdmin

class ChallengesAdmin(admin.ModelAdmin):
    form = ChallengeForm
    inlines = [ChallengeCountryInline]  # 添加Inline管理关联
    # 移除原filter_horizontal中的countries配置
    # filter_horizontal = ["countries"]
    
    fieldsets = [
        (
            None,
            {
                "fields": [
                    "id",
                    "name",
                    ...
                ]
            },
        ),
        # 移除原Countries字段集
    ]
    ...

3. 处理迁移问题 #

由于所有模型均为managed=False（Django不管理表结构），无需生成新的迁移文件。若之前的错误迁移记录存在，可运行以下命令标记迁移已完成：

python manage.py migrate --fake challenges

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