• DRF中序列化器定义及使用


    首先需要明白序列化和反序列化的定义及作用:

      序列化是将程序语言转换为JSON/XML; 反序列化是将JSON/XML转换为程序语言;

      对应到Django中,序列化即把模型对象转换为字典形式, 在返回给前端,主要用于输出, 反序列化是将接受前端的字典类型数据,通过验证再转换

      为模型对象.

      序列化器的作用:

      1.  进行数据的校验
      2.  对数据对象进行转换

    环境安装与配置

    DRF需要以下依赖:

    • Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
    • Django (1.10, 1.11, 2.0)

    DRF是以Django扩展应用的方式提供的.(若没有Django环境,需要先创建环境安装Django)

    1. 安装DRF

    pip install djangorestframework
    

    2. 添加rest_framework应用

    在工程中的settings.py文件的INSTALLED_APPS中添加'rest_framework'。

    INSTALLED_APPS = [
        ...
        'rest_framework',
    ]

    定义Serializer

    1. 定义方法

    Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer。

    例如创建以下序列化器, 具体的字段类型及选项参数如下:

    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)

    2. 字段与选项

    常用字段类型:

    字段字段构造方式
    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=<a_field_instance>, min_length=None, max_length=None)
    DictField DictField(child=<a_field_instance>)

    选项参数

    参数名称作用
    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页面时,显示的字段帮助提示信息

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

     
  • 相关阅读:
    golang中的GOPATH使用和简单项目配置
    无法go get,Golang手动安装依赖包【package】
    Golang入门注意事项
    C语言创建单向链表
    Linuxlinux上安装git 测试
    剖析虚幻渲染体系(14) 延展篇:现代渲染引擎演变史Part 4(结果期)
    翻译器
    [Tips] Mac Terminal配置Git使用ClashX
    [Tips] Linux ssh 基于密钥文件免密登陆
    【Notes】Mac从零开始按照oh my zsh
  • 原文地址:https://www.cnblogs.com/skaarl/p/9483141.html
Copyright © 2020-2023  润新知