Django REST Framework序列化器报错：传入选项文本非有效选择的需求

当前Post模型的category字段通过CATEGORY_CHOICES定义了存储短码与显示文本的映射（如'hw'对应'HOMEWORK'），默认情况下DRF的ModelSerializer仅验证存储短码的合法性，传入显示文本会触发invalid_choice错误。以下是几种让序列化器支持接收显示文本并自动转换为对应存储值的方案：

方法一：自定义可解析显示文本的Choice字段 #

创建通用的自定义字段，重写值转换逻辑，可在多个序列化器中复用：

from rest_framework import serializers

class DisplayChoiceField(serializers.ChoiceField):
    def __init__(self, choices, **kwargs):
        # 构建显示文本到存储值的映射字典
        self.display_to_value = {v: k for k, v in choices}
        super().__init__(choices, **kwargs)

    def to_internal_value(self, data):
        # 优先验证原始存储值，失败则尝试匹配显示文本
        try:
            return super().to_internal_value(data)
        except serializers.ValidationError:
            if data in self.display_to_value:
                return self.display_to_value[data]
            # 抛出包含所有合法选项的错误提示
            valid_choices = list(self.choices.keys()) + list(self.choices.values())
            raise serializers.ValidationError(
                f'"{data}" is not a valid choice. Valid choices are {valid_choices}.'
            )

修改PostCreateSerializer，使用自定义字段替换默认的category字段：

class PostCreateSerializer(serializers.ModelSerializer):
    category = DisplayChoiceField(choices=Post.CATEGORY_CHOICES)

    class Meta:
        model = Post
        fields = '__all__'

方法二：在序列化器中添加字段验证逻辑 #

无需自定义字段，直接在目标序列化器中编写validate_category方法，实现显示文本的转换：

class PostCreateSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        fields = '__all__'

    def validate_category(self, value):
        # 构建显示文本到存储值的映射
        display_map = {v: k for k, v in Post.CATEGORY_CHOICES}
        # 若输入为显示文本，转换为对应存储值
        if value in display_map:
            return display_map[value]
        # 验证输入是否为合法存储值
        if value not in dict(Post.CATEGORY_CHOICES):
            raise serializers.ValidationError(f'"{value}" is not a valid choice.')
        return value

方法三：在视图层提前转换请求数据 #

在视图接收请求后，先对category字段进行转换，再传入序列化器：

from rest_framework import status
from rest_framework.response import Response

class PostAPI(APIView):
    def post(self, request):
        # 定义显示文本到存储值的映射
        category_map = {'MIRACLE': 'mc', 'HOMEWORK': 'hw'}
        category = request.data.get('category')
        
        # 转换category值
        if category in category_map:
            category = category_map[category]
        
        data = {
            'title'   : request.data['title'],
            'category': category,
            'content' : request.data['content'],
            'author'  : request.user.id
        }
        serializer = PostCreateSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        else:
            print(serializer.errors)
            return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

方案对比 #

• 方法一：通用型强，适合多模型多序列化器的场景，代码复用性高
• 方法二：逻辑集中在序列化器内，适合单个序列化器的需求，维护方便
• 方法三：无需修改序列化器，适合快速临时解决问题，但业务逻辑分散在视图层，扩展性差

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