如何使用Django REST Framework序列化嵌套关联的Django模型？

我来帮你把DRF的序列化代码调整到和你手动生成的JSON结构完全一致，咱们一步步梳理问题并修正：

先明确核心目标 #

你期望的JSON结构是：

{
    "name": "snmp名称",
    "address": "关联SNMPLine的IP",
    "port": "关联SNMPLine的端口",
    "servers": [{"ip": "服务器IP", "port": "服务器端口"}],
    "meta_data": [{"key": "value"}],
    "device_pk": "SNMP对象的主键"
}

第一步：优化模型（可选但更优雅） #

先给MetaDataModel的外键加个related_name，这样在SNMPModel里可以直接用meta_data访问关联的元数据，不用记默认的metadatamodel_set：

class MetaDataModel(models.Model):
    key = models.CharField(max_length=20)
    value = models.CharField(max_length=20)
    # 添加related_name，让关联查询更直观
    snmp_device = models.ForeignKey(SNMPModel, on_delete=CASCADE, related_name='meta_data')

第二步：逐个修正序列化器 #

1. MetaDataSerializer（生成{key:value}格式）

你需要的是精简的键值对结构，而不是默认带id的字段，重写to_representation方法即可：

class MetaDataSerializer(serializers.ModelSerializer):
    class Meta:
        model = MetaDataModel
        fields = []  # 不需要默认字段，自定义输出

    def to_representation(self, instance):
        return {instance.key: instance.value}

2. ServerSerializer（映射字段别名）

把模型里的server_ip和server_port映射成你需要的ip和port：

class ServerSerializer(serializers.ModelSerializer):
    ip = serializers.CharField(source='server_ip')
    port = serializers.IntegerField(source='server_port')

    class Meta:
        model = ServerModel
        fields = ['ip', 'port']

3. SNMPSerializer（核心修正）

这是你之前出错最多的地方，我帮你把错误点全部修正：

• 去掉line字段的many=True：一个SNMP对象只关联一条SNMPLine，不能用多对象标记
• 修正address和port的source：要从当前SNMP对象的line关联属性取值，比如source='line.ip_address'
• 正确关联meta_data：因为加了related_name，直接用序列化器即可
• 添加device_pk字段对应模型主键

class SNMPSerializer(serializers.ModelSerializer):
    servers = ServerSerializer(many=True, read_only=True)
    meta_data = MetaDataSerializer(many=True, read_only=True)
    # 直接从关联的line对象提取地址和端口
    address = serializers.CharField(source='line.ip_address')
    port = serializers.IntegerField(source='line.port')
    # 对应你手动生成的device_pk
    device_pk = serializers.IntegerField(source='pk')

    class Meta:
        model = SNMPModel
        fields = [
            'name',
            'address',
            'port',
            'servers',
            'meta_data',
            'device_pk'
        ]

第三步：视图代码小调整 #

注意filter返回的是多个对象的QuerySet，如果你的业务是要单个SNMP配置，建议改用get并处理异常；如果确实需要多个结果，保持many=True即可：

@csrf_exempt
def snippet_detail(request, name):
    try:
        # 如果你需要单个对象，用get（推荐）：
        # snmp_conf = SNMPModel.objects.get(name__contains=name)
        # 如果需要多个匹配结果，用filter：
        snmp_conf = SNMPModel.objects.filter(name__contains=name)
    except SNMPModel.DoesNotExist:
        return HttpResponse(status=404)
    except SNMPModel.MultipleObjectsReturned:
        # 用get时处理多个结果的情况
        return HttpResponse(status=400, content="找到多个匹配的SNMP配置")
    
    if request.method == 'GET':
        # 单个对象去掉many=True，多个对象保留
        serializer = SNMPSerializer(snmp_conf, many=True)
        return JsonResponse(serializer.data, status=200, safe=False)

最终效果 #

调整后生成的JSON会和你手动写的完全一致，比如单个对象的输出：

{
    "name": "a-name",
    "address": "192.168.1.100",
    "port": 161,
    "servers": [
        {"ip": "172.17.0.1", "port": 9001},
        {"ip": "172.17.0.2", "port": 9002}
    ],
    "meta_data": [
        {"location": "IDC-1"},
        {"env": "prod"}
    ],
    "device_pk": 3
}

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