DRF中有serializer的类,我们可以从rest_framework进行导入。
from rest_framework import serializers
我们自定义的序列化器必须继承自 rest_framework.serializers.Serializer
现在假如我们有一个模型类,如下:
class BookInfo(models.Model):
"""书籍信息模型"""
name = models.CharField(max_length=20, verbose_name='名称') #图书名称
pub_date = models.DateField(verbose_name='发布日期') #发布日期
readcount = models.IntegerField(default=0, verbose_name='阅读量') #阅读量
commentcount = models.IntegerField(default=0, verbose_name='评论量') #评论量
class Meta:
db_table = 'bookinfo' # 指明数据库表名
verbose_name = '图书' # 在admin站点中显示的名称
verbose_name_plural = verbose_name # 显示的复数名称
def __str__(self):
"""定义每个数据对象的显示信息"""
return self.name
现在,我们需要给上面的模型类定义一个序列化器。那么序列化器应当如下:
class BookInfoSerializer(serializers.Serializer):
"""BookInfo序列化器"""
id = serializers.IntegerField(label='ID')
name = serializers.CharField(label='名称')
pub_date = serializers.DateField(label='发布日期')
readcount = serializers.IntegerField(label='阅读量')
commentcount = serializers.IntegerField(label='评论量')
即序列化器中的字段名称和字段类型要和模型类中的保持一致
通常,我们会将序列化器单独放入一个python文件中,例如本文放在了book这个APP下面的serializers.py文件中。
由于DRF提供的序列化器是一个类,我们得继承这个类来定义自己的序列化器,因此我们需要实例化序列化器来达到使用它的目的。 Serializer的构造方法为:
Serializer(instance=None, data=empty, **kwarg)
instance是序列化时传入的模型类对象;
data是反序列化时传入的数据;
kwarg是字典参数,包括write_only,read_only,many等参数。
现在,我们在views中定义一个视图类,如下:
class BookView(View):
def get(self, request, *args, **kwargs):
book_id = request.GET.get('id')
obj = BookInfo.objects.get(id=book_id)
data = BookInfoSerializer(obj).data # 序列化并获取数据
return JsonResponse(data)
url如下:
http://127.0.0.1:8000/book?id=1 # 查询id为1的书籍信息
查询结果如下所示:
通过data属性获取序列化之后的数据。如果需要获取多条数据,需要使用参数many=True。现在,我们需要获取所有的书籍书籍,更改视图类中的get方法如下:
class BookView(View):
def get(self, request, *args, **kwargs):
book_id = request.GET.get('id', '')
if book_id: # 前端如果传入id,那么查询一条数据
obj = BookInfo.objects.get(id=book_id)
data = BookInfoSerializer(obj).data
return JsonResponse(data)
else: # 前端如果没有传入id,那么返回所有数据
objs = BookInfo.objects.all()
data = BookInfoSerializer(objs, many=True).data # 获取多条数据
return JsonResponse(data, safe=False)
使用如下的URL进行请求:
http://127.0.0.1:8000/book
返回结果如下所示:
is_valid()方法
这个方法主要是验证序列化器中定义字段的时候数据类型,数据长度,字段选项,数据是否齐全等。下面先给出常用的字段,参数,选项表。
常用的字段类型表
字段 | 字段构造方式 |
---|---|
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=) |
常用参数表
参数名称 | 说明 |
---|---|
read_only | 表明该字段仅用于序列化输出,默认False |
write_only | 表明该字段仅用于反序列化输入,默认False |
required | 表明该字段在反序列化时必须输入,默认True |
default | 反序列化时使用的默认值 |
label | 用于HTML展示API页面时,显示的字段名称 |
选项参数表
参数名称 | 作用 |
---|---|
max_length | 最大长度 |
min_lenght | 最小长度 |
allow_blank | 是否允许为空 |
max_value | 最大值 |
min_value | 最小值 |
is_valid()方法验证字段的序列化器属性。例如,max_length, min_value, 字段类型。
验证成功,返回True,否则返回False。 验证失败返回的错误信息存放在errors属性中,验证成功可以通过序列化器的validated_data属性获取数据。
验证成功后,我们可以通过validated_data属性获取数据,拿到数据以后,可以通过在序列化器中实现create()和update()两个方法来完成新增和修改操作。
create()和update()方法会被save()方法调用。save()方法会根据创建序列化器对象的时候,有没有传递instance实例,来分别调用create和update。当传递了instance,save()就会调用update,没有传递instance,save()就会调用create.
下面,我们为了验证is_valid()方法以及保存操作。将序列化器修改为如下:
class BookInfoSerializer(serializers.Serializer):
"""BookInfo序列化器"""
id = serializers.IntegerField(label='ID', read_only=True) # 只序列化
name = serializers.CharField(label='名称', max_length=10) # 书籍名称最多10字符
pub_date = serializers.DateField(label='发布日期')
readcount = serializers.IntegerField(label='阅读量', min_value=0, required=False) # 最小值0,不是必传参数
commentcount = serializers.IntegerField(label='评论量', min_value=0, required=False) # 最小值0,不是必传参数
def create(self, validated_data):
"""序列化器对象的save()方法会调用create"""
# 使用ORM的create()方法向数据库增加一条数据
return BookInfo.objects.create(**validated_data)
def update(self, instance, validated_data):
"""序列化器对象的save()方法会调用update"""
instance.name = validated_data.get('name', instance.name) # 如果前端没有传递这个书籍,那么就获取原来的值
instance.pub_date = validated_data.get('pub_date', instance.pub_date)
instance.save()
return instance
我们已经实现了create和update,下面只需要在views中实现BookView中的相关函数即可。
class BookView(View):
"""书籍视图"""
def get(self, request, *args, **kwargs):
"""查询一个或者整个列表"""
book_id = request.GET.get('id', '')
if book_id: # 前端如果传入id,那么查询一条数据
try:
obj = BookInfo.objects.get(id=book_id)
except BookInfo.DoesNotExist:
return JsonResponse({}, status=404)
else:
data = BookInfoSerializer(obj).data
return JsonResponse(data)
else: # 前端如果没有传入id,那么返回所有数据
objs = BookInfo.objects.all()
data = BookInfoSerializer(objs, many=True).data
return JsonResponse(data, safe=False)
def post(self, request, *args, **kwargs):
"""新增书籍"""
json_data = json.loads(request.body)
pub_date = json_data.get('pub_date')
name = json_data.get('name')
# 反序列化
obj = BookInfoSerializer(data={"name":name, "pub_date": pub_date, "readcount": 0, "commentcount": 0})
# 使用is_valid()进行验证
if obj.is_valid():
# 使用save进行保存
obj.save()
return JsonResponse(obj.data)
else:
# 序列化器对象的errors属性获取字典形式的错误信息
return JsonResponse(data=obj.errors, status=400)
def put(self, request, *args, **kwargs):
"""修改书籍信息"""
book_id = request.GET.get('id')
json_data = json.loads(request.body)
pub_date = json_data.get('pub_date')
name = json_data.get('name')
try:
obj = BookInfo.objects.get(id=book_id)
except BookInfo.DoesNotExist:
return JsonResponse({}, status=404)
else:
ser = BookInfoSerializer(instance=obj, data={"name": name, "pub_date": pub_date})
if ser.is_valid():
# 使用save进行保存
ser.save()
return JsonResponse(ser.data)
else:
# 序列化器对象的errors属性获取字典形式的错误信息
return JsonResponse(data=ser.errors, status=400)
def delete(self, request, *args, **kwargs):
"""删除一本书籍,删除和序列化器没有关系"""
id = request.GET.get('id')
try:
obj = BookInfo.objects.get(id=id)
except:
return JsonResponse({}, status=404)
else:
obj.delete()
return JsonResponse({},status=204)
查询一个
查询不到
查询所有
新增成功
新增失败
修改
删除
扫码关注腾讯云开发者
领取腾讯云代金券
Copyright © 2013 - 2025 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号:粤B2-20090059 深公网安备号 44030502008569
腾讯云计算(北京)有限责任公司 京ICP证150476号 | 京ICP备11018762号 | 京公网安备号11010802020287
Copyright © 2013 - 2025 Tencent Cloud.
All Rights Reserved. 腾讯云 版权所有