drf 序列化

最新推荐文章于 2024-11-02 22:17:47 发布
最新推荐文章于 2024-11-02 22:17:47 发布
阅读量304 收藏
点赞数
文章标签： python 数据库 json
原文链接：http://www.cnblogs.com/Hades123/p/11461312.html
版权

目录

drf 序列化

什么是序列化与反序列化

  • 序列化：就是把对象转化为可以进行网络传输的数据（程序语言转换为JSON/XML）
  • 反序列化：就是把网络传输的数据转化为对象进行使用（JSON/XML转换为程序语言）

序列化的作用

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

简单认识序列化

首先来进行准备工作：

from django.db import models

class User(models.Model):
    # choices的字段，直接获取只能获取 0 | 1 | 2
    # 想获取 值后 的映射关系 男 | 女 | 哇塞 用  get_字段名_display()
    # eg：user_obj.get_sex_diaplay()
    SEX_CHOICES = [
        (0, '男'),
        (1, '女'),
        (2, '哇塞')
    ]
    username = models.CharField(max_length=64, unique=True)
    password = models.CharField(max_length=64)
    sex = models.IntegerField(choices=SEX_CHOICES, default=0)
    icon = models.ImageField(upload_to='icon', default='icon/default.png')
    create_time = models.DateTimeField(auto_now_add=True, null=True)
    is_delete = models.BooleanField(default=False)

    class Meta:
        db_table = 'old_boy_user'
        verbose_name = '用户'
        verbose_name_plural = verbose_name

    def __str__(self):
        return self.username

自定义序列化类

定义

通过继承rest_framework.serializers中的Serializer类进行定义，但需要有如下几个注意点：

  1. 参与序列化的属性名必须与model类的属性字段名相同
  2. 不需要序列化的属性字段在序列化类中不需要声明
  3. 方法序列化字段，不需要在model类中有字段属性对应，值来源于get_字段方法，序列化字段可以完全自定义，也可以与model类中有字段属性相同

如：

from rest_framework import serializers
from django.conf import settings
from . import models
# 序列化
class UserSerializer(serializers.Serializer):
    username = serializers.CharField()
    
    # 不需要序列化的不需要声明
    # password = serializers.CharField()
    
    sex = serializers.IntegerField()   # 只能返回数字
    # 自定义序列化字段
    gender = serializers.SerializerMethodField()
    def get_gender(self, user_obj):
        return user_obj.get_sex_display()    # 返回性别
    
    # icon = serializers.ImageField()
    # 二次资源需要返回完整的url链接
    icon = serializers.SerializerMethodField()
    def get_icon(self, user_obj):
        icon_url = 'http://127.0.0.1:8000{}{}'.format(settings.MEDIA_URL, user_obj.icon)
        return icon_url
常用字段类型
字段字段构造方式
BooleanFieldBooleanField()
NullBooleanFieldNullBooleanField()
CharFieldCharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailFieldEmailField(max_length=None, min_length=None, allow_blank=False)
RegexFieldRegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugFieldSlugField(max*length=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9*-]+
URLFieldURLField(max_length=200, min_length=None, allow_blank=False)
UUIDFieldUUIDField(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"
IPAddressFieldIPAddressField(protocol='both', unpack_ipv4=False, **options)
IntegerFieldIntegerField(max_value=None, min_value=None)
FloatFieldFloatField(max_value=None, min_value=None)
DecimalFieldDecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置
DateTimeFieldDateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
DateFieldDateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeFieldTimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationFieldDurationField()
ChoiceFieldChoiceField(choices) choices与Django的用法相同
MultipleChoiceFieldMultipleChoiceField(choices)
FileFieldFileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageFieldImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListFieldListField(child=, min_length=None, max_length=None)
DictFieldDictField(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, **kwargs)

说明：

  1. 用于序列化时，将模型类对象传入instance参数，当序列化数据为单列集合时，此时many=True必须明确

    补充：单列集合就是具有索引的集合，例如列表，元组，集合，django中的 QuerySet

  2. 除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如

    serializer = UserSerializer(account, context={'request': request})

    通过context参数附加的数据，可以通过Serializer对象的context属性获取。

案例

from rest_framework.views import APIView
from utils_home.response import APIResponse
from . import models, serializers
class UserAPIView(APIView):
    # 序列化对象：
    # UserSerializer(序列化数据, many)
    # 1）序列化数据可以为User类的单个对象，many=False(默认，可以省略不写)
    # 2）序列化数据可以为状态User类的多个对象的单列集合
    #       [] () {} QuerySet，此时many=True必须明确
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:  # 获取单个资源
            user_obj = models.User.objects.filter(pk=pk).first()
            if not user_obj:
                return APIResponse(1, 'pk error')
            user_obj_data = serializers.UserSerializer(user_obj).data
            return APIResponse(0, 'ok', results=user_obj_data)

        # 获取多个资源
        user_query = models.User.objects.all()
        user_ser = serializers.UserSerializer(user_query, many=True)
        user_list_data = user_ser.data
        return APIResponse(0, 'get ok', results=user_list_data)

简单认识反序列化

自定义反序列化类

同样通过继承rest_framework.serializers中的Serializer类进行定义，但需要有如下几个注意点：

  1. 在字段类型后定义基础校验规则
  2. 基础校验完毕，可以在局部钩子方法中进行单个字段校验规则的扩展
  3. 在局部钩子校验完毕，在全局钩子中完成多个字段协同校验
  4. 如果需要提供数据的增加或修改功能，需要重写create或update方法，完成数据的入库

如：

from rest_framework import serializers
from django.conf import settings
from . import models
# 反序列化
class UserDeserializer(serializers.Serializer):
    # 1）默认校验
    username = serializers.CharField(
        min_length=3,
        error_messages={
            'min_length': '用户名太短'
        }
    )
    password = serializers.CharField(
        min_length=3,
        error_messages={
            'min_length': '密码太短'
        }
    )
    re_password = serializers.CharField(
        min_length=3,
        required=True,
        error_messages={
            'min_length': '确认密码太短',
            'required': '确认密码不能为空'
        }
    )

    # 有默认值的字段，前台可能提供，可能提供，这样的字段用required=False处理
    sex = serializers.IntegerField(required=False)

    # 2）局部钩子: validate_字段名(self, 字段值)
    def validate_username(self, value):
        if 'sb' in value:
            raise serializers.ValidationError('用户名包含敏感词汇')
        return value

    # 3）全局钩子：validate(self, 所有字段值)
    def validate(self, attrs):
        print(attrs)
        password = attrs.get('password')
        # 校验通过后，要完成数据的增加，该增加不参与，要从数据们中剔除
        re_password = attrs.pop('re_password')
        if password != re_password:
            raise serializers.ValidationError({'re_password': '两次密码不一致'})
        return attrs

    # 4）完成model类对象的增加，必须重写create方法
    def create(self, validated_data):
        try:
            return models.User.objects.create(**validated_data)
        except:
            raise IOError('数据库入库失败')  # 数据库异常在异常模块中完善

使用自定义反序列化对象

说明：

  1. 反序列化数据可以为单个数据字典，many=False或者不写

  2. 用于反序列化时，将要被反序列化的数据传入data参数，当序列化数据为单列集合时，此时many=True必须明确

  3. 反序列化数据必须赋值给data关键字参数，才能进行数据校验

  4. 序列化对象.is_valid(raise_exception=True)校验失败会自动返回错误信息给前台

  5. if 序列化对象.is_valid(): 可以自定义校验成功与失败分支的返回结果

    成功可以完成新增或修改，失败错误信息在 序列化对象.errors 中

from rest_framework.views import APIView
from utils_home.response import APIResponse
from . import models, serializers
class UserAPIView(APIView):
    # 反序列化请求数据
    def post(self, request, *args, **kwargs):
        request_data = request.data
        print(request_data)
        user_ser = serializers.UserDeserializer(data=request_data)
        # 自动返回错误信息
        # user_ser.is_valid(raise_exception=True)
        if user_ser.is_valid():  # 自定义处理校验成功的逻辑
            user_obj = user_ser.save()
            return APIResponse(0, 'ok',
                results=serializers.UserSerializer(user_obj).data
            )
        else:  # 自定义返回错误信息
            return APIResponse(1, 'failed', results=user_ser.errors)

序列化器（序列化与反序列化整合）

自定义序列化器

说明：

  1. 参与序列化与反序列化的字段(包括自定义字段)都必须明确

  2. 通过 read_only=True 表明该字段只参与序列化

  3. 通过 write_only=True 表明该字段只参与反序列化

  4. 参与反序列化，但是是选填字段(前台可以提供或不提供)，用 required=False 处理

  5. 要完成数据库增加，需要重写 create 方法

  6. 要完成数据库更新，需要重写 update 方法
    • instance参数传入的是自定义传入的要更新的原数据（pk | obj | queryset）
    • validated_data：是校验通过后的新数据
from rest_framework import serializers
from django.conf import settings
from . import models
# 序列化与反序列化整合
class UserV2Serializer(serializers.Serializer):    
    username = serializers.CharField(min_length=3)
    # 只参与反序列化 write_only=True
    password = serializers.CharField(write_only=True, min_length=3)
    sex = serializers.IntegerField(write_only=True, required=False)
    re_password = serializers.CharField(write_only=True, min_length=3, required=True)
    # 只参与序列化 read_only=True
    gender = serializers.SerializerMethodField(read_only=True)
    def get_gender(self, user_obj):
        return user_obj.get_sex_display()
    icon = serializers.SerializerMethodField(read_only=True)
    def get_icon(self, user_obj):
        icon_url = 'http://127.0.0.1:8000{}{}'.format(settings.MEDIA_URL, user_obj.icon)
        return icon_url

    def validate_username(self, value):
        if 'sb' in value:
            raise serializers.ValidationError('用户名包含敏感词汇')
        return value

    def validate(self, attrs):
        print('序列化内：', self.context)
        password = attrs.get('password')
        re_password = attrs.get('re_password')
        if password:
            if re_password:
                attrs.pop('re_password')
                if password != re_password:
                    raise serializers.ValidationError({'re_password': '两次密码不一致'})
            else:
                raise serializers.ValidationError({'re_password': '密码必须确认'})
        return attrs

    # 增
    def create(self, validated_data):
        try:
            return models.User.objects.create(**validated_data)
        except:
            raise IOError('数据库入库失败')
    # 改
    def update(self, instance, validated_data):
        # instance的值外部反序列化传入要更新的自定义标识决定
        instance.update(**validated_data)
        return instance.first()

使用序列化器完成五大接口

from rest_framework.views import APIView
from utils_home.response import APIResponse
from . import models, serializers
class UserV2APIView(APIView):
    # 单取、群取
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        # 单取
        if pk:
            user_obj = models.User.objects.filter(pk=pk, is_delete=False).first()
            if not user_obj:
                return APIResponse(1, 'pk error')
            user_obj_data = serializers.UserV2Serializer(user_obj).data
            return APIResponse(0, 'ok', results=user_obj_data)
        
        # 群取
        user_query = models.User.objects.filter(is_delete=False).all()
        user_ser = serializers.UserV2Serializer(user_query, many=True)
        user_list_data = user_ser.data
        return APIResponse(0, 'ok', results=user_list_data)

    # 单增
    def post(self, request, *args, **kwargs):
        request_data = request.data
        print(request_data)
        user_ser = serializers.UserV2Serializer(data=request_data)
        if user_ser.is_valid():
            user_obj = user_ser.save()
            return APIResponse(0, 'ok',
                results=serializers.UserV2Serializer(user_obj).data
            )
        else:
            return APIResponse(1, 'failed', results=user_ser.errors)

    # 单整体改
    def put(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if not pk:
            return APIResponse(1, 'pk error')

        user_query = models.User.objects.filter(pk=pk, is_delete=False)
        if not user_query:
            return APIResponse(1, 'user error')

        # 第一种：user_query完成数据的更新
        # user_query = models.User.objects.filter(pk=pk)
        # user_query.update(**kwargs)

        # 第二种：user_obj完成数据的更新
        # user_obj = models.User.objects.filter(pk=pk).first()  # type: models.User
        # user_obj.username = 'new_username'
        # ...
        # user_obj.save()


        request_data = request.data
        user_ser = serializers.UserV2Serializer(instance=user_query, data=request_data)
        if user_ser.is_valid():
            # save的返回值是由update内部自定义的返回值决定
            user_obj = user_ser.save()
            return APIResponse(0, 'ok',
                results=serializers.UserV2Serializer(user_obj).data
            )
        else:
            return APIResponse(1, 'failed', user_ser.errors)

    # 单局部改
    def patch(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if not pk:
            return APIResponse(1, 'pk error')
        user_query = models.User.objects.filter(pk=pk, is_delete=False)
        if not user_query:
            return APIResponse(1, 'user error')
        request_data = request.data
        # 局部数据修改，设置 partial=True
        # 视图类给序列化类传递自定义参数 context=值 值一般用字典
        #       在序列化类的钩子函数中用self.context获取传入的值
        user_ser = serializers.UserV2Serializer(context={'arg': '我是视图的'}, partial=True, instance=user_query, data=request_data)
        if user_ser.is_valid():
            user_obj = user_ser.save()
            return APIResponse(0, 'ok',
                results=serializers.UserV2Serializer(user_obj).data
             )
        else:
            return APIResponse(1, 'failed', user_ser.errors)

    # 单删
    def delete(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if not pk:
            return APIResponse(1, 'pk error')
        user_obj = models.User.objects.filter(pk=pk, is_delete=False).first()
        if not user_obj:
            return APIResponse(1, '删除失败')
        user_obj.is_delete = True
        user_obj.save()
        return APIResponse(0, '删除成功')

转载于:https://www.cnblogs.com/Hades123/p/11461312.html

weixin_30752699
关注
DRF的序列化——Serializers 序列化组件
01-20
为什么要用序列化组件 当我们做前后端分离的项目~~ 我们前后端交互一般都选择JSON数据格式，JSON是一个轻量级的数据交互格式。 那么我们给前端数据的时候都要转成json格式，那就需要对我们从数据库拿到的数据进行...
DRF学习之序列化类的介绍及使用
Xiao20000101的博客
04-21 893
校验前端传入的数据# 1. 数据校验第一层，字段自己校验# 名字最长8位，最短3位name = serializers.CharField(max_length=8, min_length=3) # 字段参数，控制 数据校验# 2. 局部钩子函数--->给某个字段加限制条件# 书名不能以66开头# 书名不能有66# 不合法，抛出异常raise ValidationError('书名不能以66开头')else:# 合法,返回原来的数据"""局部钩子，一个字段只能写一个。
DRF序列化和反序列化——基本使用
zy010101博客
11-26 1674
DRF序列化和反序列化 定义序列化器 DRF中有serializer的类，我们可以从rest_framework进行导入。 from rest_framework import serializers 我们自定义的序列化器必须继承自 rest_framework.serializers.Serializer 现在假如我们有一个模型类，如下： class BookInfo(models.Model): """书籍信息模型""" name = models.CharField(max_leng
测试开发平台--项目的序列化（二）
一夜白头催人泪
10-02 513
1.安装rest_framework pip install rest_framework 2.新增序列化器文件 serializers.py #!/usr/bin/env python # encoding: utf-8 """ @author: 拾壹 @software: PyCharm @file: serializers.py @time: 2021/10/2 20:40 """ from rest_framework import serializers from rest_fram
drf的序列化递归深度问题
study_in的博客
03-29 1738
当序列化某些外键时,返回的只是我们外键所对应的id,这时如果我们想要显示外键对应的详细信息应该如何做到呢? 两种方法: 一种是 外键name = 外键类Serializer(many=True, read_only=True) 另外一种是在 序列化类里面的 class Meta: 下加一句 depth=1 第一种方法适用于我们想要序列化字段中的某一个外键, 第二种方法是要将我们要序列化中所有字...
Django框架中序列化和反序列化的例子
09-18
在Django框架中，序列化和反序列化是前后端分离开发的重要组成部分，它们使得数据能够在不同的数据格式间转换，通常是从Python对象转换为JSON，反之亦然。JSON（JavaScript Object Notation）是一种轻量级的数据交换...
Django框架序列化与反序列化操作详解
01-20
使用`serialize()`函数进行序列化，而`deserialize()`函数（在DRF中是`to_representation()`和`to_internal_value()`方法）用于反序列化。 例如，当一个POST请求包含图书数据时，`BookInfoSerializer`会将这些数据...
django序列化serializers过程解析
01-20
这篇文章主要介绍了django序列化serializers过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 DRF的核心 就是 前后端分离的核心 前后端分离开发的核心：...
DRF笔记（三）：序列化与反序列化
panzhixiang
04-01 1759
笔记中提到的代码repo：https://github.com/yexia553/drf 序列化与反序列化 简单地说，序列化就是从数据库中取出数据处理后传给API（请求方）；反序列化就是从API（请求方）获取数据处理后存到数据库中。 Serializer类 在DRF框架中，序列化与反序列化是通过Serializer来实现的，常用的有serializer.ModelSerializer和serializer.Serializer这两个类，前者是后者的子类。 下面分别说一下这两个类。 1.ModelSerial
DRF中的序列化器详细应用
weixin_30538029的博客
12-07 233
视图的功能：说白了就是接收前端请求，进行数据处理 （这里的处理包括：如果前端是GET请求，则构造查询集，将结果返回，这个过程为序列化；如果前端是POST请求，假如要对数据库进行改动，则需要拿到前端发来的数据，进行校验，将数据写入数据库，这个过程称为反序列化） 最原始的视图可以实现这样的逻辑处理，但是针对不同的请求，需要在类视图中定义多个方法实现各自的处理，这样是可以解决问题，但是存在一个缺陷，...
Day21包和模块
weixin_50199478的博客
10-30 591
一个.py文件就是一个模块。模块是含有一系列数据、函数、类等的程序。包是将模块以文件夹的组织形式进行分组管理的方法，以便更好地组织和管理相关模块。包是一个包含一个特殊的__init__.py文件的目录。
01_IAR新建CC2530工程
nanxl1的博客
11-02 727
由于很多Zigbee商家提供的教程未有从零建立CC2530工程的讲解，可能会导致后面的开发中出现一些琐碎的问题。本文将以**LED流水灯**为例，从0到1用**IAR**建立CC2530工程。
cleanfid库的fid使用，及其使用CLIP模型clip_vit_b_32计算FID
百年孤独百年的博客
11-02 688
这篇博客详细介绍了如何使用 cleanfid 库计算 Fréchet Inception Distance (FID)，特别是利用 CLIP 模型 clip_vit_b_32 计算 FID 分数来评估生成图像的质量。内容涵盖了 FID 的概念和原理、cleanfid 库的安装与配置、从缓存中加载与手动加载模型的方法，以及解决可能遇到的依赖问题。通过这篇教程，可以掌握使用 cleanfid 库计算fid的完整流程，并能够解决服务器环境中遇到的联网与模型下载问题。
Golang--DOS命令、变量、基本数据类型、标识符
最新发布
cookies_s_的博客
11-02 605
DOS命令，语法基础，变量，数据类型，标识符
Backtrader 数据篇 02
进击的小学生
10-30 992
重新自定义数据读取函数，自定义的方式就是继承数据加载类 GenericCSVData、PandasData 再构建一个新的类，然后在新的类里统一设置参数。如果传递负值（例如：-1），则表示 CSV 数据中不存在该字段自定义的函数，不会修改 Backtrader 底层的数据表格内 lines 的排列规则。
变量与数据类型：从整数到字符串
redrose2100的博客
10-30 69
变量是用于存储数据的命名空间。在Python中，定义变量非常简单，你只需要将一个值赋给变量名即可。# 定义变量x = 10变量名只能包含字母、数字和下划线（_）。变量名不能以数字开头。变量名不能为Python的关键字（如ifelsewhile等）。# 合法的变量名age = 25# 非法的变量名# 1st_num = 10 # 不能以数字开头# if = "condition" # 不能使用Python关键字。
196.245.124.255.236.194.0.0.0.0.0.0.0.0.9 用python截取最后一个点后面的数据
qq_44534541的博客
10-30 137
这个方法从字符串的右边开始分割，并且可以指定分割的最大次数。在Python中，如果你想要截取字符串中最后一个点（，因为它是最后一个点后面的数据。这段代码会处理没有点的情况（）和点的后面不是数字的情况（）后面的数据，你可以使用。
drf序列化器解析choices
10-23
2. 然后，在DRF序列化器中，映射这个字段到`ChoiceField`： ```python from rest_framework import serializers from .models import MyModel class MyModelSerializer(serializers.ModelSerializer): class Meta:...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值