版权声明：浅弋、璃鱼的原创 https://blog.csdn.net/qq_35709559/article/details/84291528

Serializer序列化器:

序列化器的作用:

• 1.进行数据的校验;
• 2.对数据对象进行转换;

一、定义Serializer:

1. 定义方法:

Django REST framework中的Serializer使用类来定义, 须继承自rest_framwork.serializer.Serializer。
例如,我么已有了一个数据库模型类BookInfo

class BookInfo(models.Model):
"""这是一个图书模型类"""
btitle = models.CharField(max_length=20, verbose_name='名称')
bpub_date = models.DateField(verbose_name='发布日期', null=True)
bread = models.IntegerField(default=0, verbose_name='阅读量')
bcomment = models.IntegerField(default=0, verbose_name='评论量')
image = models.ImageField(upload_to='booktest', verbose_name='图片', null=True)

我们想为这个模型提供一个序列化器,可以定义如下:

class BookInfoSerializer(serializers.Serializer):
"""图书数据序列化器"""
id = serializer.IntegerField(label='ID', read_only=True)
btitle = serializer.CharField(label="名称", max_length =20)
bpub_date = serializer.DateField(label="发布日期", required=False)
bread = serializer.IntegerField(label="阅读量", required=False)
bcomment = serializer.IntegerField(label="评论量", required=False)

***注意: serializer不是只能为数据库模型类定义, 也可以为非数据库类的数据定义。***serializer是独立于数据库之外的存在。

2.字段与选项:

常用字段类型:

字段	字段构造方式	说明
BooleanField	BooleanField()	布尔类型
ImageField	ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)	图片链接
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)	正则类型
FileField	FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)	文件类型
IntegerField	IntegerField(max_value=None, min_value=None)	整型
UUIDField	UUIDField(format=‘hex_verbose’) format: 1) ‘hex_verbose’ 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 2） ‘hex’ 如 “5ce0e9a55ffa654bcee01238041fb31a” 3）‘int’ - 如: “123456789012312313134124512351145145114” 4）‘urn’ 如: “urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a”	UUID类型
FloatField	FloatField(max_value=None, min_value=None)	浮点类型
TimeField	TimeField(format=api_settings.TIME_FORMAT, input_formats=None)	时间类型
DateField	DateField(format=api_settings.DATE_FORMAT, input_formats=None)	日期类型
DecimalField	DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置	十进制类型
DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)	日期时间类型

选项参数:

参数名称	作用
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对象了。
serializer的构造方法为:

Serializer(instance=None, data=empty, **kwarg)

说明:

• 1.用于序列化是,将模型类对象传入instance参数
• 2.用于反序列化时,将要被反序列化的数据传入data参数
• 3.除了instance的data参数外, 在构造Serializer对象时,就可通过context参数额外添加数据, 如:

serializer = AccountSerializer(account, context={"request": request})

*** 通过context参数附加数据,可以通过Serializer对象的context属性获取。***

二、序列化使用:

在django shell中来学习序列化器的使用:

python manage.py shell

1. 基本使用:

1.1 先查询出一个图书对象

from booktese.models import BookInfo

book = BookInfo.object.get(id=2)

1.2 构造序列化器对象:

from booktest.serializer import BookInfoSerializer

ser = BookInfoSerializer(book)

1.3 获取序列化器数据

通过data属性来获取序列化后的数据

serializer.data
# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}

1.4 如果要被序列化的事包含多条数据的查询集QuerySet, 可以通过添加many=True参数补充说明

book_qs = BookInfo.objects.all()
serializer = BookInfoSerializer(book_qs, many=True)
serializer.data
# [OrderedDict([('id', 2), ('btitle', '天龙八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飞狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西游记'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]

2. 关联对象嵌套序列化:

如果需要序列化的数据中包含有其他关联对象,则对关联对象数据的序列化需要指明。
例如, 在定义英雄数据的序列化时,外键hbook(即所属的图书)字段如何序列化?
先定义HeroInfoSerializer除外键字段外的其他部分

class HeroInfoSerializer(serializers.Serializer):
"""英雄数据序列化器"""
GENDER_CHOICES = (
(0, "male"),
(1, "femaile")
)
id = serializers.IntegerField(label='ID', read_only=True)
hname = serializers.CharField(label='名字', max_length=20)
hgender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性别', required=False)
hcomment = serializers.CharField(label='描述信息', max_length=200, required=False, allow_null=True)

对于关联字段.可以采用以下方式:

2.1 PrimaryKeyRelatedField:

此字段将被序列化为关联对象的主键

hbook = serializers.PrimaryKeyRelatedField(label='图书',read_only=True)

致命字段时需要包含read_only=True

• 包含read_only=True参数时, 该字段将不能用作反序列化使用
  使用效果:

from booktest.serializers import HeroInfoSerializer
from booktest.models import HeroInfo
hero = HeroInfo.objects.get(id=6)
serializer = HeroInfoSerializer(hero)
serializer.data
# {'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': 2}

2.2 StringRelatedField:

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

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

使用效果:

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

2.3 使用关联对象的序列化器:

hbook = BookInfoSerializer()

使用效果:

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

3. many参数:

  如果关联的对象数据不是只有一个,而是包含多个数据,如想序列化图书BookInfo数据,每个BookInfo对象关联的英雄HeroInfo对象可能有多个,此时关联字段类型的指明仍可使用上述几种方式,只是在声明关联字段时,多补充一个many=Treu参数即可.
  此处仅拿PrimaryKeyRelatedField类型来举例,其他相同.
在BookInfoSerializer中添加关联字段:

class BookInfoSerializer(serializers.Serializer):
"""图书数据序列化器"""
id = serializers.IntegerField(label='ID', read_only=True)
btitle = serializers.CharField(label='名称', max_length=20)
bpub_date = serializers.DateField(label='发布日期', required=False)
bread = serializers.IntegerField(label='阅读量', required=False)
bcomment = serializers.IntegerField(label='评论量', required=False)image = serializers.ImageField(label='图片', required=False)
heroinfo_set = serializer.PrimaryKeyRelatedField(read_only=True,
many=True)	# 新增

使用效果:

from booktest.serializers import BookInfoSerializer
from booktest.models import BookInfo
book = BookInfo.objects.get(id=2)
ser = BookInfoSerializer(book)
ser.data
# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None, 'heroinfo_set': [6,8, 9]}

三、反序列化使用

1. 验证

  使用序列化器进行反序列化时, 需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象.
在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回Flase。
  验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framwork配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
  验证成功,可以通过序列化器对象的validated_data属性获取数据。
  在定义序列化器时, 指明每个字段的序列化类型和选项参数,本身就是一种验证行为。
如前面定义过的BookInfoSerializer

class BookInfoSerializer(serializers.Serializer):
"""图书数据序列化器"""
id = serializers.IntegerField(label='ID', read_only=True)
btitle = serializers.CharField(label='名称', max_length=20)
bpub_date = serializers.DateField(label='发布日期', required=False)
bread = serializers.IntegerField(label='阅读量', required=False)
bcomment = serializers.IntegerField(label='评论量', required=False)

通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证

from booktest.serializer import BookInfoSerializer
data = {'bpub_date':123}
ser = BookInfoSerializer(data = data)
ser.is_valid()	# 返回False
ser.errors
# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
ser.validated_data
# {}

data = {'btitle':'python'}
ser = BookInfoSerializer(data = data)
ser.is_valid()	# True
ser.errors()
# {}
ser.validated_data
# OrderedDict([('btitle', 'python')])

is_valid()方法还可以在验证失败时抛出异常serializer.ValidationError, 可以通过传递raise_exection=True参数开启, REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。

# Return a 400 response if the data was invalid.
serializer.is_valid(raise_exception=True)

如果觉得这些还不够,需要再补充定义验证行为,可以使用一下三种方法:

1.1 validate_<field_name>

对于<field_name>字段进行验证, 如:

class BookInfoSerializer(serializers.Serializer):
"""图书数据序列化器"""
...
def validate_btitle(self, value):
"""验证图书名"""
if 'django' not in value.lower():
raise serializers.ValidationError("图书不是关于Django的")
return value

测试:

from booktest,serializers import BookInfoSerializer
data = {"btitle": "python"}
ser = BookInfoSerializer(data = data)
ser.is_valid()
ser.errors
# {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

1.2 validate

在序列化器中需要同时对多个字段进行比较验证时, 可以定义validate方法来验证,如:

class BookInfoSerializer(serializers.Serializer):
"""图书数据序列化器"""
...
def validate(self, attrs):
"""验证阅读量大于评论量"""
bread = attrs['bread']
bcomment = attrs['bcomment']
if bread < bcomment:
raise serializer.ValidationError("阅读量小于评论量")
return attrs

测试:

from booktest.serializers import BookInfoSerializer
data = {"btitle":"about django", "bread":10, "bcomment":20}
s = BookInfoSerializer(data=data)
s.is_valid()
s.errors
# {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

1.3 validators:

在字段中添加validators选项参数, 也可以补充验证行为, 如:

def about_django(value):
"""验证图书名称"""
if 'django' not in vlaue.lower():
raise serializer.ValidationError("图书不是Django的")

class BookInfoSerializer(serializers.Serializer):
"""图书数据序列化器"""
id = seializers.IntegerField(label='ID', read_only=True)
btitle = serializer.CharField(label='名称', max_length=20, validators=[about_django])
bpub_date = serializers.DateField(label='发布日期', required=False)
bread = serializers.IntegerField(label='阅读量', required=False)
bcomment = serializers.IntegerField(label='评论量', required=False)

测试:

from booktest.serializer import BookInfoSerializer
data = {"btitle": "python"}
ser = BookInfoSerializer(data=data)
ser.is_valid()
# False
ser.errors
# {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

2.保存:

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

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

def create(self, validated_data):
"""新建对象"""
return BookInfo.objects.create(**validated_data)

def update(self, instance, validated_data):
"""更新对象内容"""
instance.btitle = validated_data.get('btitle', instance.btitle)
instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)
instance.bread = validated_data.get('bread', instance.bread)
instance.bcomment = validated_data.get('bcomment', instance.bcomment)
instance.save()
return instance

实现了上述两个方法后,在序列化数据的时候,就可以通过save()方法返回一个数据对象实例了。

book = serializer.save()

如果创建序列化器对象的时候,没有传递instance实例, 则调用save()方法的时候,create()被调用, 相反, 如果传递了instance实例, 则调用save()方法的时候, update()被调用。

from db.serializers import BookInfoSerializer
data = {'btitle': '封神演义'}
ser = BookInfoSerializer(data = data)
ser.is_valid()
# True
ser.save()
# <BookInfo:封神演义>

form db.models import BookInfo
book = BookInfo.object.get(id=2)
data={"btitle":"倚天剑"}
ser = BookInfoSerializer(book, data=data)
ser.is_valid()
# True
ser.save()
# <BookInfo: 倚天剑>
book.btitle
# '倚天剑'

三、模型类序列化器ModelSerializer

  如果我们想要使用序列化器对应的是Django的模型类,DRF为我们提供了ModelSerializer模型序列化器来帮助我们快速创建一个Serializer类。
ModelSerializer与常规的Serializer相同,但提供了:

• 基于模型类自动生产一系列字段;
• 基于模型类自动为Serializer生成validators
• 包含默认的create()和update()的实现;

1.定义:

比如我们创建以BookInfoSerializer

class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
fields = '__all__'

• model: 指明参照那个模型类
• fields: 指明为模型类的哪些字段生成

在python manage.py shell中查看自动生成的BookInfoSerializer的具体实现:

>>> from booktest.serializers import BookInfoSerializer
>>> ser = BookInfoSerializer()
>>> ser
BookInfoSerializer():
id = IntegerField(label='ID', read_only=True)
btitle = CharField(label='名称', max_length=20)
bpub_date = DateField(allow_null=True, label='发布日期', required=False)
bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)

2. 指定字段:

2.1 使用fields来明确字段, __all__表名包含所有字段, 也可以写明具体哪些字段, 如:

class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
fields = ("id", "btitle", "bpub_date")

2.2 使用exclude可以明确排除掉哪些字段:

class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
exclude = ("bcomment",)

2.3 默认ModelSerializer使用主键作为关联字段,但是我们可以使用depth来简单的生成嵌套表示, depth应该是整数,表名嵌套的层级数量。

如:

class HeroInfoSerializer2(serializers.ModelSerializer):
class Meta:
model = HeroInfo
fields = '__all__'

形成的序列化器如下 :

HeroInfoSerializer():
id = IntegerField(label='ID', read_only=True)
hname = CharField(label='名称', max_length=20)
hgender = ChoiceField(choices=((0, 'male'), (1, 'female')), label='性别', required=False, validators=[<django.core.valators.MinValueValidator object>, <django.core.validators.MaxValueValidator object>])
hcomment = CharField(allow_null=True, label='描述信息', max_length=200, required=False)
hbook = NestedSerializer(read_only=True):
id = IntegerField(label='ID', read_only=True)
btitle = CharField(label='名称', max_length=20)
bpub_date = DateField(allow_null=True, label='发布日期', required=False)
bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)

2.4 显示指明字段, 如:

class HeroInfoSerializer(serializers.ModelSerializer):
hbook = BookInfoSerializer()
class Meta:
model = HeroInfo
fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

2.5 指明只读字段:

可以通过read_only_fields指明只读字段,即仅用于序列化输出的字段

class BookInfoSerializer(serializers.ModelSerializer):
""""图书数据序列化器""
class Meta:
model = BookInfo
fields = ("id", "btitle", "vread", "bcommrnt")
read_only_fields = ('id', 'bread', 'bcomment')

3. 添加额外参数:

可以使用extra_kwargs参数为ModelSerializer添加或者修改原有选项数据

class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment')
extra_kwargs = {
'bread': {'min_value': 0, 'required': True},
'bcomment': {'min_value': 0, 'required': True},
}

# BookInfoSerializer():
#    id = IntegerField(label='ID', read_only=True)
#    btitle = CharField(label='名称', max_length=20)
#    bpub_date = DateField(allow_null=True, label='发布日期', required=False)
#    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=0, required=True)
#    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=0, required=True)

阅读更多