DRF之Serializer

序列化器介绍

　　序列化器其实就是一个类

　　作用

　　　　1、序列化,序列化器会把模型对象(qs，book)转换成字典,经过response以后变成json字符串

　　　　2、反序列化,把客户端发(前端)送过来的数据,经过request以后变成字典(data),序列化器可以把字典转成模型-->存到数据库中

　　　　3、反序列化,完成数据校验功能---》前端传入的数据是否合法，长度够不够。。。数据校验

　　使用方式

　　　　1、写一个类：必须继承drf中的Serializer及其子类

　　　　2、在类中写要序列化的字段-->要序列化哪些，就写哪些，不序列化的不写

　　　　3、使用序列化类，视图类中用

　　　　　　得到序列化类对象 对象.data,通过Response返回给前端

Serializer的使用

　　1、基本使用——序列化

　　　　serializers.py(序列化类）

from rest_framework import serializers


class BookSerializer(serializers.Serializer):
    # max_length=32,min_length=3  反序列化保存校验数据的时候用
    name = serializers.CharField()
    # models中使用了DecimalField，这个位置使用了CharField会把小数类型转成字符串
    price = serializers.CharField(max_length=8, min_length=3)
    author = serializers.CharField()

　　　　views.py

from rest_framework.views import APIView
class BookView(APIView):
    def get(self, request):
        # 查出来的数据做序列化
        book_list = Book.objects.all()
        # instance:要序列化的对象  qs，单个对象
        # many:如果是qs对象，many=True，如果是单个对象many=False
        ser = BookSerializer(instance=book_list, many=True)  # 传入初始化参数instance=None, data=empty
        # ser.data使用模型类对象序列化后对象
        return Response(ser.data)   # 字典，列表，字符串都行

　　　　urls.py

from django.contrib import admin
from django.urls import path
from app01 import views

urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', views.BookView.as_view()),
]

　　　　models.py

from django.db import models


# Create your models here.
class Book(models.Model):
    name = models.CharField(max_length=32)
    price = models.DecimalField(decimal_places=2, max_digits=5)
    author = models.CharField(max_length=32)

 　　补充：

　　　　需要在settings.py中注册，不然在浏览器访问会报错

 

 

 　　2、字段类型

　　　　需掌握

CharField
IntegerField
FloatField
DecimalField
DateTimeField
DateField

　　　了解知道

ListField
DictField

　　　　详情

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=)

　　扩展ListField

　3、字段参数

　　　　重点

　　　　read_only：表明该字段仅用于序列化输出，默认False

　　　　　　如果read_only=True，这个字段只用来做序列化---》把对象---》json给前端

　　　　write_only:表明该字段仅用于反序列化输入，默认False

　　　　　　如果write_only=True，这个字段只用来做反序列化---》前端json---》存到数据库

　　　　举例

    name=serializers.CharField(max_length=32,min_length=3)
    price=serializers.CharField(write_only=True,read_only=True)
    author=serializers.CharField(write_only=True)
   
    
    # 什么都不写，表示既序列化，又反序列化
    # 序列化给前端，前端看到的字段样子---》只能看到name
    # 反序列化，前端需要传什么过来name,price,author都传
    
    # write_only=True,read_only=True 逻辑矛盾

　　　　选项参数

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

　　　　通用参数

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

　　4、序列化时，定制序列化的字段

　　　　作用伪代码

# 作用？比如author关联了外键，想取出作者详情
# author_info = serializers.SerializerMethodField()
# def get_author_info(self,obj):
#     return {'name':obj.author.name,'age':obj.author.age}

　　　　第一种：在序列化类中写

# price_info = serializers.SerializerMethodField()  # 必须配合一个方法,方法名get_字段名
# def get_price_info(self, obj): # 方法返回什么，字段就是什么，obj是当前序列化到的单个对象
#     return "价格是："+str(obj.price)  # python是动态强类型语言--》强类型是：不同类型之间不允许直接运算

　

　　　　第二种：在models中写方法

　　　　在models中写方法，这里字段名就是models的方法名，price_info方法返回什么，这个字段就是什么

# 表模型中写方法
@property   # 把方法包装成数据属性
def price_info(self):
   return "价格是：" + str(self.price)
  
# 序列化类中使用
price_info=serializers.CharField(read_only=True)  # 只用来做序列化
# authors=serializers.ListField()

 反序列化之新增

　　步骤

　　　　1、把前端传入的数据，放到Serializer对象中:ser=BookSerializer(data=request.data)

　　　　2、校验数据：ser.is_valid():

　　　　3、保存，ser.save()---》必须重写create，在序列化类中

　　views.py

class BookView(APIView):
    def post(self,request):
        # 反序列化,保存---》使用data参数
        ser=BookSerializer(data=request.data) #
        # 校验数据
        if ser.is_valid():  # 如果是true表示数据校验通过，通过，就保存
            # 如果instance为None，调用save本质会调用create--》父类create直接抛异常，所以我们要重写
            ser.save()  # 就会保存,重写create方法，如果不重写，我们不知道存到哪个表中
            return Response(ser.data)
        return Response({'code':101,'msg':'数据校验失败','err':ser.errors})

　　serializers.py

from rest_framework import serializers
from .models import Book

# drf提供的类：Serializer
class BookSerializer(serializers.Serializer):
    name = serializers.CharField(max_length=8, min_length=3)
    price=serializers.CharField()
    author = serializers.CharField()
    price_info=serializers.CharField(read_only=True)  # 只用来做序列化


    def create(self, validated_data):
        # validated_data校验过后的数据
        # 手动存到book表中
        book=Book.objects.create(**validated_data)
        # book=Book.objects.create(name=validated_data.get('name'))
        return book  # 不要忘记返回book对象

 国际化

　　改成中文，在配置文件中改

# 配置文件中改
LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
USE_I18N = True
USE_L10N = True
USE_TZ = False

 

 反序列化之修改

　　serializer.py

class BookSerializer(serializers.Serializer):
    id = serializers.CharField(read_only=True)
    # max_length=32,min_length=3  反序列化保存校验数据的时候用
    name = serializers.CharField(max_length=8, min_length=3)
    price = serializers.CharField(required=False)  # models中使用了DecimalField，这个位置使用了CharField会把小数类型转成字符串
    author = serializers.CharField(required=False)

    def create(self, validated_data):
        # validated_data校验过后的数据
        # 手动存到book表中

        book = Book.objects.create(**validated_data)
        # book=Book.objects.create(name=validated_data.get('name'))
        return book  # 不要忘记返回book对象

    def update(self, instance, validated_data):
        # validated_data校验过后的数据,instance 是要修改的对象
        instance.name = validated_data.get('name')
        instance.price = validated_data.get('price')
        instance.author = validated_data.get('author')
        instance.save()  # 模型对象自带的save，保存到数据库中
        return instance  # 要忘记返回instance对象

　　views.py

class BookDetailView(APIView):
    def get(self, request, pk):
        book = Book.objects.filter(pk=pk).first()
        ser = BookSerializer(instance=book)  # 如果是单条记录，many不传，就是false
        return Response(ser.data)

    def delete(self, request, pk):
        res = Book.objects.filter(pk=pk).delete()
        print(res)
        if res[0] > 0:
            return Response({'code': 100, 'msg': '删除成功'})
        else:
            return Response({'code': 103, 'msg': '数据不存在'})

    def put(self, request, pk):
        # 修改：用什么数据，修改哪个对象？
        book = Book.objects.filter(pk=pk).first()
        # 既有instance，又有data，表示修改
        ser = BookSerializer(instance=book, data=request.data)
        if ser.is_valid():
            # 重写update方法
            ser.save()  # 调用save---》内部根据instance判断是触发create还是update
            return Response(ser.data)
        return Response({'code': 102, 'msg': '修改出错', 'err': ser.errors})

　　urls.py

urlpatterns = [
    path('admin/', admin.site.urls),
    path('books/', views.BookView.as_view()),
    path('books/<int:pk>', views.BookDetailView.as_view()),
]

 

 反序列化之局部和全局钩子

 　　局部钩子

    # 字段有自己的校验：max_length .... ,再校验，就可以写局部钩子
    def validate_name(self, attr):
        # attr就是前端传入的数据
        # 名字不能以sb开头
        if attr.startswith('sb'):
            raise ValidationError("名字不能以sb开头")
        else:
            return attr  # 没有问题，正常返回

 　　全局钩子

   def validate(self, attrs):
        # attrs校验过后的数据
        if attrs.get('name') == attrs.get('author'):
            raise ValidationError('作者名不能等于书名')
        else:
            return attrs

 　　执行顺序

　　　　先走字段自己规则，再走局部钩子，再走全局钩子