序列化器的字段处理不仅会验证值(validate),也会将接收值转化为相应类型(clean)
1 核心参数
1. read_only
只应该包含在输出中,任何输入字段(创建和更新)中包含该属性都会被忽略,默认为False
2. write_only
只会在update/create时使用,外界也无法读取该值,默认为False
3. required
正常情况下在反序列化时字段没有提供值,将会报错,设置为False,就可以为空,默认为True
4. allow_null
验证数据时允许为空,默认为False,不允许
5. default
如果没有提供时,就返回默认值。可以将其设置为一个函数或其他可调用的函数,在这种情况下,每次使用该值时都将对其进行评估。当被调用时,它将不会收到任何参数。如果可调用对象有一个set_context方法,那么每次调用字段实例的值作为参数时都将调用该方法。这与验证器的工作方式相同。
同时包含default 和 required参数的将会报错
6. source
用于填充该字段,可以是一个方法,只接受一个self参数,如URLField(source=’get_absolute_url’),也可以通过‘.’快捷方式调用对象属性,如EmailField(source=’user.email’)
source=’*’有着特殊的意义,表示将整个对象都会传递进去,在创建嵌套结构和或者需要完整对象来确定输出的时候特别有用。默认为字段名。
7. validators
用于验证字段值的函数列表,失败抛出serializers.ValidationError
8. error_messages
表示错误代码的错误信息
9. label
可以作为HTML表单字段中的name使用,或者其他描述性文本
10. help_text
用于在HTML表单中描述该字段
11. initial
用于预填充HTML表单字段,可以是一个可调用对象,如
import datetime
from rest_framework import serializers
class ExampleSerializer(serializers.Serializer):
day = serializers.DateField(initial=datetime.date.today)
12. style
用于控制render怎么渲染的字典参数
# Use <input type="password"> for the input.
password = serializers.CharField(
style={
'input_type': 'password'}
)
# Use a radio input instead of a select input.
color_channel = serializers.ChoiceField(
choices=['red', 'green', 'blue'],
style={
'base_template': 'radio.html'}
)
2. 常用字段
1. Boolean fields
- BooleanField
当使用表单时,如果忽略一个值,那么他将始终被视为False,即使它的默认值设为True - NullBooleanField
接受None作为一个验证值
2. 字符串字段
- CharField
参数:CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True) trim_whitespace是否清除末尾空格 - EmailField
EmailField(max_length=None, min_length=None, allow_blank=False) - RegexField
RegexField(regex, max_length=None, min_length=None, allow_blank=False)
regex参数要么是一个正则编译过的正则表达式对象,要么是一个字符串 - SlugField
RegexField字段翻版, regex参数为[a-zA-Z0-9_-]+
SlugField(max_length=50, min_length=None, allow_blank=False) - URLField
RegexField,regex = http:///
URLField(max_length=200, min_length=None, allow_blank=False) - UUIDField
确保输入的是一个合法的 UUID字符串,to_internal_value方法返回一个uuid.UUID对象, 输出时返回一个规范书写的字符串
”de305d54-75b4-431b-adb2-eb6b9e546013”
UUIDField(format=’hex_verbose’),format(表现形式,并不影响原本值)值有以下几种:
- ‘hex_verbose’:”5ce0e9a5-5ffa-654b-cee0-1238041fb31a”,规范的16进制写法
- ‘hex’:”5ce0e9a55ffa654bcee0