如何序列化null的PrimaryKeyRelatedField以返回可用查询集列表？

我之前也碰到过一模一样的需求——就是希望外键字段值为null时，GET接口也能返回该字段对应的所有可选关联数据，而不是只返回null。默认情况下DRF的PrimaryKeyRelatedField确实只会序列化当前字段的实际值，POST表单能加载查询集是因为DRF的表单渲染逻辑会读取字段的queryset属性，但序列化输出不会做这件事。

下面给你两种亲测有效的实现思路：

方案一：给序列化器添加额外字段返回可选列表 #

这是最直接的方式，保留原外键字段的同时，新增SerializerMethodField来返回关联模型的所有可选选项：

from rest_framework import serializers
from .models import SomeModel, ForeignObj1, ForeignObj2

# 先给关联模型定义轻量化序列化器（按需返回需要展示的字段）
class ForeignObj1Serializer(serializers.ModelSerializer):
    class Meta:
        model = ForeignObj1
        fields = ["id", "name"]  # 替换成你实际需要的字段

class ForeignObj2Serializer(serializers.ModelSerializer):
    class Meta:
        model = ForeignObj2
        fields = ["id", "name"]

class SomeSerializer(serializers.ModelSerializer):
    # 显式定义外键字段，指定查询集（比隐式定义更清晰）
    a_fk = serializers.PrimaryKeyRelatedField(
        queryset=ForeignObj1.objects.all(),
        allow_null=True
    )
    b_fk = serializers.PrimaryKeyRelatedField(
        queryset=ForeignObj2.objects.all(),
        allow_null=True
    )
    
    # 新增字段返回可选关联数据列表
    a_fk_options = serializers.SerializerMethodField()
    b_fk_options = serializers.SerializerMethodField()

    def get_a_fk_options(self, obj):
        # 如果需要根据当前用户过滤选项，可通过context获取请求对象
        # user = self.context['request'].user
        # queryset = ForeignObj1.objects.filter(user=user)
        queryset = ForeignObj1.objects.all()
        return ForeignObj1Serializer(queryset, many=True).data
    
    def get_b_fk_options(self, obj):
        queryset = ForeignObj2.objects.all()
        return ForeignObj2Serializer(queryset, many=True).data

    class Meta:
        model = SomeModel
        fields = ["a_fk", "b_fk", "a_fk_options", "b_fk_options"]

这样不管a_fk/b_fk是不是null，GET返回的JSON里都会包含对应的可选关联数据列表，和POST表单里的查询集完全一致。

方案二：重写序列化器的to_representation方法 #

如果你不想新增额外字段，也可以重写to_representation方法，直接把可选列表加到默认序列化结果里：

class SomeSerializer(serializers.ModelSerializer):
    class Meta:
        model = SomeModel
        fields = ["a_fk", "b_fk"]

    def to_representation(self, instance):
        # 先获取默认序列化数据
        data = super().to_representation(instance)
        # 追加可选关联数据列表
        data["a_fk_options"] = ForeignObj1Serializer(ForeignObj1.objects.all(), many=True).data
        data["b_fk_options"] = ForeignObj2Serializer(ForeignObj2.objects.all(), many=True).data
        return data

效果和方案一完全一致，只是写法不同，看你个人习惯选择。

处理@action视图的情况 #

对于嵌入其他ModelViewSet的@action视图，只要在action里使用上面自定义的SomeSerializer序列化数据，就能自动带上可选列表。举个例子：

from rest_framework.decorators import action
from rest_framework.response import Response

class AnotherViewSet(viewsets.ModelViewSet):
    # ... 其他业务代码 ...

    @action(detail=True, methods=["get"])
    def get_some_data(self, request, pk=None):
        # 假设这里获取到了SomeModel的实例
        some_instance = SomeModel.objects.get(pk=pk)
        # 记得传入context，方便后续做用户过滤等逻辑
        serializer = SomeSerializer(some_instance, context={"request": request})
        return Response(serializer.data)

为什么重写PrimaryKeyRelatedField的__init__没用？ #

因为DRF的PrimaryKeyRelatedField在执行序列化输出（即to_representation方法）时，只负责处理当前字段的实际值（比如null或主键ID），不会把字段的queryset属性包含到返回结果里。所以你重写__init__并不能让查询集出现在GET响应中，必须通过额外字段或修改to_representation来实现。

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