-drf-序列化组件-Serializer
一 序列化器的作用
- 序列化，序列化器会把模型对象转换成字典，经过response以后变成json字符串
- 反序列化，把客户端发送过来的数据，经过request以后变成字典，序列化器可以把字典转成模型
- 反序列化，完成数据校验工作
二 定义序列化器
Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。
写一个数据库类型
from django.db import models
class Book(models.Model):
name = models.CharField(max_length=32)
price = models.DecimalField(max_digits=6, decimal_places=2)
publish = models.CharField(max_length=32)
book_detail = models.OneToOneField(to='BooKDetail', on_delete=models.CASCADE, null=True)
class BooKDetail(models.Model):
content = models.TextField()
create_time = models.DateTimeField(auto_now_add=True)
为这个模型类提供一个序列化器，先创建一个serializer的py文件
from rest_framework import serializers
# 声明序列器，所有的序列化器都要直接或者间接的继承于Serializer
class BookSerializer(serializers.Serializer):
# 需要进行序列化转化的字段
id = serializers.IntegerField()
name = serializers.CharField(max_length=32)
price = serializers.DecimalField(max_digits=6, decimal_places=2)
publish = serializers.CharField(max_length=32)
注意：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页面时，显示的字段帮助提示信息 |
三 创建Serializer对象
定义好serializer，就可以创建serializer对象了。
serializer的构造方法为：
Serializer(instance=None, data=empty, **kwarg)
说明：
-
用于序列化时，将模型类对象传入instance参数
-
用于反序列化，将要被反序列化的数据传入data参数
-
除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如
serializer = AccountSerializer(account, context={'request': request})通过context参数附加的数据，可以通过Serializer对象的context属性获取。
注意：
- 使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
- 序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来
- 序列化器的字段声明类似于我们前面使用过的表单系统
- 开发restful api时，序列化器会帮我们把模型数据转换成字典
- drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典
四 序列化器的使用
序列化器的使用分为两个阶段：
- 在客户端请求时，使用序列化器可以完成对数据的反序列化
- 在服务端响应式，使用序列化器可以完成对数据的序列化
1 序列化
class Book(APIView):
def get(self, request):
# 假设请求时获取Book中的一个对象
book_obj = models.Book.objects.get(pk=1)
# 构造序列化器对象
ser = BookSerializer(instance=book_obj)
print(ser)
# 通过data属性得到序列化后的数据
print(ser.data)
return Response(ser.data)
如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明
from django.shortcuts import render
# Create your views here.
from app10 import models
from app10.serializer import BookSerializer
from rest_framework.views import APIView, Response
from django.http.response import JsonResponse
class Book(APIView):
def get(self, request):
# 假设请求时获取Book中的一个对象
book_all = models.Book.objects.all()
# 构造序列化器对象,如果转换多个模型对象数据，则需要加上many=True
ser = BookSerializer(instance=book_all, many=True)
print(ser)
# 通过data属性得到序列化后的数据
print(ser.data)
# 返回json数据，如果是列表，则需要声明safe=False
return JsonResponse(ser.data, safe=False)
2 反序列化
数据验证
使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。
在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。
验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功，可以通过序列化器对象的validated_data属性获取数据。
在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为。
def post(self, request):
ser = BookSerializer(data=request.data)
ser.is_valid()
return Response(ser.error_messages)
# 字段校验的报错信息
is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError，可以通过传递raise_exception=True参数开启，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。
# Return a 400 response if the data was invalid.
serializer.is_valid(raise_exception=True)
如果需要再补充定义验证行为，可以使用以下三种方法：
1) validate_字段名
def validate_name(self, attrs):
# attrs指的是传进来的该对象的该字段下的记录
if attrs.startswith('sb'):
raise ValidationError('不能以sb开头')
else:
return attrs
2) validate
在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证，如:
def validate(self, attrs):
# attrs为该对象的所有数据
name = attrs.get('name')
publish = attrs.get('publish')
if name == publish:
raise ValidationError('书名不能与出版社同名')
else:
return attrs
3) validators
在字段中添加validators选项参数，也可以补充验证行为，如:
def about_price(value):
if value <= 12:
raise serializers.ValidationError('定价要大于12')
# 声明序列器，所有的序列化器都要直接或者间接的继承于Serializer
class BookSerializer(serializers.Serializer):
id = serializers.IntegerField()
name = serializers.CharField(max_length=32)
price = serializers.DecimalField(max_digits=6, decimal_places=2,validators=[about_price])
publish = serializers.CharField(max_length=32)
测试：
def post(self, request):
print(request.data)
ser = BookSerializer(data=request.data)
ser.is_valid()
print(ser.errors)
return Response(ser.errors)
# {'name': [ErrorDetail(string='不能以sb开头', code='invalid')], 'price': [ErrorDetail(string='定价要大于12', code='invalid')]}
# 先校验局部再校验全局，如果局部出错，全局直接不用校验，那也就没有了报错信息
# 所以全局报错信息出来的前提是局部以及字段校验正确
# {'price': [ErrorDetail(string='定价要大于12', code='invalid')]}
保存数据
前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.
def post(self, request):
print(request.data)
ser = BookSerializer(data=request.data)
if ser.is_valid():
# ser.save() serializer实际上与ORM框架无关
# 手动保存
# ser.save()
dic = request.data
models.Book.objects.create(name=dic['name'], price=dic['price'], publish=dic['publish'])
return Response('保存成功')
else:
return Response(ser.errors)
在serializer中写上方法去调用models进行数据保存也可
# views.py
# 此方法操作为保存写入
def post(self, request):
ser = BookSerializer(data=request.data)
if ser.is_valid():
ser.save()
return Response('保存成功')
else:
return Response('保存失败')
# serializer.py
def create(self, validated_data):
obj = models.Book.objects.create(**validated_data)
return obj
更新操作
# views.py
# 此方法为更新
def put(self, request, id):
print(id)
res = {'code': 100, 'msg': ''}
try:
book = models.Book.objects.get(id=id)
print(book)
# 实例化一个serializer对象
# 传入book对象以及要更新的数据会自动调用其中的update的方法进行更新操作
ser = BookSerializer(instance=book, data=request.data)
# 校验不合法就报错400
ser.is_valid(raise_exception=True)
# 调用save()方法会自动识别是更新还是保存操作
# 同时具有instance和data则是更新操作，只有data则是保存操作
ser.save()
res['msg'] = '修改成功'
res['result'] = ser.data # 序列化传出
except Exception as e:
print(e)
res['code'] = 101
res['msg'] = str(e)
return Response(res)
# serializer.py
def update(self, book, validated_data):
book.title = validated_data.get('title')
book.price = validated_data.get('price')
book.publish = validated_data.get('publish')
# 此save进行的是保存新数据的操作，外面的save进行的是调用update的操作
book.save()
return book
删除操作
def delete(self, request, id):
res = {'code': 100, 'msg': '删除成功'}
obj = models.Book.objects.filter(id=id).first()
if obj:
obj.delete()
else:
res['code'] = 101
res['msg'] = '用户不存在，操作失败'
return Response(res)
附加说明
1） 在对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到
# request.user 是django中记录当前登录用户的模型对象
serializer.save(owner=request.user)
2）默认序列化器必须传递所有required的字段，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新
# Update `comment` with partial data
serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)
read_only和write_only
read_only 表明该字段仅用于序列化输出，默认False
write_only 表明该字段仅用于反序列化输入，默认False
class BookSerializer(serializers.Serializer):
# 要序列化哪个字段
id = serializers.IntegerField(required=False)
# id=serializers.CharField()
title = serializers.CharField(max_length=32,min_length=2,read_only=True)
price = serializers.DecimalField(max_digits=5, decimal_places=2)
# 序列化的时候看不到
publish = serializers.CharField(max_length=32,validators=[check,],write_only=True)
高级用法之source
1 修改返回到前端的字段名
# source=title 字段名就不能再叫title
name = serializers.CharField(max_length=32,min_length=2,source='title')
2 如果表模型中有方法
# 执行表模型中的test方法，并且把返回值赋值给xxx
xxx=serializers.CharField(source='test')
3 sourc支持跨表操作
addr=serializers.CharField(source='publish.addr')
'''
source会自动识别字符串中是字段名或调用方法或跨表操作
注意source不能和字段名重复
'''
五 模型类序列化器
如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
ModelSerializer与常规的Serializer相同，但提供了：
- 基于模型类自动生成一系列字段
- 基于模型类自动为Serializer生成validators，比如unique_together
- 包含默认的create()和update()的实现
创建一个BookModelSerializer
from app10 import models
# 与models有关的有序列器
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
model = models.Book # 跟那个表类型建立关系
fields = '__all__'
'''
fields=[字段，字段] # 序列化的字段，反序列化的字段
'''
exclude=[字段，字段] # 排除哪些字段（不能跟fields同时使用）
read_only_fields=['price','publish'] # 序列化显示的字段
write_only_fields=['title'] # 反序列化需要传入的字段
extra_kwargs ={'title':{'max_length':32,'write_only':True}}# 可以替代上面操作
depth=1 # 了解，跨表1查询，最多建议写3
# 重写某些字段
publish = serializers.CharField(max_length=32,source='publish.name')
# 局部钩子，全局钩子，跟原来完全一样
# 新增，修改
-统统不用重写create和update方法了，在ModelSerializer中重写了create和update
- model 指明参照哪个模型类
- fields 指明为模型类的哪些字段生成(_all_)直接获取所有字段
- exclude 可以明确排除掉哪些字段
- read_only_fields 指明只读字段，即仅用于序列化输出的字段
- extra_kwargs 参数为ModelSerializer添加或修改原有的选项参数
高级用法之SerializerMethodField
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
model = models.Book # 跟那个表类型建立关系
fields = '__all__'
depth = 1
publish = serializers.CharField(max_length=32, source='publish.name')
# post() got an unexpected keyword argument 'id'
# 存的时候报错，存的时候要id建立外键关联，结果用的是name
# =====================================================================
class BookSerializer(serializers.Serializer):
id = serializers.IntegerField(required=False)
name = serializers.CharField(max_length=32,min_length=2,source='title')
price = serializers.DecimalField(max_digits=5, decimal_places=2)
# 重写了publish，所以create方法是被继承的，那么子类引用到publish后，在父类调用create方法保存数据，则父类的publish引用不到前端传来的值，则为空
# 只能序列化进行读操作，写操作会报错，publish字段没被父类引用到为空的错误
# django.db.utils.IntegrityError: (1048, "Column 'publish_id' cannot be null")
publish = serializers.SerializerMethodField()
def get_publish(self,obj):
dic={'name':obj.publish.name,'addr':obj.publish.addr}
return dic
class BookModelSerializer(serializers.ModelSerializer):
class Meta:
model = models.Book
fields = '__all__'
publish = serializers.SerializerMethodField()
def get_publish(self,obj):
dic={'name':obj.publish.name,'addr':obj.publish.addr}
return dic
## 第三中方案，使用序列化类的嵌套
class PublishSerializer(serializers.ModelSerializer):
class Meta:
model = models.Publish
# fields = '__all__'
fields = ['name','addr']
class BookModelSerializer(serializers.ModelSerializer):
publish = PublishSerializer()
class Meta:
model = models.Book
fields = '__all__'
APIview源码分析
1 APIview的as_view
-内部还是执行了View的闭包函数view
-禁用掉了csrf
-一切皆对象，函数也是对象 函数地址.name=lqz
2 原生View类中过的as_view中的闭包函数view
-本质执行了self.dispatch(request, *args, **kwargs)，执行的是APIView的dispatch
3 APIView的dispatch
def dispatch(self, request, *args, **kwargs):
# DRF的Request类的对象，内部有request._request,是原生request
request = self.initialize_request(request, *args, **kwargs)
self.request = request
try:
self.initial(request, *args, **kwargs)
'''
#认证，权限，频率
self.perform_authentication(request)
self.check_permissions(request)
self.check_throttles(request)
'''
if request.method.lower() in self.http_method_names:
# 通过反射得到请求方式
handler = getattr(self, request.method.lower(),
self.http_method_not_allowed)
else:
handler = self.http_method_not_allowed
# 执行该函数，对应着视图层以请求方式命名的方法
response = handler(request, *args, **kwargs)
except Exception as exc:
# 全局的异常捕获
response = self.handle_exception(exc)
# 把视图函数(类)返回的response，又包装了一下
self.response = self.finalize_response(request, response, *args, **kwargs)
return self.response
'''
APIView中的request可以调用旧的_request,
是因为在新的request中重写__getatter__方法，
通过反射判断外部调用的是否是旧_request的方法，
如果是则返回该方法
'''
many=True源码分析，局部全局钩子源码解析
1 many=True
-__init__----->一路找到了BaseSerializer---》__new__决定了生成的对象是谁
2 入口是is_valid()---》BaseSerializer--》is_valid---》self._validated_data = self.run_validation(self.initial_data)
-Serializer这个类的：self.run_validation
def run_validation(self, data=empty):
value = self.to_internal_value(data) # 局部字段自己的校验和局部钩子校验
try:
self.run_validators(value)
value = self.validate(value) # 全局钩子的校验
except (ValidationError, DjangoValidationError) as exc:
raise ValidationError(detail=as_serializer_error(exc))
return value
