当前位置: 移动技术网 > IT编程>脚本编程>Python > Django RestFul framework Serializer序列化器的使用(定义)

Django RestFul framework Serializer序列化器的使用(定义)

2018年09月19日  | 移动技术网IT编程  | 我要评论

张鸿志,综琼瑶之王爷吉祥,澳门物流

---恢复内容开始---

serializer 序列化器是drf框架中重要的组成部分,可以快速根据 django orm 或者其它库自动序列化/反序列化;

serializer 作用:

  1. 进行数据的校验

  2. 对数据对象进行转换

代码中使用的模型类:

1. 书籍模型类:

from django.db import models

#定义图书模型类bookinfo
class bookinfo(models.model):
    btitle = models.charfield(max_length=20, verbose_name='名称')
    bpub_date = models.datefield(verbose_name='发布日期')
    bread = models.integerfield(default=0, verbose_name='阅读量')
    bcomment = models.integerfield(default=0, verbose_name='评论量')
    is_delete = models.booleanfield(default=false, verbose_name='逻辑删除')

    class meta:
        db_table = 'tb_books'  # 指明数据库表名
        verbose_name = '图书'  # 在admin站点中显示的名称
        verbose_name_plural = verbose_name  # 显示的复数名称

    def __str__(self):
        """定义每个数据对象的显示信息"""
        return self.btitle

 

2. 书中的英雄模型类:

#定义英雄模型类heroinfo

class heroinfo(models.model): gender_choices = ( (0, 'male'), (1, 'female') ) hname = models.charfield(max_length=20, verbose_name='名称') hgender = models.smallintegerfield(choices=gender_choices, default=0, verbose_name='性别') hcomment = models.charfield(max_length=200, null=true, verbose_name='描述信息') hbook = models.foreignkey(bookinfo, on_delete=models.cascade, verbose_name='图书') # 外键 is_delete = models.booleanfield(default=false, verbose_name='逻辑删除') class meta: db_table = 'tb_heros' verbose_name = '英雄' verbose_name_plural = verbose_name def __str__(self): return self.hname

说明: 书籍和英雄是一对多的关系

3. 定义序列化类

1)定义方法

  django rest ful framework 中的serializer使用类来定义,须继承自 reset_framework.serializer.serializer.

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)

注意: 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(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=<a_field_instance>, min_length=none, max_length=none)
dictfield dictfield(child=<a_field_instance>)

选项参数:

参数名称作用
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页面时,显示的字段帮助提示信息

4. 创建serializer对象

定义好serializer类后,就可以创建serializer对象了。

serializer的构造方法为:

serializer(instance=none, data=empty, **kwarg)

说明:

1)用于序列化时,将模型类对象传入instance参数

2)用于反序列化时,将要被反序列化的数据传入data参数

3)除了instance和data参数外,在构造serializer对象时,还可通过context参数额外添加数据,如

 

serializer = bookinfoserialize(book, context={'request': request})

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

如对本文有疑问,请在下面进行留言讨论,广大热心网友会与你互动!! 点击进行留言回复

相关文章:

验证码:
移动技术网