模型类序列化器ModelSerializer

模型类序列化器ModelSerializer

---

如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。

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

• 基于模型类自动生成一系列字段

• 基于模型类自动为Serializer生成validators

• 包含默认的create()和update()的实现

1. 定义

比如我们创建一个BookInfoSerializer

class BookInfoSerializer(serializers.ModelSerializer):

    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = '__all__'

* model 指明参照哪个模型类    * fields 指明为模型类的哪些字段生成

可以在python manage.py shell中查看自动生成的BookInfoSerializer的具体实现 (参照序列化使用和反序列化使用，过程省略)

 

2. 指定字段

1) 使用fields来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，如

class BookInfoSerializer(serializers.ModelSerializer):

    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date')

2) 使用exclude可以明确排除掉哪些字段

class BookInfoSerializer(serializers.ModelSerializer):

    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        exclude = ('image',) # 这里可以用列表也可以用元组

3) 显示指明字段，如：

class HeroInfoSerializer(serializers.ModelSerializer):

    hbook = BookInfoSerializer()

    class Meta:
        model = HeroInfo
        fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

4) 指明只读字段    可以通过read_only_fields指明只读字段，即仅用于序列化输出的字段

class BookInfoSerializer(serializers.ModelSerializer):

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

3. 添加额外参数

我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数

class BookInfoSerializer(serializers.ModelSerializer):

    """图书数据序列化器"""
    # 定义模型外部字段(按需求定义，可以有也可以没有)
    bauthor = DateField(allow_null=True, label='作者', required=False)

    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},
        }