在Django开发REST接口时,视图中主要有3件事:
1.将请求的数据(如JSON格式)转换为模型类对象
2.操作数据库
3.将模型类对象转换为响应的数据(如JSON格式)
由于在开发REST API时,视图中要频繁的进行序列化与反序列化的编写,这时候就用到了Django REST framework简化代码的编写
序列化(Serialization):在计算机科学的资料处理中,将数据结构或物件状态转换成可取用格式(例如存成档案,存于缓冲,或经由网络中传送),以留待后续在相同或另一台计算机环境中,能恢复原先状态的过程。依照序列化格式重新获取字节的结果时,可以利用它来产生与原始物件相同语义的副本。
在python中,序列化可以理解为将python对象编码转换为json格式的字符串
反序列化可以理解为将json字符串解码为python数据对象
Django REST framework简介:一个拥有构建Web API的的框架,简称DRF或REST framework
- 在序列化与反序列化时,虽然操作的数据不尽相同,但是执行的过程却是相似的,也就是说这部分代码是可以复用简化编写的。
- 在开发REST API的视图中,虽然每个视图具体操作的数据不同,但增、删、改、查的实现流程基本套路化,所以这部分代码也是可以复用简化编写的:
- 增:校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
- 删:判断要删除的数据是否存在 -> 执行数据库删除
- 改:判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
- 查:查询数据库 -> 将数据序列化并返回
Django REST framework特点:
- 提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;
- 提供了丰富的类视图、Mixin扩展类,简化视图的编写;
- 丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;
- 多种身份认证和权限认证方式的支持;
- 内置了限流系统;
- 直观的 API web 界面;
- 可扩展性,插件丰富
Django REST framework参考文献:https://yiyibooks.cn/keltoy/restframework/index.html
Django REST framework的使用:
1.安装:
pip install djangorestframework
2.在配置中添加rest_framework应用:
INSTALLED_APPS = [
...
'rest_framework',
]
#数据库配置我这里用的是mysql
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'demo1',
'HOST': 'localhost',
'USER': 'root',
'PASSWORD': 'mysql',
'PORT': '3306' }
}
3.创建序列化器:在应用中创建Serializer.py文件
from .models import *
from rest_framework import serializers
class HeroInfoModelSerializer(serializers.ModelSerializer):
hbook_id = serializers.IntegerField()
class Meta:
model = HeroInfo # 指定要序列化的模型
# 指定要序列化的字段
fields = ['id', 'hname', 'hcomment', 'hgender', 'hbook_id']
- model 指明该序列化器处理的数据字段从模型类BookInfo参考生成
- fields 指明该序列化器包含模型类中的哪些字段,'__all__'指明包含所有字段
4.编写视图view.py
class HerosView(ModelViewSet):
# 指定查询语句
queryset = HeroInfo.objects.all()# 制定序列化器类型
serializer_class = HeroInfoModelSerializer
- queryset 指明该视图集在查询数据时使用的查询集
- serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
5.定义路由urls.py
from rest_framework.routers import SimpleRouter, DefaultRouter
# 创建路由对象
router = DefaultRouter() # 默认页面 SimpleRouter()报404
# 注册路由规则
router.register('heros', views.HeroView3)
# 将规则路由加入到列表中
urlpatterns += router.urls
6.运行测试
运行当前程序(与django一样),用postman进行测试
python manage.py runserver
DRF中的序列化器
Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer。
例如有一个数据库模型类
# 定义图书模型类BookInfo
class BookInfo(models.Model):
btitle = models.CharField(max_length=20, verbose_name='名称')
bpub_date = models.DateField(verbose_name='发布日期')
bread = models.IntegerField(default=0, verbose_name='阅读量')
bcomment = models.IntegerField(default=0, verbose_name='评论量')
为该模型类提供一个序列化器
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)
2. 字段与选项
常用字段类型:
字段 | 字段构造方式 |
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) |
URLField | URLField(max_length=200, min_length=None, allow_blank=False) |
UUIDField | UUIDField(format='hex_verbose') format: 1) 2) 3) 4) |
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页面时,显示的字段帮助提示信息 |
3.创建Serializer对象
定义好Serializer类后,就可以创建Serializer对象了。
Serializer的构造方法为:
Serializer(instance=None, data=empty, **kwarg)
说明:
1)用于序列化时,将模型类对象传入instance参数
2)用于反序列化时,将要被反序列化的数据传入data参数
3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据,如
serializer = AccountSerializer(account, context={'request': request})
通过context参数附加的数据,可以通过Serializer对象的context属性获取。
序列化的使用
python manage.py shell
1.基本使用:
(1)先查询一个图书对象
from booktest.models import BookInfo
book = BookInfo.objects.get(id=2)
(2)构造序列化器对象
from booktest.serializers import BookInfoSerializer
serializer = BookInfoSerializer(book)
(3)获取序列化数据
serializer.data
通过data属性可以获取序列化后的数据,得到的数据是一个字典
如果要被序列化的是包含多条数据的查询集QuerySet,可以通过添加many=True参数补充说明
2.关联对象嵌套序列化:关联字段
PrimaryKeyRelatedField:关联对象的主键
hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True)
或
hbook = serializers.PrimaryKeyRelatedField(label='图书', queryset=BookInfo.objects.all())
指明字段时需要包含read_only=True或者queryset参数:
- 包含read_only=True参数时,该字段将不能用作反序列化使用
- 包含queryset参数时,将被用作反序列化时参数校验使用
StringRelatedField:字符串的表示方式(即_str_方法的返回值)
详细见文档:https://www.django-rest-framework.org/api-guide/relations/#stringrelatedfield
反序列化的使用:
1.验证:使用is_valid()方法,成功返回True,错误False
serializer.is_valid() # 返回False
若验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
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)
若验证成功,可以通过序列化器对象的validated_data属性获取数据。
# 验证方法一
# 验证一个属性,格式:validate_属性(self,value)
def validate_btitle(self, value):
# value 表示请求报文中相应属性的值
# value中要包含Django
if 'Django' not in value:
raise serializers.ValidationError('书名数必须包含Django')
# 如果条件满足,最后需要返回属性值
return value
# 验证方法二
# 验证多个属性,attrs:请求报文中所有的属性和值
def validate(self, attrs):
# 要求:阅读量大于评论量
bread = attrs.get('bread')
bcomment = attrs.get('bcomment')
# 判断他们俩是否存在
if all([bread, bcomment]):
if bread < bcomment:
raise serializers.ValidationError('阅读量必须大于评论量')
return attrs
3.保存
如果在验证成功后,想要基于validated_data完成数据对象的创建,可以通过实现create()和update()两个方法来实现。
# 保存
# 创建
def create(self, validated_data):
# validated_data-->验证通过后数据保存到字典中
# 获取验证后的数据
# btitle = validated_data.get('btitle')
# **validated_data-->**kwargs字典解包,*args列表解包
# book = BookInfo.objects.create(btitle = validated_data.get('btitle').....)
# 将数据保存到数据库中
book = BookInfo.objects.create(**validated_data)
return book
def update(self, instance, validated_data):
# instance:待修改的对象,
# validated_data-->验证通过后数据保存到字典中
# 给属性赋值
instance.btitle = validated_data.get('btitle')
instance.bpub_date = validated_data.get('bpub_date')
if validated_data.get('bread'):
instance.bread = validated_data.get('bread')
if validated_data.get('bcomment'):
instance.bcomment = validated_data.get('bcomment')
instance.save()
return instance
模型类序列化器ModelSerializer
如果我们想要使用序列化器对应的是Django的模型类,这里就可以使用DRF提供的ModelSerializer模型类序列化器
ModelSerializer与常规的Serializer相同,但提供了:
- 基于模型类自动生成一系列字段
- 基于模型类自动为Serializer生成validators,比如unique_together
- 包含默认的create()和update()的实现
class BookInfoSerializer(serializers.ModelSerializer):
class Meta:
model = BookInfo
fields = ('id', 'btitle', 'bpub_date')
exclude=("image")
使用fields来明确字段,_all_表名包含所有字段,exclude表名可以排除掉那些字段,read_only_fields指明只读字段
添加额外参数使用extra_kwargs
extra_kwargs = {
'bread': {'min_value': 0, 'required': True},
'bcomment': {'min_value': 0, 'required': True},
}