Django REST Framework中如何限制已关联Link的API选项列表？

我正在使用Django REST Framework开发，现有Event、Performer、Link三个模型。Event和Performer模型均通过名为links的多对多字段关联Link模型。在API视图中创建或更新Event或Performer时，系统会展示所有Link对象作为选项，我希望已关联到其他对象的Link不再显示为可选，但不知如何实现。

模型代码 #

class Link(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    address = models.URLField()

    def __str__(self):
        return f"{self.address}"

    class Meta:
        ordering = ['created']


class Performer(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    first_name = models.CharField(max_length=20)
    last_name = models.CharField(max_length=20)
    links = models.ManyToManyField(Link)

    def __str__(self):
        return f"{self.first_name} {self.last_name}"

    class Meta:
        ordering = ['created']


class Event(models.Model):
    created = models.DateTimeField(auto_now_add=True)
    sale_date = models.DateTimeField()
    event_date = models.DateTimeField()
    performer = models.ForeignKey(Performer, on_delete=models.CASCADE)
    links = models.ManyToManyField(Link)

    class Meta:
        ordering = ['event_date']

序列化器代码 #

class LinkSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Link
        fields = ['url', 'address']


class PerformerSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Performer
        fields = ['url', 'first_name', 'last_name', 'links']


class EventSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Event
        fields = ['url', 'performer', 'sale_date', 'event_date', 'links']

我考虑过使用ManyToManyField.limit_choices_to，但不知道筛选条件该如何编写；也想过使用Link.objects.exclude(...)或Link.objects.filter(...)，但不清楚该在何处调用。

补充说明：我原本认为可以用limit_choices_to过滤掉已关联的Link，但不知道如何判断对象是否处于关联关系中，而且由于存在多个关联关系，只检测其中一个并不完善。

方法一：自定义序列化器字段，覆盖查询集 #

在序列化器中自定义links字段，通过get_queryset方法动态过滤掉已被其他对象关联的Link，同时保留更新操作时当前对象已关联的Link。

修改PerformerSerializer #

from django.db.models import Q

class PerformerSerializer(serializers.HyperlinkedModelSerializer):
    links = serializers.HyperlinkedRelatedField(
        many=True,
        view_name='link-detail',
        queryset=Link.objects.all(),
        required=False
    )

    def get_queryset(self):
        # 筛选所有已被Performer或Event关联的Link
        used_links = Link.objects.filter(
            Q(performer__isnull=False) | Q(event__isnull=False)
        )
        # 更新操作时，排除当前对象已关联的Link，避免被过滤掉
        if self.instance:
            used_links = used_links.exclude(id__in=self.instance.links.values_list('id', flat=True))
        # 返回未被使用的Link作为可选选项
        return Link.objects.exclude(id__in=used_links.values_list('id', flat=True))

    class Meta:
        model = Performer
        fields = ['url', 'first_name', 'last_name', 'links']

修改EventSerializer #

from django.db.models import Q

class EventSerializer(serializers.HyperlinkedModelSerializer):
    links = serializers.HyperlinkedRelatedField(
        many=True,
        view_name='link-detail',
        queryset=Link.objects.all(),
        required=False
    )

    def get_queryset(self):
        used_links = Link.objects.filter(
            Q(performer__isnull=False) | Q(event__isnull=False)
        )
        if self.instance:
            used_links = used_links.exclude(id__in=self.instance.links.values_list('id', flat=True))
        return Link.objects.exclude(id__in=used_links.values_list('id', flat=True))

    class Meta:
        model = Event
        fields = ['url', 'performer', 'sale_date', 'event_date', 'links']

方法二：在视图层动态修改查询集 #

如果使用ModelViewSet，可以在视图的get_serializer方法中动态调整序列化器字段的查询集。

PerformerViewSet示例 #

from rest_framework import viewsets
from django.db.models import Q

class PerformerViewSet(viewsets.ModelViewSet):
    queryset = Performer.objects.all()
    serializer_class = PerformerSerializer

    def get_serializer(self, *args, **kwargs):
        serializer = super().get_serializer(*args, **kwargs)
        # 筛选已被使用的Link
        used_links = Link.objects.filter(Q(performer__isnull=False) | Q(event__isnull=False))
        # 更新时保留当前对象的关联Link
        if self.instance:
            used_links = used_links.exclude(id__in=self.instance.links.values_list('id', flat=True))
        # 赋值过滤后的查询集
        serializer.fields['links'].queryset = Link.objects.exclude(id__in=used_links.values_list('id', flat=True))
        return serializer

EventViewSet示例 #

from rest_framework import viewsets
from django.db.models import Q

class EventViewSet(viewsets.ModelViewSet):
    queryset = Event.objects.all()
    serializer_class = EventSerializer

    def get_serializer(self, *args, **kwargs):
        serializer = super().get_serializer(*args, **kwargs)
        used_links = Link.objects.filter(Q(performer__isnull=False) | Q(event__isnull=False))
        if self.instance:
            used_links = used_links.exclude(id__in=self.instance.links.values_list('id', flat=True))
        serializer.fields['links'].queryset = Link.objects.exclude(id__in=used_links.values_list('id', flat=True))
        return serializer

额外说明 #

• limit_choices_to不适合此场景，它只能定义静态过滤条件，无法处理"排除所有已被其他对象关联"这种涉及多模型的动态逻辑。
• 如果想从模型层面确保Link只能被关联一次，可以修改Link模型，添加一对一字段分别关联Performer和Event并设置约束，但这会改变原有的多对多关系设计，需根据业务需求权衡。

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