进行数据的校验
对数据对象进行转换
简单点,序列化器作用就是将对象序列化,以便于在网络中进行传输,和将网络中传输的数据反序列化为实体对象,便于服务端处理和持久化等,在反序列化时可以对数据进行校验等。
根据model类定义序列化器
class BookSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(read_only=True) # read_only表示该字段只能被序列化,不能被反序列化 title = serializers.CharField(max_length=20) # max_length最大长度 pub_date = serializers.DateField(required=True) # required字段是否必填 price = serializers.IntegerField(required=False)
注意:serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。
字段 | 字段构造方式 |
---|---|
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页面时,显示的字段帮助提示信息 |
定义好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属性获取。
ModelSerializer是serializers.Serializer的子类,与常规的Serializer相同,但提供了:
基于模型类自动生成一系列字段
包含默认的create()和update()的实现
class BookSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = Book fields = '__all__'
model 指明参照哪个模型类
fields 指明为模型类的哪些字段生成
fields字段指定
1) 使用fields来明确字段,__all__
表名包含所有字段,也可以写明具体哪些字段,如
class BookSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = Book fields = ('id', 'title', 'pub_date')
2) 使用exclude可以明确排除掉哪些字段
class BookSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = Book exclude = ('price',)
3) 显示指明字段,如:
class PublishSerializer(serializers.ModelSerializer): # 出版社类的序列化器 book = BookSerializer(many=true) class Meta: model = Publish fields = ('id', 'name', 'address', 'email', 'book')
4) 指明只读字段
可以通过read_only_fields指明只读字段,即仅用于序列化输出的字段
class BookSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = Book fields = ('id', 'title', 'pub_date', 'price') read_only_fields = ('id',)