drf常用字段

目录

• 字段名称
• 选项参数
• 通用参数
• validators字段说明
• source字段(了解)
• SerializerMethodField

字段名称

字段	字段构造方式	备注
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=)	重点
SerializerMethodField	返回定制格式，需要定义一个对应函数

选项参数

参数名称	说明	备注
max_length	最大长度	针对charfield
min_lenght	最小长度	针对charfield
allow_blank	是否允许为空	针对charfield
trim_whitespace	是否截断空白字符
max_value	最小值	针对interfield
min_value	最大值	针对interfield

通用参数

参数名称	说明
read_only	表明该字段仅用于序列化输出，默认False
write_only	表明该字段仅用于反序列化输入，默认False
required	表明该字段在反序列化时必须输入，默认True
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None，默认False
allow_blank	表明该字段是否允许传入""，默认False
validators	该字段使用的验证器
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时，显示的字段名称
help_text	用于HTML展示API页面时，显示的字段帮助提示信息
source	用于自定义序列化字段负，或应用于一对多序列化

validators字段说明

validators参数可以针对一个字段进行校验，需要单独写一个校验函数（其实局部钩子、全局钩子就够用了）

校验顺序（前提是都配置了相关限制参数）：

1. 先针对字段的长度等进行校验
2. 再针对validators进行校验
3. 针对局部钩子进行校验
4. 针对全局钩子进行校验

• 语法

# 1. 在字段参数中配置validators=[校验函数]
# 2. 配置相关的 校验函数，校验函数最后使用raise serializers.ValidationError("报错信息")进行返回值

• 示例

class BookSerializer(serializers.Serializer):
    # 在字段中配置validators字段，并指向一个函数，函数可针对这个字段进行校验
    name = serializers.CharField(max_length=32, validators=[auth])
    price = serializers.CharField()
    publish = serializers.CharField()

# 定义上面字段中要验证的函数
def auth(obj):
    if obj == 'jack':
        # 抛出异常
        raise serializers.ValidationError("项目名字段name不能为jack")

• 返回值：

source字段(了解)

source参数可以定制字段名字，对于一对多字段也能以 外键字段.字段名 的方式调用。对于多对多字段就不能用这种方法了

• 对于自有字段，在source中直接写字段名即可
• 对于一对多字段，在source中写 外键字段名.字段名
• 多对多字段无法实现
• source名与序列化字段名不能一致

# models.py中定义表
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.CharField(max_length=32)
    # 图书与出版社外键字段，一对多
    publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)
    # 图书与作者外键字段，多对多
    authors = models.ManyToManyField(to='Author')


class Publish(models.Model):
    name = models.CharField(max_length=32)
    addr = models.CharField(max_length=64)


# 序列化文件中定义序列化类
from rest_framework import serializers
class BookSerializers(serializers.Serializer):
    game_name = serializers.CharField(source='name')
    game_price = serializers.CharField(source='price')
    # 一对多外键的序列化方法
    # 对于外键，如果不指定source，会返回"publish": "Publish object (1)"字符串
    # 当然也可以在Publish表中定义__str__函数返回，这种方案不太常规
    publish = serializers.CharField(source='publish.name')
    # 外键中的其他字段也可以一并返回
    addr = serializers.CharField(source='publish.addr')

    # 多对多序列化方法，使用source不行
    # 多对多与一对多不同，如果使用与一对多同样的方案，前端拿到的值就会是 null
    author_name = serializers.CharField(source='authors.name')

SerializerMethodField

• 语法
• 在序列化类中进行定义
  序列化字段名 = serializers.SerializerMethodField()
  def get_序列化字段名(self, obj) 这里的obj其实就是models.py中定义的表名
  return {} 最后return什么，前端就收到什么

class BookSerializers(serializers.Serializer):
    game_name = serializers.CharField(source='name')
    game_price = serializers.CharField(source='price')

    publish = serializers.SerializerMethodField()
    # obj其实就是序列化对象所在的表的表名
    # 定义函数时必须是  get_字段名 ，这里面的字段名指的是SerializerMethodField所在的字段
    # get_字段名 中的字段名是什么，前端拿到的字段名就是什么
    def get_publish(self, obj):
        # 这里的obj其实就相当于Book.publish.name中的Book
        return {'name': obj.publish.name, 'phone': obj.publish.addr}

    # 多对多关系的字定义
    authors = serializers.SerializerMethodField()
    def get_authors(self, obj):
        author_list = []
        for author in obj.authors.all():
            author_list.append({'name': author.name, 'phone': author.phone})
        return author_list