序列化组件

最新推荐文章于 2024-06-13 09:00:30 发布

GG_Bonin

最新推荐文章于 2024-06-13 09:00:30 发布

阅读量352

点赞数 1

分类专栏： Django 文章标签：数据库前端 django python

本文链接：https://blog.csdn.net/weixin_52596593/article/details/127073352

版权

Django 专栏收录该内容

20 篇文章 2 订阅

订阅专栏

序列化类常用字段类和字段参数

1.常用字段

$\bullet$ 重点掌握的

CharField：max_length=None, min_length=None, allow_blank=False, trim_whitespace=True

BooleanField：BooleanField()

IntegerField：IntegerField(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: 小数点位置

$\bullet$ 其他更多
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)
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)
FloatField：
    FloatField(max_value=None, min_value=None)
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)
2.常用字段参数

选项参数：

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

通用参数：

参数名称作用
required 表明该字段在反序列化时必须输入，默认True
default 反序列化时使用的默认值
allow_null 表明该字段是否允许传入None，默认False
validators 该字段使用的验证码
error_messages 包含错误编号与错误信息的字典
label 用于HTML展示API页面时显示的字段名称
help_text 用于HTML展示API页面时显示的字段帮助提示信息

重点补充：

$\bullet$ read_only：表明该字段仅用于序列化输出

$\bullet$ write_only：表明该字段仅用于反序列化输入，默认False

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

参数名称	作用
required	表明该字段在反序列化时必须输入，默认True
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None，默认False
validators	该字段使用的验证码
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时显示的字段名称
help_text	用于HTML展示API页面时显示的字段帮助提示信息

序列化类高级用法之source

使用source可以指定序列化表中的哪个字段也可以是方法，且还可以做夸表查询，用于重命名，重命名后在前端显示

source代码演示：

class BookSerializer(serializers.Serializer):
    # 序列化book表中的name字段并重命名成book_name
    book_name = serializers.CharField(max_length=8,min_length=3,source='name')
    # 序列化与book表关联的出版社名字重名成publish_name
    publish_name = serializers.CharField(max_length=8,min_length=3,scource='publish.name')
    # 序列化表模型中方法并重命名 比如方法为verify重命名成aa
    aa = serializers.CharField(max_length=8, min_length=3,source='verify')

定制序列化字段的两种方式

1.使用SerializerMethodField

class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8, min_length=3)
    price = serializers.IntegerField(min_value=10, max_value=99)
    publish_date = serializers.DateField()
    # publish要序列化成 {name:出版社名，city：地址，email:邮件}
    # 方式一：SerializerMethodField必须配合一个方法(get_字段名,需要接受一个参数)，方法返回什么，这个字段就是什么
    publish = serializers.SerializerMethodField()
    def get_publish(self, obj):
        # obj 是当前序列化的对象
        return {'name': obj.publish.name, 'city': obj.publish.city, 'email': obj.publish.email}

2.在表模型中写

# 表模型中
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.DecimalField(max_digits=5, decimal_places=2)
    publish_date = models.DateField(null=True)

    publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)
    authors = models.ManyToManyField(to='Author')

    # 写了个方法，可以包装成数据属性，也可以不包
    def publish_detail(self):
        return {'name': self.publish.name, 'city': self.publish.city, 'email': self.publish.email}

    def author_list(self):
        res_list = []
        for author in self.authors.all():
            res_list.append({'id': author.id, 'name': author.name, 'age': author.age})
        return res_list

# 序列化类中
class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8, min_length=3)
    price = serializers.IntegerField(min_value=10, max_value=99)
    publish_date = serializers.DateField()
    # 方式二：在表模型中写方法
    publish_detail = serializers.DictField(read_only=True)

3.有关联关系表的反序列化保存

# 1 序列化字段和反序列化字段不一样  【序列化类中】
# 反序列化用的
publish = serializers.CharField(write_only=True)
authors = serializers.ListField(write_only=True)
#序列化用的
publish_detail = serializers.DictField(read_only=True)
author_list = serializers.ListField(read_only=True)
    
# 2 一定要重写create  【序列化类中】
def create(self, validated_data): 
    # validated_data 校验过后的数据  
    book = Book.objects.create(name=validated_data.get('name'),
        price=validated_data.get('price'),
        publish_date=validated_data.get('publish_date'),
        publish_id=validated_data.get('publish'),
        )
    authors = validated_data.get('authors')
    book.authors.add(*authors)
    return book

ps：使用继承Serializer的序列化类如果是新增或者修改在序列化类中都需要重写create或update，且序列化中每个字段都要写无论是序列化还是反序列化，我们可以通过ModelSerializer来更简单的做

反序列化之数据校验

反序列化的数据校验与forms的数据校验很像也有字段自己的校验规则、局部钩子与全局钩子

$\bullet$ 继承了Serializer后字段校验写法

name = serializers.CharField(
                max_length=8,
                min_length=3,
                error_messages={'min_length': "太短了"})
# error_messages抛出异常

$\bullet$ 继承了ModelSerializer后字段校验写法

extra_kwargs = {
    'name':{'max_length':8,'min_length':3,'error_messages':{'min_length': "太短了"}}
    'price':{'max_value':100,'min_value':0,'error_messages':{'min_length': "太小了"}}
}

$\bullet$ 局部、全局校验

# 继承了Serializer、ModelSerializer的写法一样
# 局部钩子
def validate_name(self,name):
    if name.startswith('sb'):
        # 校验不通过抛异常
        raise ValidationError('名字不能以sb开头你是不是傻')
    else:
        return name
# 全局钩子 
def validate(self,user):
    if user.get('password') == user.get('re_password'):
        return user
    else:
        raise ValidationError('')

模型类序列化器

模型类序列化器就是(ModelSerializer)的使用，ModelSerializer继承了serializers所以用起来更加的方便不需要自己再重写create和update了
class BookModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book # 要序列化的表模型
        fields = ['__all__'] # 要序列化的字段，__all__表示所有
        extra_kwargs = {
            'name':{'max_length':8}, # name加最大值属性
            'publish':{'write_only':True}, # 字段只序列化写入
            'authors':{'write_only':True}, # 字段只序列化写入
}
总结

$\bullet$ ModelSerializer使用步骤

1.写一个类继承ModelSerializer字段从表中映射不需要再写字段

2.再在类的内部写一个class Meta类

3.在Meta类中写model指定要序列化的表模型

4.在Meta类中fields指定序列化的字段：__all__表示表中所有的字段

5.在Meta类中指定extra_kwargs给字段添加字段参数

$\bullet$ ModelSerializer小知识

在序列化类中可以重写字段会优先使用重写的

以后不用自己再重写create和update了

GG_Bonin

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
序列化组件

CharField：max_length=None, min_length=None, allow_blank=False, trim_whitespace=True BooleanField：BooleanField() IntegerField：IntegerField(max_value=None, min_value=None) DecimalField：DecimalField(max_digits, decimal_places, coerc
复制链接

扫一扫