Django Rest Framework使用ChoiceField读/写ModelSerializer

Django Rest Framework 使用 ChoiceField 读/写 ModelSerializer

基础概念

Django Rest Framework (DRF) 是一个强大的、灵活的工具包，用于构建Web API。它建立在Django之上，提供了序列化、验证和视图等功能。

ModelSerializer 是DRF中的一个类，它简化了模型实例的序列化和反序列化过程。它自动为模型字段生成序列化器字段，并提供默认的创建和更新行为。

ChoiceField 是一个序列化器字段，允许你指定一个选项列表，用户只能从这些选项中选择。这在处理具有固定选项集的字段时非常有用，例如状态码、类型等。

类型与应用场景

类型：

单选：用户只能选择一个选项。
多选：用户可以选择多个选项（通过设置 many=True）。

应用场景：

表单处理：如用户注册时的性别选择。
状态管理：如订单的状态（待支付、已支付、已完成）。
配置设置：如应用的显示主题（明亮、暗黑）。

示例代码

假设我们有一个 Product 模型，其中有一个 category 字段，它只能取几个预定义的值。

# models.py
from django.db import models

class Product(models.Model):
    CATEGORY_CHOICES = [
        ('Electronics', 'Electronics'),
        ('Clothing', 'Clothing'),
        ('Books', 'Books'),
    ]
    
    name = models.CharField(max_length=100)
    category = models.CharField(max_length=20, choices=CATEGORY_CHOICES)

# serializers.py
from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
    category = serializers.ChoiceField(choices=Product.CATEGORY_CHOICES)

    class Meta:
        model = Product
        fields = ['id', 'name', 'category']

遇到的问题及解决方法

问题：当尝试通过API更新 Product 实例时，如果提供的 category 值不在 CATEGORY_CHOICES 中，会收到一个验证错误。

原因：ChoiceField 默认进行严格验证，只接受预定义的选项。

解决方法：

前端校验：确保前端发送的数据始终在允许的范围内。
后端处理：在序列化器中添加自定义的验证逻辑，以更友好地处理无效输入。

class ProductSerializer(serializers.ModelSerializer):
    category = serializers.ChoiceField(choices=Product.CATEGORY_CHOICES)

    def validate_category(self, value):
        if value not in dict(Product.CATEGORY_CHOICES):
            raise serializers.ValidationError("Invalid category.")
        return value

    class Meta:
        model = Product
        fields = ['id', 'name', 'category']

通过这种方式，你可以确保数据的完整性和应用的健壮性。