如何创建支持Meta默认字段+查询参数动态追加字段的Django Serializer

实现方案 #

DRF的ModelSerializer初始化时只会加载Meta配置中指定的字段，要实现字段追加，需要手动为新增字段构造对应的序列化字段实例后添加到self.fields中，完整实现如下：

1. 基类实现

from rest_framework import serializers
from rest_framework.serializers import ModelSerializer

class DynamicFieldsUnionModelSerializer(ModelSerializer):
    """
    支持动态追加字段的ModelSerializer：保留Meta指定的默认字段，追加传入的fields参数中的字段
    """

    def __init__(self, *args, **kwargs):
        # 取出自定义的追加字段参数，不传递给父类
        extra_fields = kwargs.pop('fields', None)

        # 初始化父类，此时self.fields仅包含Meta配置的默认字段
        super().__init__(*args, **kwargs)

        if extra_fields is not None:
            existing_fields = set(self.fields.keys())
            for field_name in extra_fields:
                # 已存在的字段无需重复添加
                if field_name in existing_fields:
                    continue
                # 从模型字段映射生成对应序列化字段
                try:
                    model_field = self.Meta.model._meta.get_field(field_name)
                    field_class, field_kwargs = serializers.model_meta.get_field_kwargs(model_field)
                    self.fields[field_name] = field_class(**field_kwargs)
                except self.Meta.model._meta.FieldDoesNotExist:
                    # 可根据业务需求调整为跳过不存在字段，无需强制抛出异常
                    raise ValueError(f"模型{self.Meta.model.__name__}中不存在字段{field_name}")

2. 业务序列化器继承使用

class BldgLocationAndFilters(DynamicFieldsUnionModelSerializer):
    latitude = serializers.FloatField(source='lat_016_decimal')
    longitude = serializers.FloatField(source='long_017_decimal')

    class Meta:
        model = Bldg
        fields = ('latitude', 'longitude')

3. 调用示例

# 传入需要追加的字段type
serializer = BldgLocationAndFilters(instance, fields=['type'])

最终返回的字段会包含latitude、longitude、type三个，符合预期。

注意事项 #

• 若需要追加的是自定义非模型字段，需要提前在序列化器类中定义，或在追加逻辑中手动指定字段类型
• 可根据业务需求调整不存在字段的处理逻辑，比如跳过非法字段不抛出异常

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