您当前的位置: 首页 > 

IT之一小佬

暂无认证

  • 3浏览

    0关注

    1192博文

    0收益

  • 0浏览

    0点赞

    0打赏

    0留言

私信
关注
热门博文

定义Serializer序列化器

IT之一小佬 发布时间:2021-07-17 20:58:47 ,浏览量:3

序列化器的作用:

  1. 进行数据的校验
  2. 对数据对象进行转换
定义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. 字段与选项

常用字段类型:

字段字段构造方式BooleanFieldBooleanField()NullBooleanFieldNullBooleanField()CharFieldCharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)EmailFieldEmailField(max_length=None, min_length=None, allow_blank=False)RegexFieldRegexField(regex, max_length=None, min_length=None, allow_blank=False)SlugFieldSlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段,验证正则模式 [a-zA-Z0-9-]+URLFieldURLField(max_length=200, min_length=None, allow_blank=False)UUIDFieldUUIDField(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"IPAddressFieldIPAddressField(protocol='both', unpack_ipv4=False, **options)IntegerFieldIntegerField(max_value=None, min_value=None)FloatFieldFloatField(max_value=None, min_value=None)DecimalFieldDecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置DateTimeFieldDateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)DateFieldDateField(format=api_settings.DATE_FORMAT, input_formats=None)TimeFieldTimeField(format=api_settings.TIME_FORMAT, input_formats=None)DurationFieldDurationField()ChoiceFieldChoiceField(choices) choices与Django的用法相同MultipleChoiceFieldMultipleChoiceField(choices)FileFieldFileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)ImageFieldImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)ListFieldListField(child=, min_length=None, max_length=None)DictFieldDictField(child=)

选项参数:

参数名称作用max_length最大长度min_lenght最小长度allow_blank是否允许为空trim_whitespace是否截断空白字符max_value最大值min_value最小值

通用参数:

参数名称说明read_only表明该字段仅用于序列化输出,默认Falsewrite_only表明该字段仅用于反序列化输入,默认Falserequired表明该字段在反序列化时必须输入,默认Truedefault反序列化时使用的默认值allow_null表明该字段是否允许传入None,默认Falsevalidators该字段使用的验证器error_messages包含错误编号与错误信息的字典label用于HTML展示API页面时,显示的字段名称help_text用于HTML展示API页面时,显示的字段帮助提示信息

【read_only=True时,post不传此属性内容也不会报错;write_only=True时,get请求是得不到此属性的内容的】

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属性获取。

关注
打赏
1665675218
查看更多评论
立即登录/注册

微信扫码登录

0.1225s