DRF工程搭建Serializer序列化器

2019-05-17 本文已影响0人 ItBeacher

幽默再学习

1、男人逛街：缺什么逛什么；女人逛街：逛什么缺什么！

2、一个女孩她再好看，只要有双下巴，那。。。那也比其他有双下巴的女孩好看。

3、由于操作失误，给前任朋友圈点了个赞，不一会，他就发来消息：想不到你还关注着我，今天下午我有空，约吗？看完，我很感动，默默截图，发给了他的现女友。。

4、杯水车薪：一种收入高的表达。喝一杯水的功夫，薪水就足以买一辆车。头婚眼花：指头一次结婚缺少经验，眼花选错了人。“一见如故”就是一见钟情版的“我们做朋友吧！ ”

环境安装与配置

DRF需要以下依赖：

Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)

Django (1.10, 1.11, 2.0)

DRF是以Django扩展应用的方式提供的，所以我们可以直接利用已有的Django环境而无需从新创建。（若没有Django环境，需要先创建环境安装Django）

1. 安装DRF

pip install djangorestframework

2. 添加rest_framework应用

我们利用在Django框架学习中创建的demo工程，在settings.py的INSTALLED_APPS中添加'rest_framework'。

INSTALLED_APPS = [

...#表示省略

'rest_framework',

]

2.Serializer序列化器

序列化器的作用：

进行数据的校验

对数据对象进行转换

2.1定义Serializer

2.1.1. 定义方法

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='发布日期', null=True)

    bread = models.IntegerField(default=0, verbose_name='阅读量')

    bcomment = models.IntegerField(default=0, verbose_name='评论量')

    image = models.ImageField(upload_to='booktest', verbose_name='图片', null=True)

我们想为这个模型类提供一个序列化器，可以定义如下：

classBookInfoSerializer(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)

    image = serializers.ImageField(label='图片', required=False)

注意：serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。

2. 2字段与选项

2.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属性获取。

3序列化使用

我们在django shell中来学习序列化器的使用。

python manage.py shell

3.1 基本使用

1）先查询出一个图书对象

from booktest.models import BookInfo

book = BookInfo.objects.get(id=2)

2）构造序列化器对象

from booktest.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

3）获取序列化数据

通过data属性可以获取序列化后的数据

serializer.data

# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}

4）如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明

book_qs = BookInfo.objects.all()

serializer = BookInfoSerializer(book_qs, many=True)

serializer.data

# [OrderedDict([('id', 2), ('btitle', '天龙八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飞狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西游记'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]

3.2 关联对象嵌套序列化

如果需要序列化的数据中包含有其他关联对象，则对关联对象数据的序列化需要指明。

例如，在定义英雄数据的序列化器时，外键hbook（即所属的图书）字段如何序列化？

我们先定义HeroInfoSerialzier除外键字段外的其他部分

class HeroInfoSerializer(serializers.Serializer):

    """英雄数据序列化器"""

    GENDER_CHOICES = ( (0, 'male'), (1, 'female') )

    id = serializers.IntegerField(label='ID', read_only=True)

    hname = serializers.CharField(label='名字', max_length=20)

    hgender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性别', required=False)

    hcomment = serializers.CharField(label='描述信息', max_length=200, required=False, allow_null=True)

对于关联字段，可以采用以下几种方式：

1） PrimaryKeyRelatedField

此字段将被序列化为关联对象的主键。

hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True)

或

hbook = serializers.PrimaryKeyRelatedField(label='图书', queryset=BookInfo.objects.all())

指明字段时需要包含read_only=True或者queryset参数：

包含read_only=True参数时，该字段将不能用作反序列化使用

包含queryset参数时，将被用作反序列化时参数校验使用

使用效果：

from booktest.serializers import HeroInfoSerializer

from booktest.models import HeroInfo

hero = HeroInfo.objects.get(id=6)

serializer = HeroInfoSerializer(hero)

serializer.data

# {'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': 2}

2) StringRelatedField

此字段将被序列化为关联对象的字符串表示方式（即__str__方法的返回值）

hbook = serializers.StringRelatedField(label='图书')

使用效果

{'id':6,'hname':'乔峰','hgender':1,'hcomment':'降龙十八掌','hbook':'天龙八部'}

3）使用关联对象的序列化器

hbook = BookInfoSerializer()

使用效果

{'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': OrderedDict([('id', 2), ('btitle', '天龙八部')te', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', None)])}

3 many参数

如果关联的对象数据不是只有一个，而是包含多个数据，如想序列化图书BookInfo数据，每个BookInfo对象关联的英雄HeroInfo对象可能有多个，此时关联字段类型的指明仍可使用上述几种方式，只是在声明关联字段时，多补充一个many=True参数即可。

此处仅拿PrimaryKeyRelatedField类型来举例，其他相同。

在BookInfoSerializer中添加关联字段：

classBookInfoSerializer(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)

image = serializers.ImageField(label='图片', required=False)

heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)# 新增

使用效果：

from booktest.serializers import BookInfoSerializer

from booktest.models import BookInfo

book = BookInfo.objects.get(id=2)

serializer = BookInfoSerializer(book)

serializer.data

# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None, 'heroinfo_set': [6,8, 9]}

4反序列化使用

4.1. 验证

使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。

在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。

验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。

验证成功，可以通过序列化器对象的validated_data属性获取数据。

在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为。

如我们前面定义过的BookInfoSerializer

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)

image = serializers.ImageField(label='图片', required=False)

通过构造序列化器对象，并将要反序列化的数据传递给data构造参数，进而进行验证

from booktest.serializers import BookInfoSerializer

data = {'bpub_date':123}

serializer = BookInfoSerializer(data=data)

serializer.is_valid()

# 返回False

serializer.errors

# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}

serializer.validated_data

# {}data = {'btitle':'python'}serializer = BookInfoSerializer(data=data)

serializer.is_valid()

# True

serializer.error

s# {}serializer.validated_data# OrderedDict([('btitle', 'python')])

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_<field_name>

对<field_name>字段进行验证，如

classBookInfoSerializer(serializers.Serializer):

    """图书数据序列化器"""...defvalidate_btitle(self, value):

    if'django'notinvalue.lower():

        raise serializers.ValidationError("图书不是关于Django的")

    return value

测试

from booktest.serializers import BookInfoSerializer

data = {'btitle':'python'}

serializer = BookInfoSerializer(data=data)

serializer.is_valid()# False

serializer.errors

# {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

2）validate

在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证，如

class BookInfoSerializer(serializers.Serializer):

    """图书数据序列化器"""

    ...

    def validate(self, attrs):

        bread = attrs['bread']

bcomment = attrs['bcomment']

    if bread < bcomment:

        raiseserializers.ValidationError('阅读量小于评论量')

        return attrs

测试

from booktest.serializers import BookInfoSerializer

data = {'btitle':'about django','bread':10,'bcomment':20}

s = BookInfoSerializer(data=data)

s.is_valid()# Falses.errors# {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

3）validators

在字段中添加validators选项参数，也可以补充验证行为，如

defabout_django(value):

if'django'notinvalue.lower():

    raise serializers.ValidationError("图书不是关于Django的")

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='发布日期', required=False)

bread = serializers.IntegerField(label='阅读量', required=False)

bcomment = serializers.IntegerField(label='评论量', required=False)

image = serializers.ImageField(label='图片', required=False)

测试：

from booktest.serializers import BookInfoSerializer

data = {'btitle':'python'}

serializer = BookInfoSerializer(data=data)

serializer.is_valid()

# False

serializer.errors# {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

4.2. 保存

如果在验证成功后，想要基于validated_data完成数据对象的创建，可以通过实现create()和update()两个方法来实现。

class BookInfoSerializer(serializers.Serializer):

    """图书数据序列化器"""

    ...

    def create(self, validated_data):

        """新建"""

        return BookInfo(**validated_data)

    def update(self, instance, validated_data):

        """更新，instance为要更新的对象实例"""

        instance.btitle = validated_data.get('btitle', instance.btitle)

        instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)

        instance.bread = validated_data.get('bread', instance.bread)

        instance.bcomment = validated_data.get('bcomment', instance.bcomment)

        return instance

如果需要在返回数据对象的时候，也将数据保存到数据库中，则可以进行如下修改

class BookInfoSerializer(serializers.Serializer):

  """图书数据序列化器""" ...

  def create(self, validated_data):

  """新建"""

      return BookInfo.objects.create(**validated_data)

  def update(self, instance, validated_data):

      :"""更新，instance为要更新的对象实例"""

       instance.btitle = validated_data.get('btitle', instance.btitle)

      instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)

      instance.bread = validated_data.get('bread', instance.bread)

       instance.bcomment = validated_data.get('bcomment', instance.bcomment)

        instance.save()

return instance

实现了上述两个方法后，在反序列化数据的时候，就可以通过save()方法返回一个数据对象实例了

book = serializer.save()

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

from db.serializers import BookInfoSerializer

data = {'btitle':'封神演义'}

serializer = BookInfoSerializer(data=data)

serializer.is_valid()

# True

serializer.save()

# <BookInfo: 封神演义>

from db.models import BookInfo

book = BookInfo.objects.get(id=2)

data = {'btitle':'倚天剑'}

serializer = BookInfoSerializer(book, data=data)

serializer.is_valid()

# True

serializer.save()# <BookInfo: 倚天剑>book.btitle# '倚天剑'

两点说明：

1）在对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到

serializer.save(owner=request.user)

2）默认序列化器必须传递所有required的字段，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新

# Update `comment` with partial dataserializer = CommentSerializer(comment, data={'content':u'foo bar'}, partial=True)