序列化类常用字段类型
| 字段 |
字段构造方式 |
| 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页面时，显示的字段帮助提示信息 |
序列化类高级用法之source
修改序列化字段名
# name字段在前端显示的时候叫book_name
-使用source，字段参数，可以指定序列化表中得哪个字段
book_name = serializers.CharField(max_length=8, min_length=3,source='name')
-source指定的可以是字段，也可以是方法，用于重命名
-source可以做跨表查询
原字段
from rest_framework import serializers
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price = serializers.IntegerField(min_value=10, max_value=99)
publish = serializers.CharField(max_length=9, min_length=3)
修改字段
from django.db import models
class BookSerializer(serializers.Serializer):
book_name = serializers.CharField(max_length=8, min_length=3, source='name')
book_price = serializers.IntegerField(min_value=10, max_value=99, source='price')
book_publish = serializers.CharField(max_length=9, min_length=3, source='publish')
页面展示
定制序列化字段的两种方式
# 要求前端显示形式为
{
"name": "遥远的救世主",
"price": 99,
"publish": {name:xx,city:xxx,email:sss}
}
# 方式一：在序列化类中写SerializerMethodField
publish = serializers.SerializerMethodField()
def get_publish(self, obj):
# obj 是当前序列化的对象
return {'name': obj.publish.name, 'city': obj.publish.city, 'email': obj.publish.email}
# 方式二：在表模型中写方法
def publish_detail(self):
return {'name': self.publish.name, 'city': self.publish.city, 'email': self.publish.email}
publish_detail=serializers.DictField()
# 在模型类中写逻辑代码，称之为ddd，领域驱动模型
方式一：SerializerMethodField
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price = serializers.IntegerField(min_value=10, max_value=99)
publish_date = serializers.DateField()
# publish要序列化成 {name:北京出版社，city：北京，email:2@qq.com}
# 方式一：SerializerMethodField必须配合一个方法(get_字段名,需要接受一个参数)，方法返回什么，这个字段就是什么
publish = serializers.SerializerMethodField()
def get_publish(self, obj):
# obj 是当前序列化的对象
return {'name': obj.publish.name, 'city': obj.publish.city, 'email': obj.publish.email}
# 练习，用方式一，显示所有作者对象 []
authors = serializers.SerializerMethodField()
def get_authors(self, obj):
res_list = []
for author in obj.authors.all():
res_list.append({'id': author.id, 'name': author.name, 'age': author.age})
return res_list
页面展示
方式二：在表模型中写方法
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.DecimalField(max_digits=5, decimal_places=2)
publish_date = models.DateField(null=True)
publish = models.ForeignKey(to='Publish', on_delete=models.CASCADE)
authors = models.ManyToManyField(to='Author')
def publish_detail(self):
return {'name': self.publish.name, 'city': self.publish.city, 'email': self.publish.email}
def author_list(self):
res_list = []
for author in self.authors.all():
res_list.append({'id': author.id, 'name': author.name, 'age': author.age})
return res_list
def __str__(self):
return self.name
serailizer.py
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price = serializers.IntegerField(min_value=10, max_value=99)
publish_date = serializers.DateField()
# 方式二：在表模型中写方法
publish_detail = serializers.DictField(read_only=True)
# 使用方式二实现，显示所有作者
author_list = serializers.ListField(read_only=True)
关联关系表反序列化保存
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price = serializers.IntegerField(min_value=10, max_value=99)
publish_date = serializers.DateField()
# 反序列化用的
publish = serializers.IntegerField(write_only=True)
authors = serializers.ListField(write_only=True)
# 序列化用的
publish_detail = serializers.DictField(read_only=True)
author_list = serializers.ListField(read_only=True)
# 重写create方法
def create(self, validated_data):
# validated_data 校验过后的数据
book = Book.objects.create(name=validated_data.get('name'),
price=validated_data.get('price'),
publish_date=validated_data.get('publish_date'),
publish_id=validated_data.get('publish'),
)
authors = validated_data.get('authors')
book.authors.add(*authors)
return book
页面展示
# 缺点
1 在序列化中每个字段都要写，无论是序列化还是反序列化
2 如果新增或者修改，在序列化类中都需要重写create或update
# 解决这个缺点，使用ModelSerializer来做
模型类序列化器
class BookModelSerializer(serializers.ModelSerializer): #ModelSerializer继承Serializer
# 不需要写字段了，字段从表模型映射过来
class Meta:
model = Book # 要序列化的表模型
# fields='__all__' # 所有字段都序列化
fields = ['name', 'price', 'publish_date', 'publish', 'authors', 'publish_detail',
'author_list'] # 列表中有什么，就是序列化哪个字段
# 给authors和publish加write_only属性
# name加max_len属性
extra_kwargs = {
'name': {'max_length': 8},
'publish': {'write_only': True},
'authors': {'write_only': True},
}
publish_detail = serializers.SerializerMethodField(read_only=True)
def get_publish_detail(self, obj):
# obj 是当前序列化的对象
return {'name': obj.publish.name, 'city': obj.publish.city, 'email': obj.publish.email}
authors_list = serializers.SerializerMethodField(read_only=True)
def get_authors_list(self, obj):
res_list = []
for author in obj.authors.all():
res_list.append({'id': author.id, 'name': author.name, 'age': author.age})
return res_list
总结
# 如何使用
1 定义一个类继承ModelSerializer
2 类内部写内部内 class Meta:
3 在内部类中指定model(要序列化的表)
4 在内部类中指定fields(要序列化的字段，写__all__表示所有，不包含方法，写[一个个字段])
5 在内部类中指定extra_kwargs，给字段添加字段参数的
6 在序列化类中，可以重写某个字段，优先使用你重写的
name = serializers.SerializerMethodField()
def get_name(self, obj):
return 'sb---' + obj.name
7 以后不需要重写create和update了
-ModelSerializer写好了，兼容性更好，任意表都可以直接存
反序列化之数据校验
# 字段自己的校验规则
-如果继承的是Serializer，写法如下
name=serializers.CharField(max_length=8,min_length=3,error_messages={'min_length': "太短了"})
-如果继承的是ModelSerializer，写法如下
extra_kwargs = {
'name': {'max_length': 8, 'min_length': 3, 'error_messages': {'min_length': "太短了"}},
}
# 局部钩子
-如果继承的是Serializer，写法一样
-如果继承的是ModelSerializer，写法一样
def validate_name(self, name):
if name.startswith('sb'):
# 校验不通过，抛异常
raise ValidationError('不能以sb卡头')
else:
return name
# 全局钩子
-如果继承的是Serializer，写法一样
-如果继承的是ModelSerializer，写法一样
def validate(self, attrs):
if attrs.get('name') == attrs.get('publish_date'):
raise ValidationError('名字不能等于日期')
else:
return attrs
反序列化数据源码分析
# 先校验字段自己的规则(最大，最小)，走局部钩子校验，走全局钩子
# 局部：validate_name，全局叫：validate 为什么？
# 入口：从哪开始看，哪个操作，执行了字段校验ser.is_valid()
-BaseSerializer内的is_valid()方法
def is_valid(self, *, raise_exception=False):
if not hasattr(self, '_validated_data'):
try:
# 真正的走校验，如果成功，返回校验过后的数据
self._validated_data = self.run_validation(self.initial_data)
except ValidationError as exc:
return not bool(self._errors)
-内部执行了：self.run_validation(self.initial_data)---》本质执行的Serializer的
-如果你按住ctrl键，鼠标点击，会从当前类中找run_validation，找不到会去父类找
-这不是代码的执行，代码执行要从头开始找，从自己身上再往上找
def run_validation(self, data=empty):
#局部钩子的执行
value = self.to_internal_value(data)
try:
# 全局钩子的执行，从根上开始找着执行，优先执行自己定义的序列化类中得全局钩子
value = self.validate(value)
except (ValidationError, DjangoValidationError) as exc:
raise ValidationError(detail=as_serializer_error(exc))
return value
-全局钩子看完了，局部钩子---》 self.to_internal_value---》从根上找----》本质执行的Serializer的
def to_internal_value(self, data):
for field in fields: # fields：序列化类中所有的字段，for循环每次取一个字段对象
# 反射：去self：序列化类的对象中，反射 validate_字段名 的方法
validate_method = getattr(self, 'validate_' + field.field_name, None)
try:
# 这句话是字段自己的校验规则（最大最小长度）
validated_value = field.run_validation(primitive_value)
# 局部钩子
if validate_method is not None:
validated_value = validate_method(validated_value)
except ValidationError as exc:
errors[field.field_name] = exc.detail
return ret
# 你自己写的序列化类---》继承了ModelSerializer---》继承了Serializer---》BaseSerializer---》Field
断言assert
# assert :断言，作用的判断，断定一个变量必须是xx，如果不是就报错，写法如下：
name = 'jason'
assert name == 'jason', 'name不等于jason'
print('GG')
自主练习
继承APIview+Serializer
serializer.py
from rest_framework import serializers
from .models import Book
# 序列化类中
class BookSerializer(serializers.Serializer):
name = serializers.CharField(max_length=8, min_length=3)
price = serializers.IntegerField(min_value=10, max_value=99)
publish_date = serializers.DateField()
# 反序列化用的
publish = serializers.IntegerField(write_only=True)
authors = serializers.ListField(write_only=True)
# 序列化用的
publish_detail = serializers.DictField(read_only=True)
author_list = serializers.ListField(read_only=True)
def create(self, validated_data):
# validated_data 校验过后的数据
book = Book.objects.create(name=validated_data.get('name'),
price=validated_data.get('price'),
publish_date=validated_data.get('publish_date'),
publish_id=validated_data.get('publish'),
)
authors = validated_data.get('authors')
book.authors.add(*authors)
return book
def update(self, instance, validated_data):
instance.name = validated_data.get('name') # 对象点name = 校验过后的数据中的name
instance.price = validated_data.get('price')
instance.publish_date = validated_data.get('publish_date')
instance.publish_id = validated_data.get('publish_id')
authors = validated_data.get('authors')
instance.authors.set(*authors)
instance.save() # 调用save方法保存
return instance # 最后把instance返回出去
views.py
from django.shortcuts import render
from rest_framework.views import APIView
from .serializer import BookSerializer
from .models import Book
from rest_framework.response import Response
class BookView(APIView):
# 获取所有图书接口
def get(self, request):
book_list = Book.objects.all()
# res = BookSerializer(instance=book_list, many=True)
ser = BookSerializer(instance=book_list, many=True)
return Response(ser.data)
# 新增图书接口
def post(self, request):
ser = BookSerializer(data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '新增成功'})
else:
return Response({'code': 102, 'msg': ser.errors})
class BookDetailView(APIView):
# 获取单个图书接口
def get(self, request, pk):
book = Book.objects.filter(pk=pk).first()
ser = BookSerializer(instance=book)
return Response(ser.data)
# 修改图书接口
def put(self, request, pk):
book = Book.objects.filter(pk=pk).first() # 根据pk取到book对象
ser = BookSerializer(instance=book, data=request.data) # 使用data数据修改book对象
if ser.is_valid(): # 校验前端传入的数据 虽然没写校验规则，但是流程还在
ser.save() # 调用save会触发BookSerializer的save方法，判断了，如果instance有值执行update，没有值执行create
return Response(ser.data) # 校验成功返回数据
else:
return Response(ser.errors) # 否则返回错误信息
# 删除图书接口
def delete(self, request, pk):
Book.objects.filter(pk=pk).delete()
return Response()
继承APIView+ModelSerializers
serialize.py
from rest_framework import serializers
from .models import Book
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
# 序列化表模型
model = Book
# 序列化字段 fields = '__all__'
fields = ['name', 'price', 'publish_date', 'publish', 'authors', 'publish_detail',
'authors_list']
# 给新增的两个字段添加write_only属性
extra_kwargs = {
'name': {'max_length': 8},
'publish': {'write_only': True},
'authors': {'write_only': True},
}
publish_detail = serializers.SerializerMethodField(read_only=True)
def get_publish_detail(self, obj):
# obj 是当前序列化的对象
return {'name': obj.publish.name, 'city': obj.publish.city, 'email': obj.publish.email}
authors_list = serializers.SerializerMethodField(read_only=True)
def get_authors_list(self, obj):
res_list = []
for author in obj.authors.all():
res_list.append({'id': author.id, 'name': author.name, 'age': author.age})
return res_list
views.py
from django.shortcuts import render
from rest_framework.views import APIView
from .serializer import BookModelSerializer
from .models import Book
from rest_framework.response import Response
# Create your views here.
class BookView(APIView):
# 获取所有图书接口
def get(self, request):
book_list = Book.objects.all()
ser = BookModelSerializer(instance=book_list, many=True)
return Response(ser.data)
# 新增图书接口
def post(self, request):
ser = BookModelSerializer(data=request.data)
if ser.is_valid():
ser.save()
return Response({'code': 100, 'msg': '新增成功'})
else:
return Response({'code': 102, 'msg': ser.errors})
class BookDetailView(APIView):
# 获取单个图书接口
def get(self, request, pk):
book = Book.objects.filter(pk=pk).first()
ser = BookModelSerializer(instance=book)
return Response(ser.data)
# 修改图书接口
def put(self, request, pk):
book = Book.objects.filter(pk=pk).first() # 根据pk取到book对象
ser = BookModelSerializer(instance=book, data=request.data) # 使用data数据修改book对象
if ser.is_valid(): # 校验前端传入的数据 虽然没写校验规则，但是流程还在
ser.save() # 调用save会触发BookSerializer的save方法，判断了，如果instance有值执行update，没有值执行create
return Response(ser.data) # 校验成功返回数据
else:
return Response(ser.errors) # 否则返回错误信息
# 删除图书接口
def delete(self, request, pk):
Book.objects.filter(pk=pk).delete()
return Response()
效果展示
查看所有图书接口
查看单本图书接口
新增图书接口
后台数据库
删除图书接口
后台数据库
修改图书接口
后台数据库
浙公网安备 33010602011771号