Django之DRF框架的使用

安装

pip install djangorestframework

在Django项目中使用DRF框架进行开发时，需要将rest_framework在INSTALLED_APPS中进行注册。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

定义serializer

基本形式：

# 模型类定义
from django.db import models

class 模型类名(models.Model):
  # 模型类字段 = models.字段类型(选项参数)
  # ...

# 序列化器类定义
from rest_framework import serializers

class 序列化器类名(serializers.Serializer):
    # 序列化器字段 = serializers.字段类型(选项参数)
    # ...

序列化操作

# 创建User对象
user = User(name='smart', age=18)

# 使用UserSerializer将user对象序列化为如下字段数据：{'name': 'smart', 'age': 18}
serializer = UserSerializer(user)

# 获取序列化之后的数据
serializer.data

反序列化操作-数据校验

# 准备数据
data = {'name': 'admin', 'age': 30}

# 使用UserSerializer对data中的数据进行反序列化校验
serializer = UserSerializer(data=data)

# 调用is_valid进行数据校验，成功返回True，失败返回False
serializer.is_valid()

# 获取校验失败之后的错误提示信息
serializer.errors

# 获取校验通过之后的数据
serializer.validated_data

常用字段类型：

字段	字段构造方式
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, minlength=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	序列化和反序列化时使用的默认值
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时，显示的字段名称

注：定义序列化器类的字段时，如果没有指定read_only和write_only，则这两个参数默认值都为False，表明对应的字段既在序列化时使用，也在反序列化时使用。

序列化操作

1. 序列化单个对象
   序列化单个对象obj时，在创建序列化器对象时，将obj传递给instance即可。

from booktest.models import BookInfo
from booktest.serializers import BookInfoSerializer
# 查询获取图书对象
book = BookInfo.objects.get(id=2)
# 创建序列化器对象
serializer = BookInfoSerializer(book)
# 获取序列化之后的数据
serializer.data
# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40}

2. 序列化多个对象
   如果要被序列化的是包含多个对象的查询集QuerySet或list，在创建序列化器对象时，需要添加many=True参数。

books = BookInfo.objects.all()
# 创建序列化器对象
serializer = BookInfoSerializer(books, many=True)
# 获取序列化之后的数据
serializer.data

3. 关联对象嵌套序列化
	1）PrimaryKeyRelatedField
将关联对象序列化为关联对象的主键。
	2）使用关联对象的序列化器
使用指定的序列化器类将关联对象进行序列化。
	3) StringRelatedField
将关联对象序列化为关联对象模型类__str__方法的返回值。
	4. many参数
如果和一个对象关联的对象有多个，在序列化器类中定义嵌套序列化字段时，需要多添加一个many=True参数。
总结：

序列化单个对象：创建序列化器对象时，将单个对象传递给instance即可
序列化多个对象：创建序列化器对象时，需要添加many=True参数
关联对象嵌套序列化
将关联对象序列化为关联对象的主键：PrimaryKeyRelatedField
使用指定的序列化器类将关联对象进行序列化
将关联对象序列化为关联对象模型类__str__方法的返回值：StringRelatedField
如果和被序列化对象关联的对象有多个，定义嵌套序列化字段时，需要添加many=True参数

反序列化操作

数据校验

基本使用

# 1. 创建序列化器对象
serializer = 序列化器类(data=<待校验字典数据>)

# 2. 数据校验：成功返回True，失败返回False
serializer.is_valid()

# 3. 获取校验成功之后的数据
serializer.validated_data

# 4. 如果校验失败，获取失败的错误提示信息
serializer.errors

补充验证
validators
针对指定序列化器字段添加validators选项参数补充校验，如：

def about_django(value):
    if 'django' not in value.lower():
        raise serializers.ValidationError("图书不是关于Django的")
    return value

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label='发布日期')
    bread = serializers.IntegerField(label='阅读量', required=False)
    bcomment = serializers.IntegerField(label='评论量', required=False)

validate_<field_name>
在序列化器类中定义特定方法validate_<field_name>，针对特定字段进行补充验证，如：

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise serializers.ValidationError("图书不是关于Django的")
        return value

validate
在序列化器类中定义validate方法针对多个字段的内容进行补充验证，如：

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def validate(self, attrs):
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if bread < bcomment:
            raise serializers.ValidationError('阅读量小于评论量')
        return attrs

数据保存

1）在数据校验通过之后，想要基于validated_data完成数据的保存，可以通过序列化器对象.save()进行数据的保存。

2）在save方法内部会调用序列化器类的create或update方法，可以在create方法中实现数据新增，update方法中实现数据更新。

3）创建序列化器对象的时候，如果没有传递instance实例，则调用save()方法的时候，create()被调用，相反，如果传递了instance实例，则调用save()方法的时候，update()被调用。

ModelSerializer

基本使用

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = '__all__'

指定字段

使用fields来指明依据模型类的哪些字段生成序列化器类的字段，__all__表明包含所有字段，也可以指明具体哪些字段，如：

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment')

使用exclude可以指明排除哪些字段，如：

class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        exclude = ('is_delete',)

添加和修改选项参数

可以使用extra_kwargs参数为自动生成的序列化器类字段添加或修改原有的选项参数。

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},
            'bpub_date': {'required': True}
        }

总结：

ModelSerializer使用
如果序列化器类对应的是Django的模型类，可以直接继承ModelSerializer
继承ModelSerializer之后，可以依据模型类字段自动生成序列化器的字段
ModelSerializer中已经实现了create和update方法