谈谈Django REST Framework（DRF）中的序列化器

摘要

Django REST Framework(DRF)是一个强大的工具，可以帮助我们构建和处理RESTful API。其中的序列化器（Serializers）是其核心组件之一，它允许我们快速有效地出来复杂的数据类型，如查询集和复杂的数据结构。在本文中，我将谈谈DRF中的序列化器，以帮助您更好地理解和应用它们。

序列化器是什么？

序列化器其实可以当做一个翻译官，它能把Django的复杂语言（比如查询集和模型示例）翻译成Python的简单语言。这个过程就叫“序列化”。反过来，它也可以把Python的简单语言翻译成Django的复杂语言。这个过程就叫"反序列化“”。

序列化器的基本使用

DRF 序列化器的使用和 Django 中的 Form 非常相似。最基础的序列化器类是 Serializer。下面是一个简单的例子：

from rest_framework import serializersclass CommentSerializer(serializers.Serializer):email = serializers.EmailField()content = serializers.CharField(max_length=200)created = serializers.DateTimeField()

DRF 还提供了一个’ModelSerializer’类，是得创建序列化器变得更加简单。'ModelSericalizer’会自动为模型中的每个字段创建一个相应的序列化器字段。例如：

from rest_framework import serializers
from .models import Commentclass CommentSerializer(serializers.ModelSerializer):class Meta:model = Commentfields = ['email', 'content', 'created']

在这个例子中，我们不再需要手动定义每个字段，DRF会自动为我们处理。

验证

和Django的Form类似，DRF的序列化器也支持数据验证。在 Django REST Framework（DRF）中，你可以为序列化器的每个字段定义一个名为 validate_<field_name> 的方法，其中 <field_name> 是要验证的字段的名称。这个方法将接收一个参数，即要验证的字段的值，并且它应该返回验证后的值，或者如果验证失败，抛出一个 ValidationError 异常。一下是一个例子：

from rest_framework import serializersclass CommentSerializer(serializers.Serializer):email = serializers.EmailField()content = serializers.CharField(max_length=200)created = serializers.DateTimeField()def validate_content(self, value):if 'Ghost face' in value:raise serializers.ValidationError("These words are not allowed")return value

在这个例子中，validate_content 方法检查 content 字段的值是否包含 “Ghost face” 这个词。如果包含，就抛出一个 ValidationError 异常，否则就返回原来的值。这就是数据验证的过程。

简单来说，这段代码的作用就是对 content 字段的值进行验证，确保其不包含 “Ghost face” 这个词。如果你的数据需要满足一些特定的条件，你可以通过定义类似的方法来实现自定义的验证逻辑。

序列化

在DRF中，我们可以创建一个序列化器实例，并将需要序列化的对象传递给它，然后调用.data来获取序列化后的数据。现在让我们看一个例子：

from .models import Comment
from .serializers import CommentSerializer# 获取一个 comment 实例
comment = Comment.objects.get(id=1)# 创建序列化器实例
serializer = CommentSerializer(comment)# 获取序列化后的数据
print(serializer.data)
# 输出形如：{'email': 'abc@example.com', 'content': '整个csdn都任我闯', 'created': '2023-05-01T12:30'}

反序列化

为了做示范，这里先创建了一个序列化器实例，然后将需要反序列化的数据作为参数传给它，再通过调用 .is_valid() 方法来验证这些数据，然后数据有效，我们就可以通过. validate_data 属性来获取反序列化后的数据。

from .serializers import CommentSerializer# 定义需要反序列化的数据
data = {'email': 'abc@example.com', 'content': '整个csdn都任我闯', 'created': '2023-05-01T12:30'}# 创建序列化器实例
serializer = CommentSerializer(data=data)# 进行数据验证
if serializer.is_valid():# 获取反序列化后的数据print(serializer.validated_data)# 输出形如：{'email': 'abc@example.com', 'content': '整个csdn都任我闯', 'created': datetime.datetime(2023, 5, 1, 12, 30)}

在 Django REST Framework 序列化器的反序列化过程中，不同类型的字段会被转换成相应的 Python 数据类型。这是因为序列化器会根据字段的类型执行相应的验证和转换。在 Django REST Framework 序列化器的反序列化过程中，不同类型的字段会被转换成相应的 Python 数据类型。这是因为序列化器会根据字段的类型执行相应的验证和转换。

在我们的例子中：

email 字段是一个 EmailField，在反序列化过程中，它会确保数据是一个有效的电子邮件地址字符串。由于输入和输出都是字符串，所以它在序列化和反序列化过程中看起来没有变化。

content 字段是一个 CharField，在反序列化过程中，它会确保数据是一个字符串，并且长度不超过最大长度限制。同样的，由于输入和输出都是字符串，所以它在序列化和反序列化过程中看起来没有变化。

created 字段是一个 DateTimeField，在反序列化过程中，它会将一个符合特定格式的字符串转换为一个 datetime 对象。这就是为什么你会看到 created 字段的值从一个字符串转换为一个 datetime 对象。

总结

通过本文，我们理解了 Django REST Framework 中序列化器的核心概念和主要功能。我们了解到序列化器是一种强大的工具，可以帮助我们处理复杂的数据类型，并有效地将 Django 对象和 Python 数据类型之间进行转换。我们还探讨了序列化和反序列化的过程，包括如何使用 Serializer 和 ModelSerializer，以及如何进行数据验证。
无论是在创建 API，还是在处理复杂的数据结构时，理解和掌握序列化器都是非常重要的。希望这篇文章能帮助你更深入地理解 Django REST Framework，让你在开发过程中更得心应手。