在Django后台使用GenericForeignKey时，用名称替代ID选择关联对象

问题说明 #

当前项目通过GenericForeignKey让ProjectRepoStakeHolder关联Project和Repository，但在Django Admin中创建ProjectRepoStakeHolder实例时，只能手动输入目标对象的ID，无法像普通ForeignKey那样通过下拉选择对象名称来关联，需要在不修改Project和Repository主键的前提下解决该问题。

解决方案 #

方法一：使用django-admin-generic-relations第三方库 #

这是最简便的实现方式，该库专门处理Admin中GenericForeignKey的可视化关联：

1. 安装依赖

pip install django-admin-generic-relations

2. 修改admin.py配置

from django.contrib import admin
from pr_reviews.models import Project, Repository, Role, ProjectRepoStakeHolder, StakeHolder
from admin_relations.admin import GenericRelationsAdmin

class ProjectAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'is_active')

class RepoAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'is_active', 'project')

class ProjectRepoStakeholderAdmin(GenericRelationsAdmin):
    list_display = ('stake_holder', 'role', 'content_object', 'content_type')
    # 指定要渲染为下拉选择的generic字段
    generic_relations = ['content_object']

admin.site.register(Project, ProjectAdmin)
admin.site.register(Repository, RepoAdmin)
admin.site.register(ProjectRepoStakeHolder, ProjectRepoStakeholderAdmin)
admin.site.register(Role)
admin.site.register(StakeHolder)

方法二：自定义Admin表单（无需第三方库） #

如果不想引入第三方依赖，可以通过自定义表单和Admin逻辑实现：

1. 在admin.py中添加自定义表单和修改Admin类

from django.contrib import admin
from django import forms
from pr_reviews.models import Project, Repository, Role, ProjectRepoStakeHolder, StakeHolder
from django.contrib.contenttypes.models import ContentType

class ProjectRepoStakeHolderForm(forms.ModelForm):
    # 动态添加Project和Repository的选择字段
    project = forms.ModelChoiceField(queryset=Project.objects.all(), required=False)
    repository = forms.ModelChoiceField(queryset=Repository.objects.all(), required=False)

    class Meta:
        model = ProjectRepoStakeHolder
        fields = ['stake_holder', 'role', 'project', 'repository']

    def clean(self):
        cleaned_data = super().clean()
        project = cleaned_data.get('project')
        repository = cleaned_data.get('repository')
        
        # 确保只能选择其中一个对象
        if project and repository:
            raise forms.ValidationError("只能选择项目或仓库其中一个")
        if not project and not repository:
            raise forms.ValidationError("必须选择项目或仓库其中一个")
        
        return cleaned_data

    def save(self, commit=True):
        instance = super().save(commit=False)
        project = self.cleaned_data.get('project')
        repository = self.cleaned_data.get('repository')
        
        if project:
            instance.content_type = ContentType.objects.get_for_model(Project)
            instance.object_id = project.id
        elif repository:
            instance.content_type = ContentType.objects.get_for_model(Repository)
            instance.object_id = repository.id
        
        if commit:
            instance.save()
        return instance

class ProjectRepoStakeholderAdmin(admin.ModelAdmin):
    list_display = ('stake_holder', 'role', 'content_object', 'content_type')
    form = ProjectRepoStakeHolderForm
    # 隐藏原有的content_type和object_id字段，避免冲突
    exclude = ['content_type', 'object_id']

# 其他Admin注册代码保持不变
class ProjectAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'is_active')

class RepoAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'is_active', 'project')

admin.site.register(Project, ProjectAdmin)
admin.site.register(Repository, RepoAdmin)
admin.site.register(ProjectRepoStakeHolder, ProjectRepoStakeholderAdmin)
admin.site.register(Role)
admin.site.register(StakeHolder)

说明 #

• 方法一配置简单，适合快速实现；
• 方法二更灵活，可根据需求自定义验证和显示逻辑，无需依赖第三方库。

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