Django -drf序列化Serializer(一)

drf序列化Serializer

作用：

1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化,完成数据校验功能

自定义序列化器

Django REST FrameWord中的serializer使用类来定义, 须继承自rest_framework.serializers.Serializer。

接下来，为了方便演示序列化器的使用，我们先创建一个新的子应用app01

基于pycharm创建django项目就不多说了, 应用名为app01 直入主题

创建数据表, 在models.py’中创建student表,如下:

from django.db import models

class Student(models.Model):
    name = models.CharField(max_length=32, )
    sex = models.SmallIntegerField(choices=((1, "男"), (2, "女")))
    age = models.SmallIntegerField()
    class_null = models.CharField(max_length=32)
    desc = models.TextField()

    class Meta:
        db_table = "tb_student"
        verbose_name_plural = "学生表"

为学生模型添加一个序列化器, 先在app01新建serializer.py文件, 文件如下内容

from rest_framework import serializers

class StudentSerializer(serializers.Serializer):
    # 需要些序列化字段
    id = serializers.IntegerField()
    name = serializers.CharField()
    sex = serializers.IntegerField()
    age = serializers.IntegerField()
    desc = serializers.CharField()

字段解释

注意: serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义serializer是独立于数据库之外的存在。

常用字段类型：

字段	字段构造方式
BooleanField	BooleanField()
NullBooleanField	NullBooleanField()
CharField	CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
EmailField	EmailField(max_length=None, min_length=None, allow_blank=False)
RegexField	RegexField(regex, max_length=None, min_length=None, allow_blank=False)
SlugField	SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9-]+
URLField	URLField(max_length=200, min_length=None, allow_blank=False)
UUIDField	UUIDField(format=’hex_verbose’) format: 1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 2） 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a" 3）'int' - 如: "123456789012312313134124512351145145114" 4）'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"
IPAddressField	IPAddressField(protocol=’both’, unpack_ipv4=False, **options)
IntegerField	IntegerField(max_value=None, min_value=None)
FloatField	FloatField(max_value=None, min_value=None)
DecimalField	DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置
DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)
DateField	DateField(format=api_settings.DATE_FORMAT, input_formats=None)
TimeField	TimeField(format=api_settings.TIME_FORMAT, input_formats=None)
DurationField	DurationField()
ChoiceField	ChoiceField(choices) choices与Django的用法相同
MultipleChoiceField	MultipleChoiceField(choices)
FileField	FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageField	ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ListField	ListField(child=, min_length=None, max_length=None)
DictField	DictField(child=)

选项参数：

参数名称	作用
max_length	最大长度
min_lenght	最小长度
allow_blank	是否允许为空
trim_whitespace	是否截断空白字符
max_value	最小值
min_value	最大值

通用参数：

参数名称	说明
read_only	表明该字段仅用于序列化输出，默认False
write_only	表明该字段仅用于反序列化输入，默认False
required	表明该字段在反序列化时必须输入，默认True
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None，默认False
validators	该字段使用的验证器
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时，显示的字段名称
help_text	用于HTML展示API页面时，显示的字段帮助提示信息

以上为序列化所有的参数, 那么开始使用使用简单的序列化类

使用主要在视图中使用

先上代码
from django.views import View
from app01 import serializer
from app01 import models

class StudentAPIView(View):
    def get(self, request, pk):
        student = models.Student.objects.get(pk=pk)
        stu_ser = serializer.StudentSerializer(instance=student)   创建ser对象
        print(stu_ser.data)

        return JsonResponse(stu_ser.data)
    
还没完, 还有路由...

代码解释

创建Serializer对象

定义好Serializer类后，就可以创建Serializer对象了。

Serializer的构造方法为：

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

说明：

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

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

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

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

通过context参数附加的数据，可以通过Serializer对象的context属性获取。

1. 使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
2. 序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
3. 序列化器的字段声明类似于我们前面使用过的表单系统。
4. 开发restful api时，序列化器会帮我们把模型数据转换成字典.
5. drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.

序列化器的使用

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

1. 在客户端请求时，使用序列化器可以完成对数据的反序列化。
2. 在服务器响应时，使用序列化器可以完成对数据的序列化。

1） 先查询出一个学生对象

from students.models import Student

student = Student.objects.get(id=3)

2） 构造序列化器对象

from .serializers import StudentSerializer
student = Student.objects.get(id=3)
serializer = StudentSerializer(instance=student)

3）获取序列化数据

通过data属性可以获取序列化后的数据

serializer.data
如: {'id': 1, 'name': 'chen', 'age': 18, 'sex': 1, 'desc': '你哈哈'}

这里只获取单个用户信息, 所以必须指定id进行查询, 需要在同一视图查询所有只需修改路由即可, 后续会讲到, 路由为

urlpatterns = [
    path('admin/', admin.site.urls),
    re_path("student/(?P\d+)", views.StudentView.as_view())
]

如下操作即可获得数据, 以json格式展现

4）如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明

代码如下, 不做详细解释, 后期有源码解读

"""使用序列化器序列化转换多个模型数据"""
def get(self,request):
    # 获取表所有数据
    student_list = Student.objects.all()

    # 转换数据[序列化过程]
    # 如果转换多个模型对象数据，则需要加上many=True
    serializer = StudentSerializer(instance=student_list,many=True)
    print( serializer.data ) # 序列化器转换后的数据

    # 响应数据给客户端
    # 返回的json数据，如果是列表，则需要声明safe=False
    return JsonResponse(serializer.data,safe=False)
    
访问结果
访问地址:  http://127.0.0.1/student
结果: 所有数据, 以列表套字典形式   [{},{}]

完, 下一节将高级用法!!