Django框架序列化与反序列化操作详解


Posted in Python onNovember 01, 2019

本文实例讲述了Django框架序列化与反序列化操作。分享给大家供大家参考,具体如下:

Serializer类

1.定义:

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

例:

class BookInfoSerializer(serializers.Serializer):
 """图书数据序列化器"""
 id = serializers.IntegerField(label='ID', read_only=True)
 name = serializers.CharField(label='名称', max_length=20)
 pub_date = serializers.DateField(label='发布日期', required=False)
 readcount = serializers.IntegerField(label='阅读量', required=False)
 commentcount = 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)
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页面时,显示的字段帮助提示信息

3.Serialize对象:

构造方法:

Serializer(instance, data, **kwarg)

(1)用于序列化时,将模型类对象传入instance参数
(2)用于反序列化时,将要被反序列化的数据传入data参数
(3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外 添加数据。

例:

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

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

序列化

1.基本使用:

(1)查询对象:
例:

from book.models import BookInfo
book = BookInfo.objects.get(id=4) # 单个对象
books = BookInfo.objects.all() # 多个对象

(2)构造序列化对象:

from book.serializers import BookInfoSerializer
serializer = BookInfoSerializer(book) # 单个对象
serializers = BookInfoSerializer(books,many=True) # 多个对象需要添加many参数

(3)获取序列化数据:

serializer.data

2.外键嵌套使用:

(1)PrimaryKeyRelatedField:

此字段将被序列化为关联对象的主键。

book = serializers.PrimaryKeyRelatedField(label='图书',read_only=True)

或者

book=serializers.PrimaryKeyRelatedField(label='图书',queryset=BookInfo.objects.all())

指明字段时需要包含read_only=True或者queryset参数:

  • 包含read_only=True参数时,该字段将不能用作反序列化使用
  • 包含queryset参数时,将被用作反序列化时参数校验使用

结果:

{'id': 10, 'book': 3, 'description': '独孤九剑', 'gender': 1, 'name': '令狐冲'}

(2)StringRelateField:

此字段将被序列化为关联对象的字符串表示方式(即__str__方法的返回值)

book = serializers.StringRelatedField(label='图书')

结果:

{'description': '独孤九剑', 'name': '令狐冲', 'gender': 1, 'book': '笑傲江湖', 'id': 10}

(3)使用关联对象的序列化器:

book = BookInfoSerializer()

结果:

{'book': OrderedDict([('id', 3), ('name', '笑傲江湖'), ('pub_date', '1995-12-24'),  ('readcount', 28), ('commentcount',  ('image', None)]), 'gender': 1, 'name': '令狐冲',  'description': '独孤九剑', 'id': 10}

反序列化

1.验证:

(1)字段验证:

from book.serializers import BookInfoSerializer
data = {'pub_date':'2010-1-1','name':'python高级'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid() # 验证成功返回True,失败返回False

is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。

(2)字段选项:

可在序列化器中设置字段的属性,来限制数据,对数据进行验证。

例:

属性 描述
max_length 字符串的最大长度(char)
min_length 字符串的最小长度
max_value 最大值(int)
min_value 最小值
required 表明该字段在反序列化时必须输入,默认True
default 默认值

(3)单个字段验证:

当我们的类型和选项都满足条件之后,我们需要对单个字段的值进行校验,我们在序 列化器中实现方法以 validate_ 开头以字段名结尾的函数

格式:

def validate_字段名(self,value):
...
return value

例:

def validate_readcount(self,value):
  if value < 0:
   raise serializers.ValidationError('阅读量不能为负数')
  # 验证完成之后,需要将 value返回
  return value

(4)多的字段验证:

对多个字段进行校验的时候,我们在序列器中实现

格式:

def validate(self,attrs)
...
  return attrs

例:

def validate(self, data):
  # attrs = data
  # params --> 序列化器data --> attrs
  """
  data = {
   'name':'python',
   'pub_date':'2000-1-1',
   'readcount':10,
   'commentcount':100
  }
  """
  readcount = data.get('readcount')
  # if readcount<0:
  #  raise serializers.ValidationError()
  commentcount = data.get('commentcount')
  if readcount<commentcount:
   raise serializers.ValidationError('评论量不能大于阅读量')
  #校验完成之后,必须要将数据返回回去
  return data

(5)自定义验证:

在字段中添加validators选项参数,也可以补充验证行为

例:

name=serializers.CharField(max_length=20,validators=[custom_validate)]
def custom_validate(self):
if self == 'admin':
raise serializers.ValidationError('admin不可用')
 raise serializers.ValidationError('我就是来捣乱的')

2.保存:

如果在验证成功后,想要基于validated_data完成数据对象的创建,可以通过实现create()和update()两个方法来实现。

(1)create方法:

def create(self, validated_data):
  # validated_data 验证之后的数据
  # params(前端提交的数据) --> data(序列器接受的数据) --> attrs(多个字段 校验) --> validated_data(校验之后)
  # 如果前段提交的数据 经过序列化器的验证之后完全满足需求,则
  # validated_data = params
  """
   validated_data:
  data = {
   'name':'python',
   'pub_date':'2000-1-1',
   'readcount':10000,
   'commentcount':100
  }
  """
  # book = BookInfo()
  # book.save()
  book = BookInfo.objects.create(**validated_data)
  # 需要将创建的对象返回
  return book
( return BookInfo.objects.create(**validated_data)也可)

(2)update方法:

def update(self, instance, validated_data):
"""更新,instance为要更新的对象实例"""
 instance.name = validated_data.get('name', instance.name)
 instance.pub_date = validated_data.get('pub_date', instance.pub_date)
 instance.readcount = validated_data.get('readcount', instance.readcount)
...
instance.save()
 return instance

实现了上述两个方法后,在反序列化数据的时候,就可以通过save()方法返回一个数据对象实例了

例:

book = serializer.save()

如果创建序列化器对象的时候,没有传递instance实例,则调用save()方法的时候,create()被调用,相反,如果传递了instance实例,则调用save()方法的时候,update()被调用。

两点说明:

1) 在对序列化器进行save()保存时,可以额外传递数据,这些数据可以在create()和update()中的validated_data参数获取到

serializer.save(owner=request.user)

2)默认序列化器必须传递所有required的字段,否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新

serializer = BookInfoSerializer(instance=book, data={'pub_date': '2999-1-1'}, partial=True)

模型类序列化器BookModelSerializer

1.定义:

例:

创建一个BookInfoSerializer

class BookInfoSerializer(serializers.ModelSerializer):

 class Meta:
  model = BookInfo
  fields = '__all__'

参数 描述
model 指明参照哪个模型类
fields 指明为模型类的哪些字段生成

2.指定字段:

(1)全部字段:

fields = '__all__'

(2)排除字段:

exclude = ['xxx', 'xxxx'...]

(3)指定字段:

fields = ['xxx', 'xxxx'...]

(4)只读字段:

read_only_fields = ['xxx', 'xxxx'...]

3.添加额外参数:

可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数

例:

class BookInfoSerializer(serializers.ModelSerializer):
class Meta:
model = BookInfo
 fields = ('id','name', 'readcount', 'commentcount')
 read_only_fields = ('id', 'readcount', 'commentcount')
 extra_kwargs = {
  'readcount': {'min_value': 0, 'required': True},
  'commentcount': {'max_value': 0, 'required': True},
 }

希望本文所述对大家基于Django框架的Python程序设计有所帮助。

Python 相关文章推荐
windows下安装python paramiko模块的代码
Feb 10 Python
用Python操作字符串之rindex()方法的使用
May 19 Python
Python计算三维矢量幅度的方法
Jun 15 Python
Python制作爬虫采集小说
Oct 25 Python
在Python程序和Flask框架中使用SQLAlchemy的教程
Jun 06 Python
详解Python核心对象类型字符串
Feb 11 Python
python networkx 包绘制复杂网络关系图的实现
Jul 10 Python
Django模板Templates使用方法详解
Jul 19 Python
Python List列表对象内置方法实例详解
Oct 22 Python
Ubuntu16.04安装python3.6.5步骤详解
Jan 10 Python
Python自动登录QQ的实现示例
Aug 28 Python
Python常遇到的错误和异常
Nov 02 Python
redis数据库及与python交互用法简单示例
Nov 01 #Python
python验证码图片处理(二值化)
Nov 01 #Python
使用matlab或python将txt文件转为excel表格
Nov 01 #Python
python 图片二值化处理(处理后为纯黑白的图片)
Nov 01 #Python
Python网络编程之使用TCP方式传输文件操作示例
Nov 01 #Python
wxpython布局的实现方法
Nov 01 #Python
Python高级编程之消息队列(Queue)与进程池(Pool)实例详解
Nov 01 #Python
You might like
利用Fix Rss Feeds插件修复WordPress的Feed显示错误
2015/12/19 PHP
PHP连接MSSQL方法汇总
2016/02/05 PHP
php正则去除网页中所有的html,js,css,注释的实现方法
2016/11/03 PHP
PHP实现的pdo连接数据库并插入数据功能简单示例
2019/03/30 PHP
JS维吉尼亚密码算法实现代码
2010/11/09 Javascript
JS来动态的修改url实现对url的增删查改
2014/09/05 Javascript
JS实现三级折叠菜单特效,其它级可自动收缩
2015/08/06 Javascript
jquery实现向下滑出的二级导航下滑菜单效果
2015/08/25 Javascript
JavaScript 闭包详细介绍
2016/09/28 Javascript
Node中使用ES6语法的基础教程
2018/01/05 Javascript
[原创]js实现保存文本框内容为本地文件兼容IE,chrome,火狐浏览器
2018/02/14 Javascript
实例讲解Vue.js中router传参
2018/04/22 Javascript
cocos2dx+lua实现橡皮擦功能
2018/12/20 Javascript
JavaScript格式化json和xml的方法示例
2019/01/22 Javascript
[03:40]DOTA2亚洲邀请赛小组赛第二日 赛事回顾
2015/01/31 DOTA
详解python中init方法和随机数方法
2019/03/13 Python
Win10 安装PyCharm2019.1.1(图文教程)
2019/09/29 Python
python获取网络图片方法及整理过程详解
2019/12/20 Python
Python制作简易版小工具之计算天数的实现思路
2020/02/13 Python
pycharm2020.2 配置使用的方法详解
2020/09/16 Python
解决pytorch下出现multi-target not supported at的一种可能原因
2021/02/06 Python
京东全球售:直邮香港,澳门,台湾,美国,澳大利亚等地区
2017/09/24 全球购物
Kathmandu澳洲户外商店:新西兰户外运动品牌
2017/11/12 全球购物
如何使用PHP session
2015/04/21 面试题
既然说Ruby中一切都是对象,那么Ruby中类也是对象吗
2013/01/26 面试题
励志演讲稿大全
2014/08/21 职场文书
招标授权委托书样本
2014/09/23 职场文书
大学感恩节活动策划方案
2014/10/11 职场文书
2014年军人思想汇报范文
2014/10/12 职场文书
工作疏忽检讨书500字
2014/10/26 职场文书
国情备忘录观后感
2015/06/04 职场文书
湘江北去观后感
2015/06/15 职场文书
副校长2015年教育教学工作总结
2015/07/27 职场文书
祝福语集锦:朋友新店开业祝福语
2019/12/10 职场文书
尝试使用Python爬取城市租房信息
2022/04/12 Python
Java的Object类的九种方法
2022/04/13 Java/Android