(2)DRF框架——序列化
1 序列化
1.1 定义序列化器
例如,我们已有了一个数据库模型类BookInfo
class BookInfo(models.Model): btitle = models.CharField(max_length=20, verbose_name='名称') bpub_date = models.DateField(verbose_name='发布日期', null=True) bread = models.IntegerField(default=0, verbose_name='阅读量') bcomment = models.IntegerField(default=0, verbose_name='评论量') image = models.ImageField(upload_to='booktest', verbose_name='图片', null=True)
我们想为这个模型类提供一个序列化器,在子应用中创建serializer.py 可以定义如下:
from rest_framework import serializers class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.CharField(label='名称', max_length=20) bpub_date = serializers.DateField(label='发布日期', required=False) bread = serializers.IntegerField(label='阅读量', required=False) bcomment = serializers.IntegerField(label='评论量', required=False) image = serializers.ImageField(label='图片', required=False)
注意:serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。
1.1.1 字段与选项
常用字段类型:
字段 | 字段构造方式 |
---|---|
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=<a_field_instance>, min_length=None, max_length=None) |
DictField | DictField(child=<a_field_instance>) |
选项参数:
参数名称 | 作用 |
---|---|
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页面时,显示的字段帮助提示信息 |
1.2 创建Serializer对象
Serializer的构造方法为:
Serializer(instance=None, data=empty, **kwarg)
说明:
1)用于序列化时,将模型类对象纳入实例参数
2)用于反序列化时,将要被反序列化的数据预定数据参数
3)除了实例和数据参数外,在构造Serializer对象时,还要通过上下文参数额外添加数据,如
serializer = AccountSerializer(account, context={'request': request})
通过context参数附加的数据,可以通过Serializer对象的context属性获取。
from django.views import View from .models import BookInfo from .serializer import BookSerializers from django.http import JsonResponse class BooksView(View): def get(self,request): #查询所有图书对象 books = BookInfo.objects.all() ser = BookSerializers(books,many=True)#需要加many=True return JsonResponse(ser.data,safe=False)#需要加safe=False class BookView(View): def get(self,request): #查询单一图书对象 book = BookInfo.objects.get(id= 1) ser = BookSerializers(book) return JsonResponse(ser.data)
1.2.1 对于关联字段,可以采用以下几种方式:
(1) PrimaryKeyRelatedField
此字段将被序列化为关联对象的主键。
hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True)
指明字段时需要包含read_only=True或者queryset参数:
- 包含read_only=True参数时,该字段将不能用作反序列化使用
使用效果:
from booktest.serializers import HeroInfoSerializer from booktest.models import HeroInfo hero = HeroInfo.objects.get(id=6) serializer = HeroInfoSerializer(hero) serializer.data
(2) StringRelatedField
此字段将被序列化为关联对象的字符串表示方式(即__str__方法的返回值)
hbook = serializers.StringRelatedField(label='图书')
(3)使用关联对象的序列化器
使用时 关联的序列化器必须定义在被关联的序列化器上面
2.反序列化
2.1. 验证
2.1.1字段选项验证
在定义序列化器时由选项参数和通用参数决定的
不指定选项参数 就不会进行验证 有可能会报错
btitle = serializers.CharField(max_length=20,min_length=5)#验证参数 bpub_date = serializers.DateField() bread = serializers.IntegerField() bcomment = serializers.IntegerField()
2.1.2 自定义方法验证
2.1.2.1 单一字段验证
class BookSerializers(serializers.Serializer): btitle = serializers.CharField(max_length=20,min_length=5) bpub_date = serializers.DateField() bread = serializers.IntegerField() bcomment = serializers.IntegerField() #单一字段验证 def validate_btitle(self,value):#这里的类方法名必须是validate_字段名 if value == '母猪的产后护理': raise serializers.ValidationError("书名不能是母猪的产后护理") return value
2.1.2.2 多个字段验证
class BookSerializers(serializers.Serializer): btitle = serializers.CharField(max_length=20,min_length=5) bpub_date = serializers.DateField() bread = serializers.IntegerField() bcomment = serializers.IntegerField() #多个字段验证 def validate(self, attrs): if attrs['bread'] > attrs['bcomment']: raise serializers.ValidationError("阅读量大于评论量") return attrs
2.1.3 在视图中验证
def post(self,request): #获取前端数据 data = request.body.decode() data_dic = json.loads(data) # 验证数据 ser = BookModelSerislzier(data=data_dic) if ser.is_valid(raise_exception=True):#is_valid调用验证方法 raise_exception=True表示有错误自动返回错误信息 #保存数据 print(ser.validated_data)# ser.validated_data获取验证后的字段数据 #返回结果 return JsonResponse(ser.errors)#ser.errors也可以查看错误信息
2.2. 保存更新(两者在视图中都是用save()方法)
2.2.1 保存
定义序列化器类时创建create方法
class BookSerializers(serializers.Serializer): btitle = serializers.CharField(max_length=20,min_length=5) bpub_date = serializers.DateField() bread = serializers.IntegerField() bcomment = serializers.IntegerField() def create(self, validated_data): #保存数据 book = BookInfo.objects.create(**validated_data) return book
视图中
class BooksView(View): def post(self,request): #获取前端数据 data = request.body.decode() data_dic = json.loads(data) # 验证数据 ser = BookSerializers(data=data_dic) ser.is_valid(raise_exception=True) #保存数据 ser.save() #返回结果 return JsonResponse(ser.errors)
2.2.2 更新
定义序列化器类时创建update方法
class BookSerializers(serializers.Serializer): btitle = serializers.CharField(max_length=20,min_length=5) bpub_date = serializers.DateField() bread = serializers.IntegerField() bcomment = serializers.IntegerField() def update(self, instance, validated_data): #更新数据 instance.btitle = validated_data['btitle'] instance.save() return instance
视图中使用
class BooksView(View): def put(self,request,pk): #获取前端数据 data = request.body.decode() data_dic = json.loads(data) # 验证数据 try: book =BookInfo.objects.get(id = pk) except: return JsonResponse({'error':'错误信息'},status=400) ser = BookSerializers(book,data=data_dic) ser.is_valid() #保存数据 ser.save() #返回结果 return JsonResponse(ser.data)
3 模型序列化器(ModelSerializer)
# 模型序列化器 默认包含了create方法 updata方法 class BookModelSerislzier(serializers.ModelSerializer): #显示指明字段 bread = serializers.IntegerField(max_value=100,min_value=20) class Meta: model = BookInfo #指定生成字段的模型类 # fields = ('btitle','bread') #自定义指定模型类中的字段 fields = '__all__'#选择全字段 # exclude = ('btitle') #反选字段 除了括号中的 # 批量指明字段 extra_kwargs = { 'bcomment':{ 'max_value':100, }, 'btitle':{ 'min_length':5 } }