作用: 数据的序列化和反序列化
格式：
from rest_framework import serializers class 序列化器类名(serializers.Serializer): 序列化器字段 = serializers.字段类型(选项参数) # ...例如：
class User(object): """用户类""" def __init__(self, name, age): self.name = name self.age = age class UserSerializer(serializer.Serializer): """用户序列化器类""" name = serializer.CharField() age = serializer.IntegerField()注：UserSerializer可以针对User进行数据的序列化和反序列化操作。
使用序列化器时需要先创建一个序列化器类的对象。
创建：
序列化器类(instance=None, data=empty, **kwarg)
说明：
1）用于序列化时，将实例对象传给instance参数
2）用于反序列化时，将要被反序列化的数据传给data参数
1）序列化操作
# 创建User对象 user = User(name='smart', age=18) # 使用UserSerializer将user对象序列化为如下字段数据：{'name': 'smart', 'age': 18} serializer = UserSerializer(user) # 获取序列化之后的字典数据 serializer.data2）反序列化操作-数据校验
# 准备数据 data = {'name': 'admin', 'age': 30} # 使用UserSerializer对data中的数据进行反序列化校验 serializer = UserSerializer(data=data) # 调用is_valid进行数据校验，成功返回True，失败返回False serializer.is_valid() # 获取校验失败之后的错误提示信息 serializer.errors # 获取校验通过之后的数据 serializer.validated_data常用字段类型：
字段
字段构造方式
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(max_length=50, minlength=None, allow_blank=False)
正则字段，验证正则模式 [-a-zA-Z0-9-]+
URLField
URLField(max_length=200, min_length=None, allow_blank=False)
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"
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)
max_digits: 最多位数
decimal_palces: 小数点位置
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)
choices与Django的用法相同
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=)
通用参数：无论哪种字段类型都可以使用的选项参数。
参数名称
说明
read_only
表明该字段仅用于序列化输出，默认False
write_only
表明该字段仅用于反序列化输入，默认False
required
表明该字段在反序列化时必须输入，默认True
default
序列化和反序列化时使用的默认值
validators
该字段使用的验证器
error_messages
包含错误编号与错误信息的字典
label
用于HTML展示API页面时，显示的字段名称
注：定义序列化器类的字段时，如果没有指定read_only和write_only，则这两个参数默认值都为False，表明该字段即在序列化时使用，也在反序列化时使用。
常用参数：
参数名称
作用
max_length
最大长度
min_length
最小长度
max_value
最大值
min_value
最小值
定义一个和BookInfo对应的序列化器类:
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)我们在django shell中来学习序列化器的使用。
python manage.py shell
1） 先查询出一个图书对象
from booktest.models import BookInfo book = BookInfo.objects.get(id=2)2） 创建序列化器对象
from booktest.serializers import BookInfoSerializer serializer = BookInfoSerializer(book)3）获取序列化之后的数据
通过data属性可以获取序列化后的数据
serializer.data # {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40}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)), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80)), OrderedDict([('id', 4), ('btitle', '雪山飞狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24)), OrderedDict([('id', 5), ('btitle', '西游记'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10)])]如果在序列化对象数据时，需要将其关联的对象一并序列化，则对关联对象数据的序列化需要指明。
例如，在序列化英雄对象数据时，外键hbook(即和英雄关联的图书)字段如何序列化？
我们先定义HeroInfoSerialzier除外键字段外的其他部分
class HeroInfoSerializer(serializers.Serializer): """英雄数据序列化器""" GENDER_CHOICES = ( (0, 'male'), (1, 'female') ) 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)对于关联字段，可以采用以下几种方式：
1） PrimaryKeyRelatedField
将关联对象序列化为关联对象的主键。
hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True) 或 hbook = serializers.PrimaryKeyRelatedField(label='图书', queryset=BookInfo.objects.all())指明字段时需要包含read_only=True或者queryset参数：
包含read_only=True参数时，该字段将不能用作反序列化使用包含queryset参数时，将被用作反序列化时参数校验使用。使用效果：
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）使用关联对象的序列化器
使用指定的序列化器类将关联对象进行序列化。
hbook = BookInfoSerializer()
使用效果：
{ 'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': OrderedDict([('id', 2), ('btitle', '天龙八部')te', '1986-07-24'), ('bread', 36), ('bcomment', 40)]) }3) StringRelatedField
将关联对象序列化为关联对象模型类__str__方法的返回值。
hbook = serializers.StringRelatedField(label='图书')
使用效果
{'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': '天龙八部'}
如果和一个对象关联的对象有多个，在声明关联字段时，需要多补充一个many=True参数。
如想序列化图书BookInfo数据，而每个BookInfo对象关联的英雄HeroInfo对象可能有多个，此时关联字段类型的指明仍可使用上述几种方式，只是在声明关联字段时，多补充一个many=True参数即可。
此处仅拿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) # 关联对象嵌套序列化字段 heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)使用效果：
from booktest.serializers import BookInfoSerializer from booktest.models import BookInfo book = BookInfo.objects.get(id=2) serializer = BookInfoSerializer(book) serializer.data # {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40 'heroinfo_set': [6,8, 9]}1.1 基本使用
# 1. 创建序列化器对象 serializer = 序列化器类(data=<待校验字典数据>) # 2. 数据校验：成功返回True，失败返回False serializer.is_valid() # 3. 获取校验成功之后的数据 serializer.validated_data注：调用is_valid时，会根据对应序列化类字段的类型以及一些选项参数对data中的数据进行校验。
如：
from booktest.serializers import BookInfoSerializer data = {'bpub_date': 123} serializer = BookInfoSerializer(data=data) serializer.is_valid() # 返回False serializer.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')]} serializer.validated_data # {} data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # True serializer.errors # {} serializer.validated_data # OrderedDict([('btitle', 'python')])1.2 补充验证
在调用is_valid进行数据校验时，除了一些基本的默认验证行为，可能还需要补充一些验证行为，比如有如下需求：
1）在进行btitle验证时，要求btitle的内容必须含有django。
2）在进行bread和bcomment验证时，要求bread必须大于bcomment。
需要再补充验证行为，可以使用以下三种方法：
1）validators
针对指定序列化器字段添加validators选项参数，如：
def about_django(value): if 'django' not in value.lower(): raise serializers.ValidationError("图书不是关于Django的") class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.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.serializers import BookInfoSerializer data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False serializer.errors # {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}2）validate_<field_name>
在序列化器类中定义特定方法validate_<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'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False 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测试：
from booktest.serializers import BookInfoSerializer data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False serializer.errors # {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}1）在数据校验通过之后，想要基于validated_data完成数据对象的创建，可以通过序列化器对象.save()进行数据的保存。
2）在save方法内部会调用序列化器类的create或update方法，可以在create方法中实现数据新增，update方法中实现数据更新。
如：
class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... def create(self, validated_data): """新建""" return BookInfo.objects.create(**validated_data) def update(self, instance, validated_data): """更新，instance为要更新的对象实例""" 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创建序列化器对象的时候，如果没有传递instance实例，则调用save()方法的时候，create()被调用，相反，如果传递了instance实例，则调用save()方法的时候，update()被调用。
from db.serializers import BookInfoSerializer data = {'btitle': '封神演义'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # True serializer.save() # <BookInfo: 封神演义> from db.models import BookInfo book = BookInfo.objects.get(id=2) data = {'btitle': '倚天剑'} serializer = BookInfoSerializer(book, data=data) serializer.is_valid() # True serializer.save() # <BookInfo: 倚天剑> book.btitle # '倚天剑'如果序列化器类对应的是Django的某个模型类，则定义序列化器类时，可以直接继承于ModelSerializer。
ModelSerializer是Serializer类的子类，相对于Serializer，提供了以下功能：
基于模型类字段自动生成序列化器类的字段包含默认的create()和update()方法的实现创建一个BookInfoSerializer：
class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = '__all__' model：指明序列化器类对应的模型类fields：指明依据模型类的哪些字段生成序列化器类的字段可以在python manage.py shell中查看自动生成的BookInfoSerializer的具体字段：
>>> from booktest.serializers import BookInfoSerializer >>> serializer = BookInfoSerializer() >>> serializer 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)1) 使用fields来指明依据模型类的哪些字段生成序列化器类的字段，__all__表明包含所有字段，也可以指明具体哪些字段，如：
class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id', 'btitle', 'bpub_date')2) 使用exclude可以指明排除掉哪些字段，如：
class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo exclude = ('image',)3) 指明只读字段
可以通过read_only_fields指明只读字段，即仅用于序列化的字段。
class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id', 'btitle', 'bpub_date'， 'bread', 'bcomment') read_only_fields = ('id', 'bread', 'bcomment')我们可以使用extra_kwargs参数为自动生成的序列化器类字段添加或修改原有的选项参数。
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)