如何为Django Rest Framework的DictField限定合法键值？

针对Django REST Framework中DictField需要限制键为枚举值的需求，有两种实用方案：

方案一：自定义枚举键约束的DictField子类 #

继承原生DictField，重写验证方法实现键的合法性检查，同时修改Schema生成逻辑以支持自动文档展示合法键范围。

代码示例 #

from enum import Enum
from rest_framework import serializers

# 定义你的枚举类
class MyEnum(Enum):
    A = "a"
    B = "b"
    C = "c"

class EnumKeyDictField(serializers.DictField):
    def __init__(self, enum_class, *args, **kwargs):
        self.enum_class = enum_class
        self.valid_keys = {item.value for item in enum_class}
        super().__init__(*args, **kwargs)

    # 重写验证方法，检查所有键是否在枚举范围内
    def validate(self, value):
        value = super().validate(value)
        invalid_keys = [key for key in value if key not in self.valid_keys]
        if invalid_keys:
            raise serializers.ValidationError(
                f"无效键: {invalid_keys}，允许的键为 {list(self.valid_keys)}"
            )
        return value

    # 修改Schema生成逻辑，让自动文档识别合法键
    def get_schema_field(self, *args, **kwargs):
        schema = super().get_schema_field(*args, **kwargs)
        schema["patternProperties"] = {
            f"^{'|'.join(self.valid_keys)}$": schema.pop("additionalProperties", {})
        }
        return schema

# 主序列化器使用自定义字段
class MySerializer(serializers.Serializer):
    something = serializers.CharField()
    something_dict = EnumKeyDictField(
        enum_class=MyEnum,
        child=serializers.IntegerField()  # 指定字典值的字段类型
    )

方案二：动态生成嵌套序列化器 #

通过动态创建序列化器类的方式，自动根据枚举值生成对应字段，避免手动编写每个字段。

代码示例 #

from enum import Enum
from rest_framework import serializers

class MyEnum(Enum):
    A = "a"
    B = "b"
    C = "c"

# 动态生成序列化器的工具函数
def create_enum_based_serializer(enum_class, child_field=serializers.IntegerField(required=False)):
    # 遍历枚举值，生成对应字段
    fields = {item.value: child_field for item in enum_class}
    # 动态创建序列化器类
    return type(f"{enum_class.__name__}Serializer", (serializers.Serializer,), fields)

# 主序列化器使用动态生成的序列化器
class MySerializer(serializers.Serializer):
    something = serializers.CharField()
    something_dict = create_enum_based_serializer(MyEnum)()

方案对比 #

• 方案一更贴近DictField的原生使用场景，适合枚举值数量较多或需要动态更新的场景，文档会展示键的合法范围。
• 方案二生成的序列化器会在文档中列出所有可选字段，更直观，适合枚举值数量较少的场景。

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