Django REST Framework 序列化字段校验规则是什么

Django REST Framework（简称 DRF）是一个用于构建 Web API 的强大工具，它提供了丰富的功能来简化 API 的开发过程。其中，序列化器（Serializer）是 DRF 的核心组件之一，用于将复杂的数据类型（如 Django 模型实例）转换为 Python 数据类型，以便可以轻松地将其渲染为 JSON、XML 或其他内容类型。同时，序列化器还负责反序列化，即将传入的数据转换为复杂的数据类型。

在 DRF 中，序列化器的字段校验规则是确保数据有效性和一致性的关键。本文将详细介绍 DRF 序列化字段的校验规则，帮助开发者更好地理解和使用这一功能。

1. 字段校验的基本概念

在 DRF 中，每个序列化器字段都有一组内置的校验规则。这些规则在字段实例化时被定义，并在数据反序列化时自动应用。校验规则的主要目的是确保传入的数据符合预期的格式和类型。

1.1 字段类型校验

每个字段都有其特定的数据类型。例如，CharField 期望接收字符串数据，IntegerField 期望接收整数数据。如果传入的数据类型不匹配，DRF 将自动抛出 ValidationError 异常。

from rest_framework import serializers

class MySerializer(serializers.Serializer):
    name = serializers.CharField()
    age = serializers.IntegerField()

# 传入错误类型的数据
data = {'name': 123, 'age': 'twenty'}
serializer = MySerializer(data=data)
serializer.is_valid()  # 返回 False
serializer.errors  # 返回 {'name': ['Not a valid string.'], 'age': ['A valid integer is required.']}

1.2 字段选项校验

除了数据类型校验外，字段还可以通过选项来定义更复杂的校验规则。例如，CharField 可以通过 max_length 和 min_length 选项来限制字符串的长度。

class MySerializer(serializers.Serializer):
    name = serializers.CharField(max_length=100, min_length=2)

# 传入超出长度限制的数据
data = {'name': 'a'}
serializer = MySerializer(data=data)
serializer.is_valid()  # 返回 False
serializer.errors  # 返回 {'name': ['Ensure this field has at least 2 characters.']}

2. 自定义校验规则

虽然 DRF 提供了丰富的内置校验规则，但在实际开发中，开发者可能需要定义更复杂的校验逻辑。DRF 提供了多种方式来实现自定义校验。

2.1 字段级别的校验

可以通过在序列化器类中定义 validate_<field_name> 方法来实现字段级别的自定义校验。该方法接收字段的值作为参数，并返回校验后的值或抛出 ValidationError 异常。

class MySerializer(serializers.Serializer):
    name = serializers.CharField()

    def validate_name(self, value):
        if 'admin' in value.lower():
            raise serializers.ValidationError("Name cannot contain 'admin'")
        return value

# 传入包含 'admin' 的数据
data = {'name': 'AdminUser'}
serializer = MySerializer(data=data)
serializer.is_valid()  # 返回 False
serializer.errors  # 返回 {'name': ["Name cannot contain 'admin'"]}

2.2 对象级别的校验

有时需要根据多个字段的值来进行校验。可以通过在序列化器类中定义 validate 方法来实现对象级别的校验。该方法接收所有字段的值作为字典参数，并返回校验后的数据或抛出 ValidationError 异常。

class MySerializer(serializers.Serializer):
    start_date = serializers.DateField()
    end_date = serializers.DateField()

    def validate(self, data):
        if data['start_date'] > data['end_date']:
            raise serializers.ValidationError("End date must be after start date")
        return data

# 传入错误的日期范围
data = {'start_date': '2023-01-01', 'end_date': '2022-12-31'}
serializer = MySerializer(data=data)
serializer.is_valid()  # 返回 False
serializer.errors  # 返回 {'non_field_errors': ['End date must be after start date']}

3. 校验器的使用

DRF 还支持使用校验器（Validators）来定义可重用的校验逻辑。校验器可以是函数或类，它们接收字段的值作为参数，并在值无效时抛出 ValidationError 异常。

3.1 函数校验器

函数校验器是一个简单的 Python 函数，可以在字段定义时通过 validators 参数传入。

from rest_framework import serializers

def validate_even(value):
    if value % 2 != 0:
        raise serializers.ValidationError('This field must be an even number.')

class MySerializer(serializers.Serializer):
    number = serializers.IntegerField(validators=[validate_even])

# 传入奇数
data = {'number': 3}
serializer = MySerializer(data=data)
serializer.is_valid()  # 返回 False
serializer.errors  # 返回 {'number': ['This field must be an even number.']}

3.2 类校验器

类校验器是一个实现了 __call__ 方法的类，可以在字段定义时通过 validators 参数传入。

from rest_framework import serializers

class EvenValidator:
    def __call__(self, value):
        if value % 2 != 0:
            raise serializers.ValidationError('This field must be an even number.')

class MySerializer(serializers.Serializer):
    number = serializers.IntegerField(validators=[EvenValidator()])

# 传入奇数
data = {'number': 3}
serializer = MySerializer(data=data)
serializer.is_valid()  # 返回 False
serializer.errors  # 返回 {'number': ['This field must be an even number.']}

4. 总结

Django REST Framework 提供了强大的序列化字段校验功能，确保 API 接收到的数据是有效和一致的。通过内置的字段类型校验、字段选项校验、自定义校验规则以及校验器的使用，开发者可以灵活地定义各种复杂的校验逻辑。掌握这些校验规则，将有助于构建更加健壮和可靠的 Web API。