DRF之序列化

参考网址

https://blog.csdn.net/weixin_35688430/article/details/111203136

序列化类 Serializer: 序列化数据(模型数据/非模型数据都支持)

init方法为:

Serializer(instance=None, data=empty, **kwarg)

    - 用于序列化时，将"模型类对象"传入instance参数

    - 用于反序列化时，将要被反序列化的数据传入"data参数"

    - 除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如

        # 通过context参数附加的数据，可以通过Serializer对象的context属性获取
        serializer = AccountSerializer(account, context={'request': request})

使用注意事项

- 序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以

- 序列化器无法自动接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来
    ser = Serializer(data=request.POST)

- 序列化器的字段声明类似于我们前面使用过的表单系统

- 返回restful api时，序列化器会帮我们把"模型数据"转换成"字典"
  drf提供的视图会帮我们把"字典"转换成"json",或者把客户端发送过来的"数据"转换"字典"

序列化器的使用分两个阶段

在客户端请求时，视图返回数据的时候,使用序列化器可以完成对数据的反序列化,最终返回给前端
在服务器响应时，视图获取前端打包过来的数据,使用序列化器可以完成对数据的序列化。

基本示例Demo


book = BookInfo.objects.get(id=2)
ser = BookInfoSerializer(book) # BookInfoSerializer(instance=book)
serializer.data # # {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}

### 如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明
book_qs = BookInfo.objects.all()
serializer = BookInfoSerializer(book_qs, many=True)
serializer.data
# [OrderedDict([('id', 2), ('btitle', '天龙八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飞狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西游记'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]

小结: 返回单条/多条数据

- 如果是序列化'单条数据',那么返回的是一个'类字典对象',把它当成'字典对象'来处理即可

- 如果是徐丽华'数据集',那么返回的是一个 list 包裹的'类字典对象',需遍历获取

反序列化

- 获取前端传过来的数据,需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象

    - 即调用 is_valid() 方法进行验证

        - 验证成功返回True

            - 可以通过序列化器对象的validated_data属性(值为'类字典对象')获取数据

        - 否则返回False

            - 以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误
              如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。


- 在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为

>>>from booktest.serializers import BookInfoSerializer
data = {'bpub_date': 123}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # 返回False
serializer.errors
# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
serializer.validated_data  # {}

data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.errors  # {}
serializer.validated_data  #  OrderedDict([('btitle', 'python')])

is_valid() 拓展

### raise_exception=True: 会向前端返回HTTP 400 Bad Request响应
serializer.is_valid(raise_exception=True)

### 自定义 validate_字段名() 方法,对单个字段进行校验
    - 参数 value 表示 前端传过来的数据,即该字段对应的值
class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise serializers.ValidationError("图书不是关于Django的")
        return value


from booktest.serializers import BookInfoSerializer
data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

### 同时对多个字段进行比较验证时，可以定义 validate() 方法来验证
class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def validate(self, attrs):
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if bread < bcomment:
            raise serializers.ValidationError('阅读量小于评论量')
        return attrs


from booktest.serializers import BookInfoSerializer
data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20}
s = BookInfoSerializer(data=data)
s.is_valid()  # False
s.errors
#  {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

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

# 自定义验证函数
def about_django(value):
    if 'django' not in value.lower():
        raise serializers.ValidationError("图书不是关于Django的")

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ......
    btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])


from booktest.serializers import BookInfoSerializer
data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

小结: 自定义校验的三种方法

- validate_field(self,value): 单个字段验证

- validate(): 多个字段验证

- validators=自定义函数对象: 单个字段验证

反序列化-保存数据

当验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.
即把数据转成模型类对象
操作方法: 实现create()和update()两个方法即可
- 注意,此时并没有把数据存入db,只是返回数据对象而已

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def create(self, validated_data):
        """新建一个实例"""
        return BookInfo(**validated_data)

    def update(self, instance, validated_data):
        """为实例更新字段值"""
        instance.btitle = validated_data.get('btitle', instance.btitle)
        instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)
        instance.bread = validated_data.get('bread', instance.bread)
        instance.bcomment = validated_data.get('bcomment', instance.bcomment)
        return instance

如果需要在返回数据对象的时候，也将数据保存到数据库中，则可以进行如下修改

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def create(self, validated_data):
        """
        - 不再返回 BookInfo(**validated_data) 实例
        - 而是调用 create()方法,在db中创建这条记录
        """
        return BookInfo.objects.create(**validated_data)

    def update(self, instance, validated_data):
        """更新，instance为要更新的对象实例"""
        instance.btitle = validated_data.get('btitle', instance.btitle)
        instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)
        instance.bread = validated_data.get('bread', instance.bread)
        instance.bcomment = validated_data.get('bcomment', instance.bcomment)
        # 调用save(),把更新的内容存入db
        instance.save()
        return instance

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

Copyfrom db.serializers import BookInfoSerializer
data = {'btitle': '封神演义'}
serializer = BookInfoSerializer(data=data) # 没有传递instance实例,create()被调用
serializer.is_valid()  # True
serializer.save()  # <BookInfo: 封神演义>

from db.models import BookInfo
book = BookInfo.objects.get(id=2)
data = {'btitle': '倚天剑'}
serializer = BookInfoSerializer(book, data=data) # 如果传递了instance实例, update()被调用
serializer.is_valid()  # True
serializer.save()  # <BookInfo: 倚天剑>
book.btitle  # '倚天剑'

附加说明

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

# request.user 是django中记录当前登录用户的模型对象
serializer.save(owner=request.user)

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

# Update `comment` with partial data
serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)

发表于 2022-08-29 17:33 清安宁阅读(45) 评论(0) 编辑收藏举报

参考网址

序列化类 Serializer: 序列化数据(模型数据/非模型数据 都支持)

反序列化-保存数据

附加说明

序列化类 Serializer: 序列化数据(模型数据/非模型数据都支持)