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

更新時間：2019年08月06日 10:00:56 作者：不睡覺假扮古爾丹

今天小編就為大家分享一篇Django框架中序列化和反序列化的例子，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧

1.序列化

DRF的核心就是前后端分離的核心

前后端分離開發(fā)的核心：

將模型轉(zhuǎn)換為json 稱之為序列化

將json轉(zhuǎn)換為模型稱之為反序列化

1.序列化器的字段

Serializer 序列化器

為了得到模型里的字段，序列化器中的字段應(yīng)與模型類中的字段名一致

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  # read_only=True 只能讀 不能修改
  id = serializers.IntegerField(read_only=True,label='id')
  name = serializers.CharField(max_length=20,label='書籍名')
  pub_date = serializers.DataField(label='發(fā)布日期')
  readcount = serializers.IntegerField()
  is_delete = serializers.BooleanField()
  image = serializers.ImageField()

2.序列化

創(chuàng)建序列器

序列化器的第一個參數(shù)：instance 用于序列化操作

序列化器的第二個參數(shù)：data 用于反序列化操作

除了instance和data參數(shù)外，在構(gòu)造Serializer對象時，還可通過context參數(shù)額外添加數(shù)據(jù)，如

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

通過context參數(shù)附加的數(shù)據(jù)，可以通過Serializer對象的context屬性獲取。

 ''' views.py '''

 book = BookInfo.objects.get(id=2)
 
 s = BookInfoSerializers(instance=book)

 # 我們是通過 序列化器的data屬性來獲取 模型轉(zhuǎn)換為字典的數(shù)據(jù)
 s.data


 # 傳遞多個數(shù)據(jù)
 # 應(yīng)用： 查詢所有書籍列表

 books = BookInfo.objects.all()
 # 創(chuàng)建序列化器，將所有書籍信息傳遞給序列化器
 # books = [BookInfo,BookInfo,...] 對象列表
 s = BookInfoSerializers(books,many=True)
 
 person = PeopleInfo.objects.get(id=6)

 # 序列化器初始化
 s = PeopleInfoSerializer(instance=person)

3.關(guān)聯(lián)序列化器的操作

對于關(guān)聯(lián)字段，可以采用以下幾種方式：

1） PrimaryKeyRelatedField

2） StringRelatedField

3）使用關(guān)聯(lián)對象的序列化器

#########關(guān)聯(lián)序列化器##########################

 class PeopleInfoSerializer(serializers.Serializer):
  """英雄數(shù)據(jù)序列化器"""
  GENDER_CHOICES = (
   (0, 'male'),
   (1, 'female')
  )
  id = serializers.IntegerField(label='ID', read_only=True)
  name = serializers.CharField(label='名字', max_length=20)
  gender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性別', required=False)
  description = serializers.CharField(label='描述信息', max_length=200, required=False, allow_null=True)


  ''' PrimaryKeyRelatedField '''
  # 設(shè)置關(guān)聯(lián)外鍵的時候，要將 read_only=True
  # 包含read_only=True參數(shù)時，該字段將不能用作反序列化使用
  # book = serializers.PrimaryKeyRelatedField(read_only=True,label='外鍵')
  # 或者
  # 包含queryset參數(shù)時，將被用作反序列化時參數(shù)校驗使用
  # queryset 將關(guān)聯(lián)模型的所有數(shù)據(jù)傳遞給這個屬性就可以
  book = serializers.PrimaryKeyRelatedField(label='外鍵',queryset=BookInfo.objects.all())

  '''StringRelatedField'''
  # 現(xiàn)在通過 PrimaryKeyRelatedField得到的是一個 外鍵的一個值 2
  # 接下來通過 一個設(shè)置 來獲取 書籍的名字

  # StringRelatedField 可以獲取關(guān)聯(lián)模型中的 __str_ 里的字符串
  book = serializers.StringRelatedField()

  ''' 使用關(guān)聯(lián)對象的序列化器 拿到所有數(shù)據(jù) '''
  book = BookInfoSerializer()

4.關(guān)聯(lián)查詢

關(guān)聯(lián)模型類名小寫_set 作為字段名

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  id = serializers.IntegerField(read_only=True,label='id')
  name = serializers.CharFIeld(max_length=20,label='書籍名')
  pub_date = serializers.DataField(label='發(fā)布日期')
  readcount = serializers.IntegerField()
  is_delete = serializers.BooleanField()
  iamge = serializers.ImageField()

  
  # 書籍和人物的關(guān)系是 1：n ===> many=True
  peopleinfo_set = serializers.PrimaryKeyRelatedField(read_only=True,many=True)

  def __str__(self):
   return self.name

2.反序列化

反序列化分為兩個：

數(shù)據(jù)校驗

數(shù)據(jù)入庫

2.1 數(shù)據(jù)校驗

使用序列化器進行反序列化時，需要對數(shù)據(jù)進行驗證后，才能獲取驗證成功的數(shù)據(jù)或保存成模型類對象。

在獲取反序列化的數(shù)據(jù)前，必須調(diào)用is_valid()方法進行驗證，驗證成功返回True，否則返回False。

驗證失敗，可以通過序列化器對象的errors屬性獲取錯誤信息，返回字典，包含了字段和字段的錯誤。

驗證成功，可以通過序列化器對象的validated_data屬性獲取數(shù)據(jù)。

在定義序列化器時，指明每個字段的序列化類型和選項參數(shù)，本身就是一種驗證行為

1. 數(shù)據(jù)校驗的第一種方式

在定義序列化器字段的時候，規(guī)定是什么類型就要提交符合規(guī)則的數(shù)據(jù)

例如：DateField 就需要傳入符合日期規(guī)則的數(shù)據(jù)

 ##############將JSON轉(zhuǎn)換為模型 反序列化#############

  ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  id = serializers.IntegerField(read_only=True,label='id')
  name = serializers.CharFIeld(max_length=20,label='書籍名')
  pub_date = serializers.DataField(label='發(fā)布日期')
  
  peopleinfo_set = serializers.PrimaryKeyRelatedField(read_only=True,many=True)

  def __str__(self):
   return self.name

 ''' views.py '''

 dict = {
  'name':'itcast',
  'pub_date':'123' # Flase
  # 'pub_date':'2010-1-1' # True
 }

 # 1.創(chuàng)建序列器
 # 序列化器的第一個參數(shù)：instance 用于序列化操作
 # 序列化器的第二個參數(shù)：data 用于反序列化操作
 serializer = BookInfoSerializer(data=dict)

 # 2.需要調(diào)用序列化器的 is_valid 方法 valid驗證 返回True False
 # 如果數(shù)據(jù)可用 返回True
 serializer.is_valid()

 # raise_exception=True 可以設(shè)置為True 來拋出異常
 serializer.is_valid(raise_exception=True)

2.數(shù)據(jù)校驗的第二種方式

字段的選項

required : 進行反序列化的時候，必須傳這個字段

min_length,max_length 作用于字符串

min_value,max_value 作用于Int整型

default 不傳入數(shù)據(jù) 設(shè)置默認值

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  id = serializers.IntegerField(read_only=True,label='id')
  name = serializers.CharFIeld(min_length=5,max_length=20,label='書籍名',)
  pub_date = serializers.DataField(label='發(fā)布日期',required=True)


  def __str__(self):
   return self.name

 ''' views.py '''
 dict = {
  'name':'itcast',
  'pub_date':'123' # 若去掉pub_date 則報錯
 }

3.數(shù)據(jù)校驗的第三種方式

對單個字段的數(shù)據(jù)進行驗證

語法形式為：在序列化器中實現(xiàn)方法 def validate_字段名()

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  id = serializers.IntegerField(read_only=True,label='id')
  name = serializers.CharFIeld(min_length=5,max_length=20,label='書籍名',)
  pub_date = serializers.DataField(label='發(fā)布日期',required=True)
  readcount = serializers.IntegerField(default=0,required=False)

  def __str__(self):
   return self.name

  def validate_readcount(self,value):
   # value 就是字段傳遞過來的數(shù)據(jù)
   if value < 0:
    raise serializers.ValidationError('閱讀量不能為負數(shù)')

   # 需要將value返回回去
   return value

 ''' views.py '''
 dict = {
  'name':'itcast',
  'readcount':-20, # 報異常
 }

4.數(shù)據(jù)校驗的第四種方式

對多個字段的數(shù)據(jù)進行驗證時

語法形式為：在序列化器中實現(xiàn)方法 def validate(self,attrs)

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  id = serializers.IntegerField(read_only=True,label='id')
  name = serializers.CharFIeld(min_length=5,max_length=20,label='書籍名',)
  pub_date = serializers.DataField(label='發(fā)布日期',required=True)
  readcount = serializers.IntegerField(default=0,required=False)
  commentcount = serializers.IntegerField(default=0,required=False)


  def __str__(self):
   return self.name

  # 對多個字段進行驗證
  # def validate(self,attrs):
  def validate(self,data):
   # attrs --> 其實就是data
   readcount = data.get('readcount')
   commentcount = data['commentcount']

   if readcount < commentcount:
    raise serializers.ValidationError('評論量不能大于閱讀量')

   # 要將數(shù)據(jù)返回
   return data


 ''' views.py '''
 # 自定義需求：評論量不能大于閱讀量
 dict = {
  'name':'itcast',
  'readcount':20, 
  'commentcount':100
 }

5.數(shù)據(jù)校驗的第五種方式

自定義驗證方法

同時給字段添加自定義驗證方法

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  # 自定義驗證方法
  def custom_validate(self):
   if self == 'admin':
   raise serializers.ValidationError('我就是來搗亂的')

  id = serializers.IntegerField(read_only=True,label='id')
  
  # validators=[] 是給字段 添加自定義驗證方法
  name = serializers.CharFIeld(min_length=5,max_length=20,label='書籍名',validators=[custom_validate])
  

  def __str__(self):
   return self.name


 ''' views.py '''
 # 規(guī)定：評論量不能大于閱讀量
 dict = {
  'name':'itcast',
  'readcount':20, 
  'commentcount':100
 }

2.2 數(shù)據(jù)入庫

6.數(shù)據(jù)保存 save方法

繼承自Serializer的序列化我們在調(diào)用save方法的時候，需要手動實現(xiàn)create方法，

調(diào)用save方法之前，必須調(diào)用 is_valid方法，

即要想保存數(shù)據(jù)，必須保證數(shù)據(jù)是經(jīng)過校驗的。

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  def create(self,validated_data):

   # dict --> data --> attrs --> validated_data
   # validated_data 此處其實就是views.py中的dict
   # validated_data 已經(jīng)被驗證過的數(shù)據(jù)

   # * 對列表進行解包 *list
   # ** 對字典進行解包 **dict
   # 此處解包 將dict中的值 賦值給對象中的對應(yīng)字段
   book = BookInfo.objects.create(**validated_data)

   # create 需要將創(chuàng)建的對象返回
   return book 



  ''' views.py '''

 # 規(guī)定：評論量不能大于閱讀量
 dict = {
  'name':'itcast',
  'readcount':20, 
  'commentcount':100
 } 



 serializer = BookInfoSerializer(data=dict)
 serializer.is_valid(raise_exception=True)

 # 3. 保存需要調(diào)用序列化器的save方法
 # 繼承自Serializer的序列化 我們在調(diào)用save方法的時候，需要手動實現(xiàn)create方法
 serializer.save()

7.序列化器中傳入兩個參數(shù)，即數(shù)據(jù)的更新操作

如果我們在序列化器中既傳入了對象，又傳入了數(shù)據(jù)

系統(tǒng)會認為我們在更新數(shù)據(jù)

繼承自Serializer的類，要更新數(shù)據(jù)的時候，需要手動實現(xiàn)update方法

 ''' serializers.py '''

 class BookInfoSerializer(serializers.Serializer):

  def update(self,instance,validated_data):
   # instance : 就是我們在更新數(shù)據(jù)時，傳入序列化器的對象
   # validated_data ： 驗證之后的數(shù)據(jù)

   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.commentcount = validated_data.get('commentcount',instance.commentcount)

   instance.save()

   # update()方法需要我們手動返回對象
   return instance
   


 '''views.py '''

 # 1.獲取對象
 book = BookInfo.objects.get(id=2)
 # 2.保存數(shù)據(jù)
 data = {
  'name':'lalala',
  'pub_date':'2018-1-1',
  'readcount':1000,
  'commentcount':10
 } 

 # 3.創(chuàng)建序列化器
 s = BookInfoSerializer(instance=book,data=data)
 # 4.驗證數(shù)據(jù)
 s.is_valid(raise_exception=True)
 # 5.保存數(shù)據(jù)
 s.save()

3.ModelSerializer

如果我們想要使用序列化器對應(yīng)的是Django的模型類，DRF為我們提供了ModelSerializer模型類序列化器來幫助我們快速創(chuàng)建一個Serializer類。

ModelSerializer與常規(guī)的Serializer相同，但提供了：

基于模型類自動生成一系列字段

包含默認的create()和update()的實現(xiàn)

 ''' serializers.py '''

 class BookSerializer(serializers.ModelSerializer):
  
  # 如何設(shè)置 通過class Meta
  class Meta:
   model = BookInfo # 設(shè)置關(guān)聯(lián)模型  model就是關(guān)聯(lián)模型
   # fields = '__all__' # fields設(shè)置字段 __all__表示所有字段
   # fields = ['id','name','pub_date'] # fields設(shè)置字段 []列表顯示來設(shè)置
   exclude = ['image'] # exclude 排除列表中的字段，剩余的字段都顯示

   read_only_fields = ('id','readcount','commentcount')

   # 我們可以對自動生成的字段 進行額外的設(shè)置
   extra_kwargs = {
    # 字段名：{選項：值}
    'pub_date':{'required':True},
    'readcount':{
     'max_value':10000,
     'min_value':0
    }
   }

 '''views.py'''

 #########ModelSerializer##############
 data = {
   'name':'abc',
   'pub_date':'2018-1-1',
   'readcount':1000,
   'commentcount':10
  } 

 s = BookSerializer(data=data)
 s.is_valid(raise_exception=True)
 s.save()

以上這篇Django框架中序列化和反序列化的例子就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: