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

本文实例讲述了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程序设计有所帮助。

(0)

相关推荐

  • Django框架中序列化和反序列化的例子

    1.序列化 DRF的核心 就是 前后端分离的核心 前后端分离开发的核心: 将模型转换为json 称之为 序列化 将json转换为模型 称之为 反序列化 1.序列化器的字段 Serializer 序列化器 为了得到模型里的字段,序列化器中的字段应与模型类中的字段名一致 ''' serializers.py ''' class BookInfoSerializer(serializers.Serializer): # read_only=True 只能读 不能修改 id = serializers.

  • Django REST Framework序列化外键获取外键的值方法

    需求:序列化外键,获取外键的除id之外的值 使用Django REST Framework虽然开发接口快速,但是如果想要获取到除外键id值之外的外键信息,直接继承serializers.ModelSerializer类,然后在fields中指定返回的字段是获取不到外键的其他值的,比如我现在需要外键的name属性值,下面就给大家介绍两种方法通过序列化外键来获取我们想要的外键的值. 这里有两个Model:问卷(Questionnaire):问题(Question).一张问卷中包含多个问题,问题通过外

  • django自带serializers序列化返回指定字段的方法

    django orm 有个defer方法,指定模型排除的字段. 如下返回的Queryset, 排除'username', 'id'. users=models.UserInfo.objects.defer('username','id') 或users=models.UserInfo.objects.filter(...).defer('username','id') 再如下,使用django自带serializers进行序列,发现序列化的数据仍存在'username', 'id'这两个字段.

  • 详解django的serializer序列化model几种方法

    序列化是将对象状态转换为可保持或传输的格式的过程.与序列化相对的是反序列化,它将流转换为对象.这两个过程结合起来,可以轻松地存储和传输数据 方法一:通过继承View类,重写get方法,获取商品的前是前十条数据,通过serialize序列化数据,返回数据响应. from django.views.generic import View from goods.models import Goods from django.core import serializers from django.htt

  • Django model序列化为json的方法示例

    本文环境 Python 3.6.5 Django 2.0.4 fix(2018.5.19):最近得知Django 的model基类需要声明为abstract,故在原来的代码加入abstract声明,以免误导 在Django中,关于如何将model类序列化为json,一般的话有两a器 将model类转为字典,再使用json库的dumps方法转为json 第一种方法就不多讲了,直接去看官方文档就好啦 一般来说,官方提供的方法应该都是比较好用和稳定的,然而,使用官方的序列化器却问题不少: 格式丑陋,格

  • Django模型序列化返回自然主键值示例代码

    场景 在设计表结构时,难免需要建立一些外键关联.例如这样两个模型: from django.db import models class Person(models.Model): username = models.CharField(max_length=100) birthdate = models.DateField() class Book(models.Model): name = models.CharField(max_length=100) author = models.Fo

  • Python的Django REST框架中的序列化及请求和返回

    序列化Serialization 1. 设置一个新的环境 在我们开始之前, 我们首先使用virtualenv要创建一个新的虚拟环境,以使我们的配置和我们的其他项目配置彻底分开. $mkdir ~/env $virtualenv ~/env/tutorial $source ~/env/tutorial/bin/avtivate 现在我们处在一个虚拟的环境中,开始安装我们的依赖包 $pip install django $pip install djangorestframework $pip i

  • django Serializer序列化使用方法详解

    Serializer序列化器 定义Serializer 1. 定义方法 Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer. 例如,我们已有了一个数据库模型类BookInfo class BookInfo(models.Model): btitle = models.CharField(max_length=20, verbose_name='名称') bpub_date = mode

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

    本文实例讲述了Django框架序列化与反序列化操作.分享给大家供大家参考,具体如下: Serializer类 1.定义: Django REST framework中的Serializer使用类来定义,须继承rest_framework.serializers.Serializer. 例: class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serialize

  • Java 序列化和反序列化实例详解

    Java 序列化和反序列化实例详解 在分布式应用中,对象只有经过序列化才能在各个分布式组件之间传输,这就涉及到两个方面的技术-发送者将对象序列化,接受者将对象反序列化,下面就是一个很好的例子! 1.实体-Employee import java.io.Serializable; public class Employee implements Serializable{ /** * */ private static final long serialVersionUID = 1L; publi

  • Python Django框架中表单的用法详解

    目录 文件上传 Form表单 表单字段 字段参数 widget参数 表单的验证 表单模型文件上传例子 模型表单 AJAX Django保证表单的正确显示需要添加CSRF(防止网站跨站请求伪造而默认开启的一种保护方式),在<form></form>之间添加 {% csrf_token %} 在项目settings.py中 * ‘django.middleware.csrf.CsrfViewMiddleware’, * 引入,如果没有此中间件,手动添加. 文件上传 首次打开路径是GET

  • Django框架models使用group by详解

    Django框架models使用group by详解: 首先,看下列代码: UserData.objects.filter(hubid=sensorid,time__range=(time2,time1)).values('hour').annotate(sum_out=Sum('outdoor'), sum_in=Sum('indoor'), sum_eat=Sum('kitchen'), sum_wash=Sum('toilet')).order_by('hour') 上述代码相当于sql语

  • 深入理解C#序列化与反序列化的详解

    在我们深入探讨C#序列化和反序列化之前我们先要明白什么是序列化,它又称串行化,是.NET运行时环境用来支持用户定义类型的流化的机制.序列化就是把一个对象保存到一个文件或数据库字段中去,反序列化就是在适当的时候把这个文件再转化成原来的对象使用.其目的是以某种存储形成使自定义对象持久化,或者将这种对象从一个地方传输到另一个地方..NET框架提供了两种串行化的方式:1.是使用BinaryFormatter进行串行化:2.使用SoapFormatter进行串行化:3.使用XmlSerializer进行串

  • django框架模板语言使用方法详解

    本文实例讲述了django框架模板语言使用方法.分享给大家供大家参考,具体如下: 模板功能 作用:生成html界面内容,模版致力于界面如何显示,而不是程序逻辑.模板不仅仅是一个html文件,还包括了页面中的模板语言. 静态内容:css,js,html. 动态内容:通过模板语言,动态生成一些网页内容 模板使用: 在视图函数中,使用模板产生html内容返回给客户端 方式一: 加载模板文件(loader.get_template) 模板渲染,产生标准的html页面内容(render) 通过HttpRe

  • django框架auth模块用法实例详解

    本文实例讲述了django框架auth模块用法.分享给大家供大家参考,具体如下: auth模块的导入 from django.contrib import auth django中的auth模块有其自己完整的一套方法: 登录验证.注销.用户的创建.比较用户输入的密码是否和数据库的一致.用户信息的修改 1 我们来生成db.sqlite3 (migrations,migrate),打开,从中我们可以找到表 auth_user ,整篇都是围绕这个表进行的 2  这个表里面暂时是空的,我们可以创建 ,例

  • flask框架自定义url转换器操作详解

    本文实例讲述了flask框架自定义url转换器.分享给大家供大家参考,具体如下: 什么是url转换器 可以指定url的规制,对url做一定的限制. 自带的url转换器 可以参考我的上一篇博客: flask–url与重定向详解 自定义url转换器 首先我们提一个需求,根据需求来写代码,现在我们假设一个url需要满足电话号码的格式才能访问我们的函数视图,例如这样的url: 127.0.0.1:5000/user/<电话号码>/. # 首先导入BaseConverter from werkzeug.

  • Go语言中序列化与反序列化示例详解

    目录 前言 序列化 array.slice.map.struct对象 序列化的接口 反序列化 slice.map.struct反序列化 总结 前言 Go语言的序列化与反序列化在工作中十分常用,在Go语言中提供了相关的解析方法去解析JSON,操作也比较简单 序列化 // 数据序列化 func Serialize(v interface{})([]byte, error) // fix参数用于添加前缀 //idt参数用于指定你想要缩进的方式 func serialization (v interfa

  • Java IO流对象的序列化和反序列化实例详解

    Java-IO流 对象的序列化和反序列化 序列化的基本操作 1.对象序列化,就是将Object转换成byte序列,反之叫对象的反序列化. 2.序列化流(ObjectOutputStream),writeObject 方法用于将对象写入输出流中: 反序列化流(ObjectInputStream),readObject 方法用于从输入流中读取对象. 3.序列化接口(Serializeable) 对象必须实现序列化接口,才能进行序列化,否则会出现异常.这个接口没有任何方法,只是一个标准. packag

随机推荐