1 、序列化器的基本使用
1) 先查询出一个图书对象
from test.models import Info
p1 = Info.objects.get()
2) 构造序列化器对象
from test.serializers import InfoSerializer
serializer = InfoSerializer(p1)
3)获取序列化数据
通过data属性可以获取序列化后的数据
serializer.data
4)如果要被序列化的是包含多条数据的查询集QuerySet,可以通过添加many=True参数补充说明
p1_qs = Info.objects.all()
serializer = InfoSerializer(p1_qs, many=True)
serializer.data
1. 验证
使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。
在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False。
验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功,可以通过序列化器对象的validated_data属性获取数据。
在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。
如我们前面定义过的InfoSerializer
通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证
from test.serializers import InfoSerializer
data = {'bpub_date': 123}
serializer = InfoSerializer(data=data)
serializer.is_valid() # 返回False
serializer.errors
these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
serializer.validated_data # {}
data = {'btitle': 'python'}
serializer = InfoSerializer(data=data)
serializer.is_valid() # True
serializer.errors
serializer.validated_data
is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。
serializer.is_valid(raise_exception=True)
实现了上述方法后,在反序列化数据的时候,就可以通过save()方法返回一个数据对象实例了
book = serializer.save()
两点说明:
1) 在对序列化器进行save()保存时,可以额外传递数据,这些数据可以在create()和update()中的validated_data参数获取到
serializer.save(owner=request.user)
2)默认序列化器必须传递所有required的字段,否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新
# Update `comment` with partial data
serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)