如何在DRF(Django REST Framework)中设置创建用户时role与function为可选字段

报错原因梳理 #

1. 仅配置allow_null=True无效：该参数仅允许字段传入null值，不控制字段是否可以省略，DRF字段默认required=True，所以不传字段依然会返回必填错误；optional_fields不是DRF原生支持的配置项，因此不会生效。
2. 配置required=False后触发KeyError：DRF的ModelSerializer默认不支持嵌套序列化器的写入逻辑，你没有重写create方法处理嵌套字段的创建/关联，且当字段未传入时validated_data中不会存在对应的key，直接访问就会抛出KeyError。

完整修改方案 #

1. 调整UserSerializer字段配置 #

给role、function两个嵌套字段添加required=False，支持字段省略不传，同时按需添加allow_null=True支持显式传null值：

class UserSerializer(serializers.ModelSerializer):
    # 省略原有其他字段定义
    role = RoleSerializer(required=False, allow_null=True)
    function = FunctionsCreateSerializer(write_only=True, required=False, allow_null=True)

    class Meta:
        model = models.Operator
        fields = ["id", "username", "password", "email", "is_active", "fio", "position", "phone", "role", "function",
                  "created", "updated"]

2. 重写UserSerializer的create方法 #

处理可选嵌套字段的逻辑，判断字段存在才执行对应操作，避免KeyError：

def create(self, validated_data):
        # 弹出嵌套字段时指定默认值None，避免字段不存在时抛出异常
        role_data = validated_data.pop("role", None)
        function_data = validated_data.pop("function", None)
        # 先创建Operator主实例
        operator = super().create(validated_data)

        # 仅当传入了role参数时处理角色关联
        if role_data:
            role_instance, _ = models.OperatorRole.objects.get_or_create(**role_data)
            operator.role = role_instance
            operator.save()

        # 仅当传入了function参数时处理功能权限关联
        if function_data and operator.role:
            func_list = function_data.get("function", [])
            for func_code in func_list:
                func_instance, _ = models.FunctionRole.objects.get_or_create(function=func_code)
                operator.role.function.add(func_instance)
        
        return operator

3. （可选）支持更新操作的配置 #

如果需要支持更新接口也能省略这两个字段，同步重写update方法即可：

def update(self, instance, validated_data):
        role_data = validated_data.pop("role", None)
        function_data = validated_data.pop("function", None)
        instance = super().update(instance, validated_data)

        if role_data:
            role_instance, _ = models.OperatorRole.objects.get_or_create(**role_data)
            instance.role = role_instance
            instance.save()

        if function_data and instance.role:
            # 清空原有权限再添加新权限，可根据业务需求调整逻辑
            instance.role.function.clear()
            func_list = function_data.get("function", [])
            for func_code in func_list:
                func_instance, _ = models.FunctionRole.objects.get_or_create(function=func_code)
                instance.role.function.add(func_instance)
        
        return instance

4. （可选优化）调整FunctionsCreateSerializer配置 #

如果允许传入的function对象内部的function字段为空，可给该字段也添加required=False：

class FunctionsCreateSerializer(serializers.ModelSerializer):
    function = serializers.MultipleChoiceField(choices=models.Function, required=False)

    class Meta:
        model = models.FunctionRole
        fields = ("function",)
        validators = []

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