django?restframework序列化字段校驗規則是什么

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。