Django框架中序列化和反序列化

阿新 • • 發佈：2020-10-28

1. 序列化
2. 反序列化
- 2.1 資料校驗
- 2.2 資料入庫
  - 2.2.1 資料儲存 save 方法
  - 2.2.2 序列化器中傳入兩個引數，即資料的更新操作
3. ModelSerializer

1. 序列化

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

前後端分離開發的核心：
將模型轉換為json 稱之為序列化
將json轉換成模型稱之為反序列化

1.1 序列化器的欄位

Serializer 序列化器
為了得到模型裡的欄位，序列化器中的欄位應與模型類中的欄位名一致

    ''' 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='釋出日期')
        readcount = serializers.IntegerField()
        is_delete = serializers.BooleanField()
        image = serializers.ImageField()

1.2 序列化

建立序列器

序列化器的第一個引數：instance 用於序列化操作

序列化器的第二個引數：data 用於反序列化操作

除了instance和data引數外，在構造Serializer物件時，還可通過context引數額外新增資料，如

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

通過context引數附加的資料，可以通過Serializer物件的context屬性獲取。


    ''' views.py '''

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

    # 我們是通過 序列化器的data屬性來獲取 模型轉換為字典的資料
    s.data


    # 傳遞多個數據
    # 應用： 查詢所有書籍列表

    books = BookInfo.objects.all()
    # 建立序列化器，將所有書籍資訊傳遞給序列化器
    # books = [BookInfo,BookInfo,...] 物件列表
    s = BookInfoSerializers(books,many=True)
    
    person = PeopleInfo.objects.get(id=6)

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

1.3 關聯序列化器的操作

對於關聯欄位，可以採用以下幾種方式：

1） PrimaryKeyRelatedField

2） StringRelatedField

3）使用關聯物件的序列化器

#########關聯序列化器##########################

    class PeopleInfoSerializer(serializers.Serializer):
        """英雄資料序列化器"""
        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 '''
        # 設定關聯外來鍵的時候，要將 read_only=True
        # 包含read_only=True引數時，該欄位將不能用作反序列化使用
        # book = serializers.PrimaryKeyRelatedField(read_only=True,label='外來鍵')
        # 或者
        # 包含queryset引數時，將被用作反序列化時引數校驗使用
        # queryset 將關聯模型的所有資料傳遞給這個屬性就可以
        book = serializers.PrimaryKeyRelatedField(label='外來鍵',queryset=BookInfo.objects.all())

        '''StringRelatedField'''
        # 現在通過  PrimaryKeyRelatedField得到的是一個  外來鍵的一個值  2
        # 接下來通過 一個設定 來獲取 書籍的名字

        # StringRelatedField 可以獲取關聯模型中的 __str_ 裡的字串
        book = serializers.StringRelatedField()

        ''' 使用關聯物件的序列化器  拿到所有資料 '''
        book = BookInfoSerializer()

1.4 關聯查詢

關聯模型類名小寫_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='釋出日期')
        readcount = serializers.IntegerField()
        is_delete = serializers.BooleanField()
        iamge = serializers.ImageField()

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

        def __str__(self):
            return self.name

2. 反序列化

反序列化分為兩個：

資料校驗
資料入庫

2.1 資料校驗

使用序列化器進行反序列化時，需要對資料進行驗證後，才能獲取驗證成功的資料或儲存成模型類物件。

在獲取反序列化的資料前，必須呼叫is_valid()方法進行驗證，驗證成功返回True，否則返回False。

驗證失敗，可以通過序列化器物件的errors屬性獲取錯誤資訊，返回字典，包含了欄位和欄位的錯誤。

驗證成功，可以通過序列化器物件的validated_data屬性獲取資料。

在定義序列化器時，指明每個欄位的序列化型別和選項引數，本身就是一種驗證行為

2.1.1 資料校驗的第一種方式

在定義序列化器欄位的時候，規定是什麼型別就要提交符合規則的資料

例如：DateField 就需要傳入符合日期規則的資料

    ##############將JSON轉換為模型  反序列化#############

     ''' 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='釋出日期')
       
        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.建立序列器
    # 序列化器的第一個引數：instance 用於序列化操作
    # 序列化器的第二個引數：data 用於反序列化操作
    serializer = BookInfoSerializer(data=dict)

    # 2.需要呼叫序列化器的 is_valid 方法 valid驗證  返回True False
    # 如果資料可用  返回True
    serializer.is_valid()

    # raise_exception=True 可以設定為True 來丟擲異常
    serializer.is_valid(raise_exception=True)

2.1.2 資料校驗的第二種方式

欄位的選項

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

min_length,max_length 作用於字串

min_value,max_value 作用於Int整型

default 不傳入資料設定預設值

    ''' 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='釋出日期',required=True)


        def __str__(self):
            return self.name

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

3.1.3 資料校驗的第三種方式

對單個欄位的資料進行驗證

語法形式為：在序列化器中實現方法 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='釋出日期',required=True)
        readcount = serializers.IntegerField(default=0,required=False)

        def __str__(self):
            return self.name

        def validate_readcount(self,value):
            # value 就是欄位傳遞過來的資料
            if value < 0:
                raise serializers.ValidationError('閱讀量不能為負數')

            # 需要將value返回回去
            return value

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

3.1.4 資料校驗的第四種方式

對多個欄位的資料進行驗證時

語法形式為：在序列化器中實現方法 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='釋出日期',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('評論量不能大於閱讀量')

            # 要將資料返回
            return data


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

3.1.5 資料校驗的第五種方式

自定義驗證方法

同時給欄位新增自定義驗證方法

    ''' 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 '''
    # 規定：評論量不能大於閱讀量
    dict = {
        'name':'itcast',
        'readcount':20, 
        'commentcount':100
    }

2.2 資料入庫

2.2.1 資料儲存 save 方法

繼承自Serializer的序列化我們在呼叫save方法的時候，需要手動實現create方法，

呼叫save方法之前，必須呼叫 is_valid方法，

即要想儲存資料，必須保證資料是經過校驗的。

    ''' serializers.py '''

    class BookInfoSerializer(serializers.Serializer):

        def create(self,validated_data):

            # dict -->  data --> attrs  -->  validated_data
            # validated_data 此處其實就是views.py中的dict
            # validated_data 已經被驗證過的資料

            # *  對列表進行解包    *list
            # ** 對字典進行解包    **dict
            #   此處解包  將dict中的值 賦值給物件中的對應欄位
            book = BookInfo.objects.create(**validated_data)

            # create 需要將建立的物件返回
            return book 



     ''' views.py '''

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



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

    # 3. 儲存需要呼叫序列化器的save方法
    # 繼承自Serializer的序列化 我們在呼叫save方法的時候，需要手動實現create方法
    serializer.save()

2.2.2 序列化器中傳入兩個引數，即資料的更新操作

如果我們在序列化器中既傳入了物件，又傳入了資料

系統會認為我們在更新資料

繼承自Serializer的類，要更新資料的時候，需要手動實現update方法

    ''' serializers.py '''

    class BookInfoSerializer(serializers.Serializer):

        def update(self,instance,validated_data):
            # instance : 就是我們在更新資料時，傳入序列化器的物件
            # validated_data ： 驗證之後的資料

            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.儲存資料
    data = {
        'name':'lalala',
        'pub_date':'2018-1-1',
        'readcount':1000,
        'commentcount':10
    }    

    # 3.建立序列化器
    s = BookInfoSerializer(instance=book,data=data)
    # 4.驗證資料
    s.is_valid(raise_exception=True)
    # 5.儲存資料
    s.save()

3. ModelSerializer

如果我們想要使用序列化器對應的是Django的模型類，DRF為我們提供了ModelSerializer模型類

序列化器來幫助我們快速建立一個Serializer類。

ModelSerializer與常規的Serializer相同，但提供了：

基於模型類自動生成一系列欄位

包含預設的create()和update()的實現

    ''' serializers.py '''

    class BookSerializer(serializers.ModelSerializer):
        
        # 如何設定   通過class Meta
        class Meta:
            model = BookInfo    # 設定關聯模型     model就是關聯模型
            # fields = '__all__'  # fields設定欄位   __all__表示所有欄位
            # fields = ['id','name','pub_date']  # fields設定欄位  []列表顯示來設定
            exclude = ['image']   # exclude 排除列表中的欄位，剩餘的欄位都顯示

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

            # 我們可以對自動生成的欄位  進行額外的設定
            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()