DRF框架——序列化器的使用

最新推荐文章于 2022-09-27 21:30:04 发布

钟灵毓秀M

最新推荐文章于 2022-09-27 21:30:04 发布

阅读量1k

点赞数 1

文章标签： DRF框架

本文链接：https://blog.csdn.net/weixin_45455015/article/details/97553945

版权

一、什么是序列化和反序列化？

序列化：
数据转换：模型对象-->字典-->json
使用情景：当需要给前端响应模型数据时，需要将模型数据序列化成前端需要的格式，一般是json或者xml格式，主流是json
反序列化：
数据转换：json-->字典-->校验-->保存/更新(模型对象)
使用情景：当需要将用户发送的数据存储到数据库之前，需要使用反序列化
补充：序列化和反序列化是一个过程，从一种数据格式到另一种数据格式的转换

二、序列化器Serializer

(1)序列化器作用：

序列化器主要是对数据进行处理，序列化器不是独立存在的，它是针对特定的目标对象
作用：
（1）进行数据的校验(发生来反序列化中)
（2）对数据对象进行转换

(2)序列化器定义：

序列化器Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。在应用中新建
serializers.py 文件，在里面定义该应用模型的序列化器。
可以为 models.py 中的模型类分别定义一个序列化器
serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。

序列化器的字段：
常用字段类型：

字段	字段构造方式
BooleanField	BooleanField()
NullBooleanField	NullBooleanField()
CharField	CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailField	EmailField(max_length=None, min_length=None, allow_blank=False)
RegexField	RegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugField	SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9-]+
URLField	URLField(max_length=200, min_length=None, allow_blank=False)
UUIDField	UUIDField(format=‘hex_verbose’)
IPAddressField	IPAddressField(protocol=‘both’, unpack_ipv4=False, **options)
IntegerField	IntegerField(max_value=None, min_value=None)
FloatField	FloatField(max_value=None, min_value=None)
DecimalField	DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None)
DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
DateField	DateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeField	TimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationField	DurationField()
ChoiceField	ChoiceField(choices)
MultipleChoiceField	MultipleChoiceField(choices)
FileField	FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageField	ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListField	ListField(child=, min_length=None, max_length=None)
DictField	DictField(child=)

选项参数：

参数名称	作用
max_length	最大长度
min_lenght	最小长度
allow_blank	是否允许为空
trim_whitespace	是否截断空白字符
max_value	最小值
min_value	最大值

通用参数：

参数名称	说明
read_only	表明该字段仅用于序列化输出，默认False
write_only	表明该字段仅用于反序列化输入，默认False
required	表明该字段在反序列化时必须输入，默认True
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None，默认False
validators	该字段使用的验证器
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时，显示的字段名称
help_text	用于HTML展示API页面时，显示的字段帮助提示信息

(3)创建Serializer对象
定义好Serializer类后，就可以创建Serializer对象了。
例如：

book_serializer = Serializer(instance=None, data=empty, **kwarg)
# instance:模型类对象（序列化）
# data:被反序列化的数据传入data参数
# context:额外添加数据,后面可通过Serializer对象的context属性获取

（一）序列化

（1）序列化操作流程

序列化操作流程：

获得目标数据对象（单一或者多个）
查询数据库得到模型对象，单一或者查询集
构建序列化器对象
①单一对象：serializer = BookInfoSerializer(book)
②查询集QuerySet:serializer = BookInfoSerializer(book_qs, many=True)
获得序列化的结果（字典类型），序列化器对象.data

（2）关联对象嵌套序列化
如果需要序列化的数据中包含有其他关联对象，则对关联对象数据的序列化需要指明如何序列化
对于关联字段，可以采用以下几种方式：
1） PrimaryKeyRelatedField
此字段将被序列化为关联对象的主键。

hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True)
# 指明字段时必须包含read_only=True或者queryset参数，否则报错
# read_only=True：当前字段只参与序列化操作

#使用效果
{'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': 2}

2) StringRelatedField
此字段将被序列化为关联对象的字符串表示方式（即__str__方法的返回值）

hbook = serializers.StringRelatedField(label='图书')

# 使用效果
{'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': '天龙八部'}

3）使用关联对象的序列化器
可以直接使用关联对象的序列化器，也可以从新自定义一个新的序列化器。

hbook = BookInfoSerializer()

# 使用效果
{'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': OrderedDict([('id', 2), ('btitle', '天龙八部')te', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', None)])}

注意：

如果关联的对象数据不是只有一个，而是包含多个数据。在声明关联字段时，多补充一个many=True参数即可。例如：在主表中，从表的数据有多个，主表的隐藏字段设计如下：

heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)

如果主表和从表互相使用了对方的序列化器来序列表中的外键，会造成死循环序列化，所以，这种情况下，应该重新定义一个序列化器，该序列化器的字段不嵌套序列化关联对象，其中一个表的字段使用重新定义的序列化器。

（二）反序列化

1. 反序列化操作流程——验证

使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。
(1)反序列化验证操作流程:

反序列化验证操作流程：

获取需要反序列化校验的原始数据（字典）
info = {"btitle": "楚乔传"}
构建序列化器
serializer = BookInfoSerializer(data=info)
启动校验流程
serializer.is_valid() 校验成功返回True，失败返回False
①校验失败：
查看错误信息方法1：通过serializer.errors查看错误信息；
查看错误信息方法2：在启动校验流程时serializer.is_valid(raise_exception=True)以异常的形式抛出错误信息
②校验成功：通过serializer.validated_data属性获取数据。

补充说明：

验证失败

可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误，（字典类型：{"出错字段: "出错原因"}）。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
通过传递raise_exception=True参数，验证失败时抛出异常serializers.ValidationError，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。

验证成功

validated_data属性返回值是OrderedDict类型，它是 dict 的子类，其最大特征是，它可以“维护”添加 key-value 对的顺序。简单来说，就是先添加的 key-value 对排在前面，后添加的 key-value 对排在后面。

(2)自定义验证
如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：

1）某字段约束条件添加validators=[校验函数名]，在序列化器外定义一个校验函数

def about_django(value):
    if 'django' not in value.lower():
        raise serializers.ValidationError("图书不是关于Django的")
	# value:经过前序校验的原始数据
	# 无返回值，在字段约束条件中首先被DRF
	
class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...
    btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])

2）在序列化器中，定义validate_<field_name>方法, 验证某个字段

 # 需求：要求输入的字段btitle中要含有'django'
class BookInfoSerializer(serializers.Serializer):
     """图书数据序列化器"""
     ...
 
     def validate_btitle(self, value):
         if 'django' not in value.lower():
             raise serializers.ValidationError("图书不是关于Django的")
         return value
         
         # value:经过校验的原始数据
         # return: 必须有返回值

测试

serializer.errors
#  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

3）在序列化器中，定义validate方法
在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证（最后一步校验）。

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def validate(self, attrs):
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if bread < bcomment:
            raise serializers.ValidationError('阅读量小于评论量')
        return attrs
        # attrs:经过谦虚校验的所有有效数据（字典格式）
        # return:必须有返回值，用于构建最终的有效数据

测试

s.errors
#  {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

1. 反序列化操作流程——保存

如果在验证成功后，想要基于validated_data完成数据对象的创建，可以通过实现create()和update()两个方法来实现。

def create(self, validated_data):
        instance = BookInfo(**validated_data)
        instance.save()
        return instance

def update(self, instance, validated_data):
    instance.bread = validated_data['bread']
    instance.save()
    return instance

反序列化保存操作流程:
根据有效数据，构建模型类对象，保存到数据库中，返回新建的模型对象

反序列化保存操作流程：

获取有效数据（经最终校验）
构造序列化器对象
序列化对象.save()
返回该对象（利于后面做序列化操作）

如果创建序列化器对象的时候:

传递了instance实例，则调用save()方法的时候，update()被调用。
没有传递instance实例，则调用save()方法的时候，create()被调用

例子：

from db.serializers import BookInfoSerializer
info = {'btitle': '封神演义', 'bpub_date': '1990-2-2'}
serializer = BookInfoSerializer(data=info)  # 没有传递instance实例
serializer.is_valid()  # True
serializer.save()  # 调用create()方法

from db.models import BookInfo
book = BookInfo.objects.get(id=2)
info = {'btitle': '倚天剑'}
serializer = BookInfoSerializer(book, data=info, partial=True)  # 传递了instance实例, partial=True参数表示部分更新，只传需要更新的数据，不会校验其他字段数据
serializer.is_valid()  # True
serializer.save()  # 调用update()方法

说明：
在对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到

serializer.save(owner=request.user)

钟灵毓秀M

关注

1
点赞
踩
11

收藏

觉得还不错? 一键收藏
0
评论
DRF框架——序列化器的使用

一、什么是DRF框架？Django REST framework 框架是一个用于构建Web API 的强大而又灵活的工具。通常简称为DRF框架或 REST framework。DRF框架是建立在Django框架基础之上，由Tom Christie大牛二次开发的开源项目。特点提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；...
复制链接

扫一扫