1. 技术文章
  2. DRF框架之ModelSerializer序列化器

DRF框架之ModelSerializer序列化器

由 谁说我不能喝 提交于 2020-02-07 20:08:58

ModelSerializer是Serializer的子类，序列化和反序列化跟Serializer一样。

ModelSerializer与常规的Serializer相同，但提供了：

  • 基于模型类自动生成一系列字段
  • 基于模型类自动为Serializer生成validators，比如unique_together
  • 包含默认的create()和update()的实现

在使用ModelSerializer序列化器时，我们只需要定义好序列化器类，并指定好对应的模型类和字段即可。

例如：

# 定义ModelSerializers序列化器
class BookInfoModelSerializer(serializers.ModelSerializer):
    '''定义图书信息的ModelSerializers序列化器'''

    class Meta:
        # 指定序列化器对应的模型类
        # model = 模型类名
        model = BookInfo

        # 指定序列化和反序列化操作的字段
        fields = '__all__' # __all__表示所有字段进行序列化

Shell测试代码：

>>> from booktest.serializers import BookInfoModelSerializer  
>>> s = BookInfoModelSerializer()
>>> s
BookInfoModelSerializer():
    id = IntegerField(label='ID', read_only=True)
    btitle = CharField(label='名称', max_length=20)
    bpub_date = DateField(label='发布日期')
    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)
    is_delete = BooleanField(label='逻辑删除', required=False)

通过，测试代码，我们可以发现，ModelSerializer序列化器自动帮我们定义好了字段信息及约束信息。

 体验过，ModelSerializer序列化器的简便性后，我们便开始正式的学习了。

1. 创建ModelSerializer序列化器类

1.1 对模型类中所有字段都进行序列化和反序列化操作。

我们通过设置Meta类中的fields属性的值可以指定序列化器能够操作的字段数据。
当fields='__all__'时，表示序列化器能够对模型类中的所有字段数据进行序列化与反序列化的操作。

# 定义ModelSerializers序列化器
class BookInfoModelSerializer(serializers.ModelSerializer):
    '''定义图书信息的ModelSerializers序列化器'''

    class Meta:
        # 指定序列化器对应的模型类
        # model = 模型类名
        model = BookInfo

        # 对全部字段进行序列化和反序列化操作
        fields = '__all__' # __all__表示所有字段进行序列化

shell测试代码：

我们可以通过Shell代码看到能够进行序列化和反序列化操作的字段，并且能够发现，ModelSerializer序列化器已经自动地为我们创建好了模型字段和约束条件。

>>> from booktest.serializers import BookInfoModelSerializer 
>>> s = BookInfoModelSerializer()
>>> s
BookInfoModelSerializer():
    id = IntegerField(label='ID', read_only=True)
    btitle = CharField(label='名称', max_length=20)
    bpub_date = DateField(label='发布日期')
    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)
    is_delete = BooleanField(label='逻辑删除', required=False)

1.2 对模型类中特定的字段进行序列化和反序列化操作。

当fields = (‘字段1’,...)时，表示当前的序列化器只能对元组中的字段进行序列化与反序列化操作。

class BookInfoModelSerializer(serializers.ModelSerializer):
    '''ModelSerializers序列化器'''

    class Meta:
        # 指定序列化器对应的模型类
        model = BookInfo

        # 对指定字段进行序列化和反序列化操作
        fields = ('bread','btitle','bcomment')

Shell测试代码：

>>> from booktest.serializers import BookInfoModelSerializer                
>>> s = BookInfoModelSerializer()
>>> s
BookInfoModelSerializer():
    btitle = CharField(label='名称', max_length=20)
    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)

1.3 指定模型类中不能被序列化和反序列化的字段。

在Meta类中，我们也可以通过指定exclude属性的值，来设置不能够被当前序列化器进行序列化与反序列化的字段数据。

class BookInfoModelSerializer(serializers.ModelSerializer):
    '''ModelSerializers序列化器'''

    class Meta:
        # 指定序列化器对应的模型类
        model = BookInfo

        # 指定不进行序列化和反序列化操作的字段
        exclude = ('id', )

Shell测试代码：

>>> from booktest.serializers import BookInfoModelSerializer   
>>> s = BookInfoModelSerializer()
>>> s
BookInfoModelSerializer():
    btitle = CharField(label='名称', max_length=20)
    bpub_date = DateField(label='发布日期')
    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)
    is_delete = BooleanField(label='逻辑删除', required=False)

我们可以发现，通过exclude属性指定的字段，并没有被创建出来，也就是说明无法被序列化器进行操作。

1.4 指定关联字段

因为ModelSerializer序列化器时Serializer的子类，所以Serializer序列化能够进行的事ModelSerializer序列化器也能够进行。

在ModelSerializer序列化器中，我们也需要追加关联字段来实现关联序列化操作，并且关联方式与Serializer序列化器一致。

这里，我就只举一个多对一关联的例子，大家了解即可。

class HeroInfoModelSerializer(serializers.ModelSerializer):
    '''定义查询Hero信息的ModeleSerializer序列化器'''

    # 添加关联字段（多对一）
    hbook = BookInfoModelSerializer()

    class Meta:
        # 指定模型类
        model = HeroInfo
        # 指定字段
        fields = ('id', 'hname', 'hbook')

Shell测试代码：

>>> from booktest.serializers import HeroInfoModelSerializer 
>>> s = HeroInfoModelSerializer()
>>> s
HeroInfoModelSerializer():
    id = IntegerField(label='ID', read_only=True)
    hname = CharField(label='名称', max_length=20)
    hbook = BookInfoModelSerializer():
        id = IntegerField(label='ID', read_only=True)
        btitle = CharField(label='名称', max_length=20)
        bpub_date = DateField(label='发布日期')
        bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
        bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)
        is_delete = BooleanField(label='逻辑删除', required=False)

1.5 指定只读字段

在ModelSerializer序列化器中，我们可以通过在Meta类中，指定read_only_fields属性的值来设置只读字段。

class BookInfoModelSerializer(serializers.ModelSerializer):
    '''定义图书信息的ModelSerializers序列化器'''

    class Meta:
        # 指定序列化器对应的模型类
        # model = 模型类名
        model = BookInfo

        # 对全部字段进行序列化和反序列化操作
        fields = '__all__' # __all__表示所有字段进行序列化

        # 定义只读字段
        read_only_fields = ('id',)

Shell测试代码：

>>> from booktest.serializers import BookInfoModelSerializer 
>>> s = BookInfoModelSerializer()
>>> s
BookInfoModelSerializer():
    id = IntegerField(label='ID', read_only=True)
    btitle = CharField(label='名称', max_length=20)
    bpub_date = DateField(label='发布日期')
    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)
    is_delete = BooleanField(label='逻辑删除', required=False)

通过测试代码，我们可以发现id字段被设置上了read_only属性。

1.6 为指定字段添加验证参数

在ModelSerializer序列化器中，我们可以通过在Meta类中，指定extra_kwargs属性的值来为指定的字段添加验证参数。

这里，我们需要注意的时extra_kwargs属性的值个格式是个字典。

extra_kwargs = {
     '字段名':{
          '验证选项':'验证条件',
     }
}

案例代码：

class BookInfoModelSerializer(serializers.ModelSerializer):
    '''定义图书信息的ModelSerializers序列化器'''

    class Meta:
        # 指定序列化器对应的模型类
        # model = 模型类名
        model = BookInfo

        # 对全部字段进行序列化和反序列化操作
        fields = '__all__' # __all__表示所有字段进行序列化

        # 添加字段验证选项
        extra_kwargs = {
            'bcomment':{
                'min_value':0,
                'max_value':99999
            }
        }

Shell测试代码：

>>> from booktest.serializers import BookInfoModelSerializer, HeroInfoModelSerializer 
>>> s = BookInfoModelSerializer()
>>> s
BookInfoModelSerializer():
    id = IntegerField(label='ID', read_only=True)
    btitle = CharField(label='名称', max_length=20)
    bpub_date = DateField(label='发布日期')
    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
    bcomment = IntegerField(label='评论量', max_value=99999, min_value=0, required=False)
    is_delete = BooleanField(label='逻辑删除', required=False)

通过测试代码，我们可以发现bcomment字段被设置了两个新的验证条件。

2. ModelSerializer序列化器的其他操作

在本文的开始，我就提到ModelSerializer是Serializer的子类，所以，ModelSerializer也可以进行验证的扩展操作。

这里呢，我就不进行赘述了，其方式和Serializer序列化器是一致的，只需要在序列化器类中验证方法重写方法即可。

这里放上Serializer序列化器的文章，大家可以参考Serializer序列化器的验证来为ModelSerializer序列化器进行自定义验证。

Serializer序列化器：https://www.cnblogs.com/chao666/p/12269977.html

标签
序列化
测试模型
meta
易学教程内所有资源均来自网络或用户发布的内容，如有违反法律规定的内容欢迎反馈！
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!