django-rest-framework-从零开始-2-序列化类serializers.Serializer的使用
1、前言
我们编写的django程序，需要与前端或者其他程序交互，通常会提供出自己的API接口，此时需要把程序中的对象，转换为JSON字符串，然后返回，让对接同事获取到数据。
把对象转化为JSON字符串的过程，称之为序列化。一般就是把数据库中的数据，转换为模型对象，模型对象再转换为JSON字符串。
2、创建序列化类
添加student_manager/serializers.py文件，添加以下内容
from rest_framework import serializers
from student_manager.models import Student
class StudentSerializer(serializers.Serializer):
def update(self, instance, validated_data):
pass
student_id = serializers.CharField()
student_name = serializers.CharField()
student_sex = serializers.IntegerField()
student_birthday = serializers.DateField()
id = serializers.IntegerField(required=False)
created = serializers.DateTimeField(required=False)
updated = serializers.DateTimeField(required=False)
class Meta:
fields = '__all__'
def create(self, validated_data):
print(f"StudentSerializer create validated_data:{validated_data}, type:{type(validated_data)}")
instance = Student.objects.create(**validated_data)
return instance
图示
说明：
- 创建序列化类，只需要继承
serializers.Serializer类，重写create方法和update方法即可。其中，create方法用于保存模型对象到数据库，update方法用于更新模型对象到数据库，这里先重写create方法，用于保存模型对象，update方法，后续再补充。 StudentSerializer序列化类，本意就是序列化Student模型，因此，这里需要把Student模型中的字段，都映射过来，映射方式就是把Student模型的属性都搬过来，这样看起来，代码重复了，没关系，后续会优化，现在先理解一下原理。
这样就完成了序列化类的编写，接下来，我们写一个测试脚本，测试一下，用序列化类添加一条记录到数据库
3、使用序列化类添加数据
我们添加一条数据到数据库，即添加一个Student模型对象，并保存到数据库中。
创建student_manager/debug_student_serializer.py文件，添加以下内容
import os
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tutorial.settings')
import django
django.setup()
from student_manager.serializers import StudentSerializer
def add_student():
data = dict(student_id="1001",
student_name="小红",
student_sex=1,
student_birthday="2020-1-1")
serializer = StudentSerializer(data=data)
print(f"serializer:{serializer}")
serializer.is_valid(True) # 判断数据是否合法
serializer.save() # 调用save方法, 会调用到序列化类中的create方法
if __name__ == '__main__':
add_student()
图示：
说明：
-
我们需要创建一个
Student模型对象，因此，需要把student_id、student_name、student_sex、student_birthday都定义好，然后传递给StudentSerializer序列化类 -
传递给序列化类后，调用
is_valid方法校验一下数据是否合法，这里的校验类似于模型中的校验，比如必填，非必填，是否在选项中等。我们之前定义的StudentSerializer序列化类，没有额外的校验，甚至，我们申明了id、created、updated为非必填，因为我们直接让数据库自己填充就可以了。 -
最后调用save方法，save方法会调用之前重写的create方法。从源代码中就可以看出来。
-
我们也可以给save方法传递参数，参数会传递下去，通过create方法进行使用，这个用法可以记录一下，有时候有奇效
运行student_manager/debug_student_serializer.py文件，就可以看到数据库新增了一条数据
4、使用序列化类序列化对象
接下来，我们使用序列化类，显示数据库的数据，首先是加载成模型对象，接下来转化为序列化类对象，最后转为JSON字符串，即可。最终通过API返回数据。
-
先往数据库中添加几条数据
-
在
student_manager/debug_student_serializer.py中添加以下代码from student_manager.models import Student from rest_framework.renderers import JSONRendererdef list_student(): instance = Student.objects.get(student_id="1001") serializer = StudentSerializer(instance=instance) data = serializer.data print(f'data:{data}') content = JSONRenderer().render(serializer.data) print(f'content:{content}')图示
说明：使用Student模型获取到数据库数据后，传递给StudentSerializer序列化类，序列化类的data数据就是对象的序列化信息，再通过JSONRenderer转为JSON字符串即可
- 序列化多条数据，只需要传递
many=True即可
def list_all_students():
instance = Student.objects.all()
serializer = StudentSerializer(instance=instance, many=True)
data = serializer.data
print(f'data:{data}')
content = JSONRenderer().render(serializer.data)
print(f'content:{content.decode("utf-8")}')
5、使用序列化类修改数据
要想修改数据，步骤：
- 重写序列化类中的
update方法 - 从数据库获取数据，转化为模型对象
- 模型对象传递给序列化类
- 调用序列化类的
save方法，当调用save方法时，如果传递了instance对象，则调用序列化类的update方法，否则调用序列化类的create方法。同理，可以给save方法传递额外参数，在update函数中使用，这个用法可以记录一下，有时候有奇效
- 因此修改
student_manager/serializers.py中的update方法
def update(self, instance, validated_data):
print(f"StudentSerializer update instance:{instance}, type:{type(instance)}")
print(f"StudentSerializer update validated_data:{validated_data}, type:{type(validated_data)}")
instance.student_id = validated_data.get('student_id', instance.student_id)
instance.student_name = validated_data.get('student_name', instance.student_name)
instance.student_sex = validated_data.get('student_sex', instance.student_sex)
instance.student_birthday = validated_data.get('student_birthday', instance.student_birthday)
instance.save()
return instance
图示
-
在
student_manager/debug_student_serializer.py中添加代码def update_student(): data = dict(student_id="1009", student_name="小红rename", student_sex=1, student_birthday="2020-1-19") instance = Student.objects.get(student_id="1001") serializer = StudentSerializer(instance=instance, data=data) serializer.is_valid(True) serializer.save() # 调用save方法, 会调用到序列化类中的update方法(传递instance参数时)
图示
最后运行student_manager/debug_student_serializer.py，查看数据库数据
github：https://github.com/rainbow-tan/learn-drf
标签：serializers,rest,instance,student,序列化,data,serializer From： https://www.cnblogs.com/rainbow-tan/p/17240187.html