12 ModelSerializer組件

時間 2020-12-03

標籤 html python shell 數據庫 django api url 設計 code 欄目 HTML 简体版

原文原文鏈接

模型類序列化器ModelSerializer

若是咱們想要使用序列化器對應的是Django的模型類，DRF爲咱們提供了ModelSerializer模型類序列化器來幫助咱們快速建立一個Serializer類。html

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

基於模型類自動生成一系列字段
基於模型類自動爲Serializer生成validators，好比unique_together
包含默認的create()和update()的實現

1. 定義

好比咱們建立一個BookInfoSerializer：shell

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        fields = '__all__'

model 指明參照哪一個模型類
fields 指明爲模型類的哪些字段生成

咱們能夠在python manage.py shell中查看自動生成的BookInfoSerializer的具體實現數據庫

>>> from booktest.serializers import BookInfoSerializer
>>> serializer = BookInfoSerializer()
>>> serializer
BookInfoSerializer():
    id = IntegerField(label='ID', read_only=True)
    btitle = CharField(label='名稱', max_length=20)
    bpub_date = DateField(allow_null=True, label='發佈日期', required=False)
    bread = IntegerField(label='閱讀量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='評論量', max_value=2147483647, min_value=-2147483648, required=False)
    image = ImageField(allow_null=True, label='圖片', max_length=100, required=False)

2. 指定字段

使用fields來明確字段，__all__表名包含全部字段，也能夠寫明具體哪些字段，如

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date')

使用exclude能夠明確排除掉哪些字段

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        exclude = ('image',)

顯示指明字段，如：

class HeroInfoSerializer(serializers.ModelSerializer):
    hbook = BookInfoSerializer()

    class Meta:
        model = HeroInfo
        fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

指明只讀字段

能夠經過read_only_fields指明只讀字段，即僅用於序列化輸出的字段django

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date'， 'bread', 'bcomment')
        read_only_fields = ('id', 'bread', 'bcomment')

3. 添加額外參數

咱們可使用extra_kwargs參數爲ModelSerializer添加或修改原有的選項參數api

class BookInfoSerializer(serializers.ModelSerializer):
    """圖書數據序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment')
        extra_kwargs = {
            'bread': {'min_value': 0, 'required': True},
            'bcomment': {'min_value': 0, 'required': True},
        }

基於 Serializer組件的model、urls、views使用serializers.ModelSerializer重寫ui

4. 序列化

class BookInfoModelSerializer(serializers.ModelSerializer):
    # 1.還能夠自定義設置序列化字段，可是必須在fields中聲明,在fields中寫publish_address
    # 出版社顯示名稱，而不是0，1。。。
    publish_address = serializers.CharField(source='get_publisher_display', required=False)  # 找到對應中文

    # 圖片顯示全路徑
    image_path = serializers.SerializerMethodField()

    def get_image_path(self, obj):
        # settings.MEDIA_URL: 本身配置的 /media/，給後面高級序列化與視圖類準備的
        # obj.icon不能直接做爲數據返回，由於內容雖然是字符串，可是類型是ImageFieldFile類型
        return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.image))

    # 自定義虛擬閱讀量，原基礎增長10
    fictitious_bread = serializers.SerializerMethodField()

    def get_fictitious_bread(self, obj):
        return obj.bread + 10

    class Meta:
        # 序列化關聯的model類
        model = models.BookInfo

        # 參與序列化的字段
        fields = (
            'id', 'pwd', 'publisher', 'publish_address', 'btitle', 'bpub_date', 'created_time', 'bread',
            'fictitious_bread', 'bcomment', 'image', 'image_path')

        # 指明只讀字段，即僅用於序列化輸出的字段
        read_only_fields = ('publisher_name', 'fictitious_bread', 'image_path')

5. 反序列化

class BookInfoModelDeSerializer(serializers.ModelSerializer):
    pwd = serializers.CharField(label='密碼', required=True)
    publisher = serializers.IntegerField(label='出版社', required=False)
    btitle = serializers.CharField(label='名稱', max_length=20)
    bpub_date = serializers.DateField(label='發佈日期', required=False)
    created_time = serializers.DateTimeField(label='建立時間', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=True)
    bcomment = serializers.IntegerField(label='評論量', required=True)
    image = serializers.ImageField(label='圖片', required=False)

    # 自定義有校驗規則的反序列化字段,例如確認密碼字段re_pwd
    re_pwd = serializers.CharField(required=True)

    class Meta:
        model = models.BookInfo
        # 沒有默認值的字段必須序列化，爲其傳值
        fields = ('pwd', 're_pwd', 'publisher', 'btitle', 'bpub_date', 'created_time', 'bread', 'bcomment', 'image')

    # 局部鉤子：validate_要校驗的字段名(self, 當前要校驗字段的值)
    # 校驗規則：校驗經過返回原值，校驗失敗，拋出異常
    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise exceptions.ValidationError('validate_btitle-圖書不是關於Django的')
        return value

    # 全局鉤子：validate(self, 經過系統與局部鉤子校驗以後的全部數據)
    def validate(self, attrs):  # attrs是字典格式
        pwd = attrs.get('pwd')
        re_pwd = attrs.pop('re_pwd')  # 由於re_pwd不須要存入數據庫，因此在全局鉤子校驗中刪除掉這個字段
        print(re_pwd)
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if pwd != re_pwd:
            raise exceptions.ValidationError({'pwd&re_pwd': '兩次密碼不一致'})
        if bread < bcomment:
            raise serializers.ValidationError('閱讀量小於評論量')
        return attrs

    # 注意：ModelSerializer類已經幫咱們實現了 create 與 update 方法,不須要寫create就能建立

6 序列化與反序列化整合

序列化層：api/serializers.pyurl

class BookModelSerializer(serializers.ModelSerializer):
    pwd = serializers.CharField(label='密碼', required=True)
    publisher = serializers.IntegerField(label='出版社', required=False)
    btitle = serializers.CharField(label='名稱', max_length=20)
    bpub_date = serializers.DateField(label='發佈日期', required=False)
    created_time = serializers.DateTimeField(label='建立時間', required=False)
    bread = serializers.IntegerField(label='閱讀量', required=True)
    bcomment = serializers.IntegerField(label='評論量', required=True)
    image = serializers.ImageField(label='圖片', required=False)

    # 序列化自定義字段
    # 出版社顯示名稱，而不是0，1。。。
    publisher_name = serializers.CharField(source='get_publisher_display', required=False)  # 找到對應中文
    # 圖片顯示全路徑
    image_path = serializers.SerializerMethodField()
    # 自定義虛擬閱讀量，原基礎增長10
    fictitious_bread = serializers.SerializerMethodField()

    # 反序列化自定義字段
    re_pwd = serializers.CharField(required=True, write_only=True)

    class Meta:
        model = models.BookInfo
        fields = "__all__"
        # 只讀字段
        read_only_fields = (
            'id', 'pwd',  'publisher', 'publisher_name', 'btitle', 'bpub_date', 'created_time', 'bread',
            'fictitious_bread', 'bcomment', 'image', 'image_path')
        extra_kwargs = {
            'pwd': {
                'write_only': True
            },
            're_pwd': {
                'write_only': True
            },
            'bpub_date': {
                'write_only': True
            },
            'publisher': {
                'write_only': True,
            },

            'img': {
                'read_only': True,
            },
            'created_time': {
                'read_only': True,
            },
            'publish_name': {
                'read_only': True,
            }
        }

    def get_image_path(self, obj):
        # settings.MEDIA_URL: 本身配置的 /media/，給後面高級序列化與視圖類準備的
        # obj.icon不能直接做爲數據返回，由於內容雖然是字符串，可是類型是ImageFieldFile類型
        return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.image))

    def get_fictitious_bread(self, obj):
        return obj.bread + 10

    # 局部鉤子：validate_要校驗的字段名(self, 當前要校驗字段的值)
    # 校驗規則：校驗經過返回原值，校驗失敗，拋出異常
    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise exceptions.ValidationError('validate_btitle-圖書不是關於Django的')
        return value

    # 全局鉤子：validate(self, 經過系統與局部鉤子校驗以後的全部數據)
    def validate(self, attrs):  # attrs是字典格式
        pwd = attrs.get('pwd')
        re_pwd = attrs.pop('re_pwd')  # 由於re_pwd不須要存入數據庫，因此在全局鉤子校驗中刪除掉這個字段
        print(re_pwd)
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if pwd != re_pwd:
            raise exceptions.ValidationError({'pwd&re_pwd': '兩次密碼不一致'})
        if bread < bcomment:
            raise serializers.ValidationError('閱讀量小於評論量')
        return attrs

    # 注意：ModelSerializer類已經幫咱們實現了 create 與 update 方法,不須要寫create就能建立

序列化層注意點：設計

1) fields中設置全部序列化與反序列化字段
2) extra_kwargs劃分只序列化或只反序列化字段（通常咱們把須要存入到數據庫中的使用write_only（反序列化）,只須要展現的就read_only(序列化)，看需求設計）
    write_only：只反序列化
    read_only：只序列化
    自定義字段默認只序列化(read_only)
    若是字段沒設置write_only或者read_only，那麼該字段能夠序列化和反序列化
3) 設置反序列化所需的 系統、局部鉤子、全局鉤子 等校驗規則

7 ModelSerializer總結

class BookSerializer(serializers.ModelSerializer):
    model字段或自定義字段
    
    class Meta:
        model = models.BookInfo   # 與BookInfo表對應
        # 使用fields來明確字段，__all__表名包含全部字段，也能夠寫明具體哪些字段
        fields=('參與序列化和反序列的字段1','參與序列化和反序列的字段2')
        fields = "__all__"  
        
        # 使用exclude能夠明確排除掉哪些字段
        exclude = ('image',)
        # 指明只讀字段  經過read_only_fields指明只讀字段，即僅用於序列化輸出的字段
        read_only_fields = ('id', 'bread', 'bcomment')
        
        # 爲ModelSerializer添加或修改原有的選項參數
        extra_kwargs = {
            
        }
    # 局部鉤子：validate_要校驗的字段名(self, 當前要校驗字段的值)
    # 校驗規則：校驗經過返回原值，校驗失敗，拋出異常
    def validate_btitle(self, value):
        ....
        return value
    # 全局鉤子：validate(self, 經過系統與局部鉤子校驗以後的全部數據)
    def validate(self, attrs):  # attrs是字典格式
        ...
        return attrs