DRF使用篇（三）:序列化

一.序列化和反序列化

• 序列化
  • 将数据库数据序列化为前端所需要的格式，并返回
• 反序列化
  • 将前端发送的数据反序列化为模型类对象，并保存到数据库中

二.CURD的数据过程

Create

• 校验请求数据 => 执行反序列化过程 => 保存数据库=> 将保存的对象序列化并返回

Delete：

• 判断要删除的数据是否存在=> 执行数据库删除

Retrieve

• 查询数据库 => 将数据序列化并返回

Update

• 判断要修改的数据是否存在 => 校验请求的数据 => 执行反序列化过程 => 保存数据库 =>将保存的对象序列化并返回

三.手动定义一个序列化器

• modle.py

class StudentInfo(models.Model):
    name = models.CharField(max_length=20, verbose_name='姓名')
    birthday = models.DateField(verbose_name='生日', null=True)
    money = models.IntegerField(default=0, verbose_name='现金')
    image = models.ImageField(upload_to='studenttest', verbose_name='照片', null=True)

• serializer.py

from rest_framework import serializers

class StudentSerializer(serializers.Serializer):
    id = serializers.IntegerField(label='ID', read_only=True)
    name = serializers.CharField(label='姓名', max_length=20)
    birthday = serializers.DateField(label='生日', required=False)
    money = serializers.IntegerField(label='现金', required=False)
    image = serializers.ImageField(label='照片', required=False)

• 手动指定序列化器时常用字段

CharField: CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
IntegerField: IntegerField(max_value=None, min_value=None)
BooleanField: BooleanField()
NullBooleanField: NullBooleanField()
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)
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=)

• 序列化器字段类常用的参数

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页面时，显示的字段帮助提示信息

2. 序列化过程

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

• instance: 序列化时传入的模型类对象
• data: 反序列化时需要传入的数据
• 除了instance和data参数外,在构造Serializer对象时,还可通过context参 数额外添加数据,如serializer = AccountSerializer(account, context={'request': request})通过context参数附加的数据,可以通过Serializer对象的context属性获取,实现了业务视图和序列化器的数据交互

单一对象查询

# 得到一个学生对象
student = StudentInfo.objects.get(id=2)

# 构造序列化器对象
serializer = StudentSerializer(instance=student)

# 获得序列化后的数据
print(serializer.data)
# {'id': 2, 'name': '小明', 'birthday': '1996-07-24', 'money': 36,  'image': None}

查询集QuerySet查询

# 得到所有的学生
students = StudentInfo.objects.all()

# 构造序列化器对象
serializers = StudentSerializer(students, many = True)

# 打印输出结果
print(serializers.data)
# [OrderedDict([('id', 1), ('name', '小花'), ('birthday', '1998-03-22'), ('money', 21), ('image', None]), OrderedDict([('id', 2), ('name', '小明'), ('birthday', '1996-07-24'), ('money', 36), ('image', None])]

多条数据序列化需要加 many=True

外键关联对象查询

• 子model定义了models.ForeignKey(to=Fu),则子model对应的序列化器会默认输出父model的id,也是默认的``

• StringRelatedField:此字段将被序列化为关联父对象字符串表达形式(即str方法返回值 )

• SlugRelatedField:此字段将被序列化为关联对象的指定字段数据

• 关联父model对应的序列化器对象:返回父序列化器定义的所有字段

• model层

from rest_framework import serializers

class ClassInfo(models.Model):
    name = models.CharField(max_length=20, verbose_name='班级名称')
    Info = models.CharField(max_length=20, verbose_name='班级信息')

    class Meta:
        db_table = 'class'
    def __str__(self):
        return self.name

# 学生类用例
class StudentInfo(models.Model):
    name = models.CharField(max_length=20, verbose_name='姓名')
    birthday = models.DateField(verbose_name='生日', null=True)
    money = models.IntegerField(default=0, verbose_name='现金')
    image = models.ImageField(upload_to='studenttest', verbose_name='照片', null=True)
    class Meta:
        db_table = 'students'
    def __str__(self):
        return self.name

• 序列化器

# 班级类序列化器用例
class ClassInfoSerializer(serializers.Serializer):
    name = serializers.CharField(label='班级名称', max_length=20)
    Info = serializers.CharField(label='班级信息', max_length=20)


# 学生类序列化器用例
class StudentSerializer(serializers.Serializer):
    id = serializers.IntegerField(label='ID', read_only=True)
    name = serializers.CharField(label='姓名', max_length=20)
    birthday = serializers.DateField(label='生日', required=False)
    money = serializers.IntegerField(label='现金', required=False)
    image = serializers.ImageField(label='照片', required=False)
    #定义外键字段
    hclass = serializers.PrimaryKeyRelatedField(label='班级', read_only=True)
    #hclass = serializers.StringRelatedField(label='班级', read_only=True)
    #hclass = serializers.SlugRelatedField(slug_field='name')
    #hclass = ClassInfoSerializer(label='班级', read_only=True）

子表关联父表字段

PrimaryKeyRelatedField: 此字段将被序列化为关联对象的主键,也是默认值

student = StudentInfo.objects.get(id=2)
serializer = StudentSerializer(student)
print(serializer.data)
# {'id': 2, 'name': '小明', 'birthday': '1996-07-24', 'money': 36,  'image': None, 'hclass':2}

StringRelatedField: 此字段将被序列化为关联对象的字符串表示方式(即模型类中__str__方法的返回值)

student = StudentInfo.objects.get(id=2)
serializer = StudentSerializer(student)
print(serializer.data)
# {'id': 2, 'name': '小明', 'birthday': '1996-07-24', 'money': 36,  'image': None, 'hclass':'九年级二班'}

SlugRelatedField: 此字段将被序列化为关联对象的指定字段数据

student = StudentInfo.objects.get(id=2)
serializer = StudentSerializer(student)
print(serializer.data)
# {'id': 2, 'name': '小明', 'birthday': '1996-07-24', 'money': 36,  'image': None, 'hclass':'九年级二班'}

ClassInfoSerializer(label='班级', read_only=True)：使用关联对象的序列化器

student = StudentInfo.objects.get(id=2)

# 使用了自定义的序列化器
serializer = StudentSerializer(student)
print(serializer.data)
# {'id': 2, 'name': '小明', 'birthday': '1996-07-24', 'money': 36,  'image': None, 'hclass':OrderedDict([('id', 2), ('name', '九年级二班'), ('Info', '这里是九年级二班的信息')])}

父表关联子表字段

父表中默认不会生成关联字段(从表字段), 可以手动指定

• 子表的外键没有定义related_name参数时：

studentinfo_set = serializers.StringRelatedField(many=True)

• 子表表的外键定义了related_name参数时(假设related_name='studentinfo')

 studentinfo = serializers.StringRelatedField(many=True)

class ClassInfoSerializer(serializers.Serializer)
    name = serializers.CharField(label='班级名称', max_length=20)
    Info = serializers.CharField(label='班级信息', max_length=20)
    studentinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True) 

serializer = ClassInfoSerializer(ClassInfo.objects.get(id=2))
print(serializer.data)
# {'id': 2, 'name': '九年级二班', 'info': 'xxxxxx', 'studentinfo_set': [1, 2, 9]} #1, 2, 9代表了字表中与之关联的学生id