drf中的Serialiazer序列化器

序列化器-Serialiazer

序列化器-Serialiazer

1 序列化器的作用

序列化，序列化器会把模型对象转化成字典，经过response以后变成字符串。
反序列化，把客户端发送来的数据，经过request之后变成字典，序列化器可以把字典转成模型。
反序列化，完成数据校验。

2 序列化器使用

# 在新创建的文件中
1 写一个序列化的类，继承Serializer
2 在类中写要序列化的字段，想序列化哪个字段，就在类中写那个字段。
# 在views.py中
3 在视图类中使用，导入==》实例化得到序列化对象，把要序列化的对象传入。
4 序列化类的对象.data  是一个数据的字典。
5 把字典返回，如果不使用rest_framework提供的Response,就得使用JsonResponse.

使用方法类似于forms组件。其内部也是可以放全局钩子和局部钩子。

# 使用过程详解

# 1. 新建文件中书写序列化的类，继承Serializer
from rest_framework import serializers

# 2. 要进行序列化的字段进行书写
class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=32, min_length=2)
    price = serializers.DecimalField(max_digits=7, decimal_places=3)
    author = serializers.CharField(max_length=32,min_length=2)

# 3. 在views.py中使用，需要先导入创建的serializer类，实例化生成对象，把要修改的数据传入。instance放的是模型类对象，data放的是前端接受数据。
    book_ser = ser.BookSerializer(instance=book, data=request.data)
# 4. 数据校验
    if book_ser.is_valid()
# 5. 如果校验通过，就进行保存
    boo_ser.save()  # 保存的时候由于鸭子类型的原因，修改数据需要重写update方法save才能生效，增加数据需要重写create方法save生效等等。。。
# 6. 如果不通过，逻辑自己写
# 7. 如果字段的校验规则不够，可以写钩子函数。
from rest_framework.exceptions import ValidationError
    # 局部钩子
    def validate_price(self, data):  # validate_字段名  接受一个参数
        if float(data) >10:
            return data
        else:
            # 校验失败
            raise ValidationError('价格太低')
            
    # 全局钩子
    def validate(self, validate_data):
        author = validate_data.get('author')
        publish = validate_data.get('publish')
        if author == publish:
            raise ValidationError('作者名字跟出版社一样')
        else:
            return validate_data
# 8. 可以使用字段的author=serializers.CharField(validators=[check_author])校验，中括号内是内存地址，但是需要写一个函数（创建的Py文件中）


'''
总结：
其实序列化器和django的forms组件很是相似，针对需要序列的字段在类中书写，还有字段的规则，局部钩子，全局钩子，它也有一些自己独特的操作，比如第八步中的字段验证，校验通过保存、增加等需要自己写一些函数等等。
在返回结果上一般会返回一个包含状态码和状态信息以及数据。
{'status':100, 'msg':'成功', 'data':'...'}
数据验证中的属性方法
is_valid()  进行验证
errors属性  获取错误信息
validated_data属性  验证通过的数据


'''

3 read_only和write_only

read_only 表明该字段仅用于序列化输出，默认False,如果改为True，postman中可以看到该字段，修改时，不需要传该字段。

write_only 表明该字段仅用于反序列化输出，默认false,如果设置为True,postman中看不到该字段，修改时，该字段需要传。

其他字段参数：

required 表明该字段在反序列化时必须输入，默认True

default 反序列化时使用的默认值

allow_null 表明该字段是否允许传入None,默认False

validators 该字段使用的验证器，跟着的时一个[函数内存地址]

error_messages 包含错误编号与错误信息的字典

4 查询所有

from rest_framework.response import Response
class BookView(APIView):
    def get(self, request):
        response_msg = {'status':100, 'msg':'成功'}
        books = Book.objects.all()
        # many=True 时序列化多条，如果序列化一条，就不需要写
        book_ser = BookSerializer(instance=books, many=True)
        response_msg['data'] = book_ser.data
        return Response

5 新增数据

from rest_framework.response import Response
class BookView(APIView)：

    def post(self, request):
        response_msg = {'status':100, 'msg':'成功'}
        # 此时的BookSerializer必须写成datat=的形式，不然会传递给instance当作位置参数
        book_ser = BookSerializer(data=request.data)
        if book_ser.is_valid():
            book_ser.save()  # 新增数据想要save生效需要在Serializer类中重写create方法.
            response_msg['data'] = book_ser.data
        else:
            response_msg['status'] = 102
            response_msg['msg']= '数据校验失败'
            response_msg['data'] = book_ser.data
        return Response(response_msg)
            
# 在新建文件类中书写create方法
def create(self, validated_data):
    instance = Book_objects.create(**validated_data)
    return instance

6 删除数据

class BookView(APIView):
    def delete(self, request, pk):
        models.Book.objdects.filter(pk=pk).delete()
        return Response({'status':100,'msg':'删除成功'})

7 drf开发REST API思路

总结 :

在开发REST API接口时，我们在视图中需要做的最核心的事是：

将数据库数据序列化为前端所需要的格式，并返回；

将前端发送的数据反序列化为模型类对象，并保存到数据库中。

在开发REST API的视图中，虽然每个视图具体操作的数据不同，但增、删、改、查的实现流程基本套路化，所以这部分代码也是可以复用简化编写的：

增：校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回

删：判断要删除的数据是否存在 -> 执行数据库删除

改：判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回

查：查询数据库 -> 将数据序列化并返回

8 source参数的用法

source参数一共有三种用法：

# source的第一种用法：起别名
xxx = serializer.CharField(source='name') 
'''
本身检验字段名要写成数据库中已存在的字段名，但是可以通过使用source来对字段进行重命名，这样就能在前端看到不同于数据库中存放信息字段名。
'''

# source的第二种用法：跨表查询
publish = serializerCharField(source='publish.name')

# source的第三种方法：放函数内存地址
publish = serializerCharField(source='test')

# models中的类中定义的函数
def test(self):
    return '要显示的值'