django Serializer序列化使用方法详解

serializer序列化器

定义serializer

1. 定义方法

django rest framework中的serializer使用类来定义，须继承自rest_framework.serializers.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 = 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)

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

2. 字段与选项

常用字段类型：

字段	字段构造方式
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') 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=)

选项参数：

参数名称	作用
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） 先查询出一个图书对象

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, 'image': none}

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（即所属的图书）字段如何序列化？

我们先定义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, allow_null=true)

对于关联字段，可以采用以下几种方式：

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) stringrelatedfield

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

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

使用效果

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

3）hyperlinkedrelatedfield

此字段将被序列化为获取关联对象数据的接口链接

hbook = serializers.hyperlinkedrelatedfield(label='图书', read_only=true, view_name='books-detail')

必须指明view_name参数，以便drf根据视图名称寻找路由，进而拼接成完整url。

使用效果

{'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': 'http://127.0.0.1:8000/books/2/'}

我们暂时还没有定义视图，此方式不再演示。

4）slugrelatedfield

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

hbook = serializers.slugrelatedfield(label='图书', read_only=true, slug_field='bpub_date')

slug_field指明使用关联对象的哪个字段

使用效果

{'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': datetime.date(1986, 7, 24)}

5）使用关联对象的序列化器

hbook = bookinfoserializer()

使用效果

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

6） 重写to_representation方法

序列化器的每个字段实际都是由该字段类型的to_representation方法决定格式的，可以通过重写该方法来决定格式。

注意，to_representations方法不仅局限在控制关联对象格式上，适用于各个序列化器字段类型。

自定义一个新的关联字段：

class bookrelatefield(serializers.relatedfield):
  """自定义用于处理图书的字段"""
  def to_representation(self, value):
    return 'book: %d %s' % (value.id, value.btitle)

指明hbook为bookrelatefield类型

hbook = bookrelatefield(read_only=true)

使用效果

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

many参数

如果关联的对象数据不是只有一个，而是包含多个数据，如想序列化图书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)
  image = serializers.imagefield(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, 'image': non

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。