rest-framework序列化组件
1序列化组件介绍
1.1 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
1.2 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
1.3 反序列化,完成数据校验功能
2.序列化组件的简单使用
2.1 先写一个序列化类，继承Serializer
2.2 在类中要写序列化的字段（使用source方法可以和数据库字段不同，默认相同，如果没加source参数和数据库中字段不同会报错），想序列化哪个字段，就在类中写哪个字段
2.3 在视图类中使用，导入序列化类实例化得到对象，把要序列化的对象传入
2.4 序列化的对象.data 是一个字典
2.5 把字典返回，可以使用django内置的JsonResponse返回或使用Response返回
点击查看代码
# ser.py
class BookSerializer(serializers.Serializer):
# id=serializers.CharField()
name=serializers.CharField()
# price=serializers.DecimalField()
price=serializers.CharField()
author=serializers.CharField()
publish=serializers.CharField()
# views.py
class BookView(APIView):
def get(self,request,pk):
book=Book.objects.filter(id=pk).first()
#用一个类，毫无疑问，一定要实例化
#要序列化谁，就把谁传过来
book_ser=BookSerializer(book) # 调用类的__init__
# book_ser.data 序列化对象.data就是序列化后的字典
return Response(book_ser.data)
# urls.py
re_path('books/(?P<pk>\d+)', views.BookView.as_view()),
3序列化类的常用字段类型及字段选项
| 字段 | 字段构造方式 |
| 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(max_length=50,,min_length=None,allow_blank=False) |
| URLField | URLField(max_length=None,min_length=None,allow_blank=False) |
| UUIDField | UUIDField(format='hex_verbose') |
| IPAddressField | IPAddressField(protocol='both',unpack_ipv4=False,**options) |
| IntegerField | IntegerField(max_length=None,min_length=None) |
| FloatField | FloatField(max_length=None,min_length=None) |
| DecimalField | DecimalField(max_digits,decinal_places,coerce_to_string=None,max_length=None,min_length=None) max_digits:最多位数； decinal_places：小数点位置 |
| DateTimeField | DateTimeField(format=api_settings.DATETIME_FORMAT,input_formats=None) |
| DateField | DateField(format=api_settings.DATETIME_FORMAT,input_formats=None) |
| TimeField | TimeField(format=api_settings.DATETIME_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_URL) |
| ImageField | ImageField(max_length=None,allow_empty_file=False,use_url=UPLOADED_FILES_URL) |
| ListField | ListField(child=,max_length=None,min_length=None) DictField DictField(child=) |
选项参数
| 参数名称 | 作用 |
| max_length | 最大长度 |
| min_length | 最小长度 |
| allow_blank | 是否允许为空 |
| trim_whitespace | 是否截断空白字符 |
| max_value | 最大值 |
| min_value | 最大值 |
通用参数
| 参数名称 | 说明 |
| read_only | 表明该字段仅用于序列化输出，默认为False |
| write_only | 表明该字段仅用于反序列化输入，默认为False |
| required | 表明该字段在反序列化时必须输入，默认为True |
| default | 反序列化时使用的默认值 |
| allow_null | 表明该字段是否允许传入None，默认False |
| validators | 该字段使用的验证器 |
| error_message | 包含错误编号与错误信息的字典 |
| label | 用于HTML展示API页面时，显示的字段名称 |
| help_text | 用于HTML展示API页面时，显示的字段帮助提示信息 |
4局部钩子和全局钩子
通过rest_framework内置的校验规则有时候很难满足我们的需求，所以rest_framework框架给我们提供了局部和全局钩子来自定义校验规则
5 序列化组件对数据的增删改查
5.1数据的查和增
5.2数据的改和删
6模型类序列化器
如果我们想使用序列化器对应的Django类模型，DRF为我们提供了ModelSerializer模型序列化器来帮助我们快速创建一个Serializer类
ModelSerializer与常规的Serializer相同
- 基于模型类自动生成一系列字段
- 基于模型类自动为Serializer生成validators，比如unique_together
- 包含默认的create()和update()的实现，不需要我们自己写
6.1 定义
比如我们创建一个BookModelSerializer：
点击查看代码
class BookModelSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = Book # model中对应的类
fields = '__all__' # 所有字段
6.2 指定字段
点击查看代码
1) 使用fields来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，如
class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
fields = ('id', 'btitle', 'bpub_date')
2) 使用exclude可以明确排除掉哪些字段
class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
exclude = ('image',)
3) 显示指明字段，如：
class HeroInfoSerializer(serializers.ModelSerializer):
hbook = BookInfoSerializer()
class Meta:
model = HeroInfo
fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')
6.3 添加额外参数
点击查看代码
3. 添加额外参数
我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数
class BookInfoSerializer(serializers.ModelSerializer):
"""图书数据序列化器"""
class Meta:
model = BookInfo
fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment')
extra_kwargs = {
'bread': {'min_value': 0, 'required': True},
'bcomment': {'min_value': 0, 'required': True},
# 7 serializer的高级用法
点击查看代码
# source的使用
1 可以改字段名字 xxx=serializers.CharField(source='title')
2 可以.跨表publish=serializers.CharField(source='publish.email')
3 可以执行方法pub_date=serializers.CharField(source='test') test是Book表模型中的方法
# SerializerMethodField(）的使用
1 它需要有个配套方法，方法名叫get_字段名，返回值就是要显示的东西
authors=serializers.SerializerMethodField() #它需要有个配套方法，方法名叫get_字段名，返回值就是要显示的东西
def get_authors(self,instance):
# book对象
authors=instance.authors.all() # 取出所有作者
ll=[]
for author in authors:
ll.append({'name':author.name,'age':author.age})
return ll #返回的内容
浙公网安备 33010602011771号