Django restframework中Serializer序列化器-用法详解

绝地灬酷狼 2023-02-25 12:22 1阅读 0赞

# 定义Serializer #

## 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)

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

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)

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

## 2.字段与选项 ##

**常用字段类型：**

<table> 
 <thead> 
  <tr> 
   <th>字段</th> 
   <th>字段构造方式</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong>BooleanField</strong></td> 
   <td>BooleanField()</td> 
  </tr> 
  <tr> 
   <td><strong>NullBooleanField</strong></td> 
   <td>NullBooleanField()</td> 
  </tr> 
  <tr> 
   <td><strong>CharField</strong></td> 
   <td>CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)</td> 
  </tr> 
  <tr> 
   <td><strong>EmailField</strong></td> 
   <td>EmailField(max_length=None, min_length=None, allow_blank=False)</td> 
  </tr> 
  <tr> 
   <td><strong>RegexField</strong></td> 
   <td>RegexField(regex, max_length=None, min_length=None, allow_blank=False)</td> 
  </tr> 
  <tr> 
   <td><strong>SlugField</strong></td> 
   <td>SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9-]+</td> 
  </tr> 
  <tr> 
   <td><strong>URLField</strong></td> 
   <td>URLField(max_length=200, min_length=None, allow_blank=False)</td> 
  </tr> 
  <tr> 
   <td><strong>UUIDField</strong></td> 
   <td>UUIDField(format=‘hex_verbose’) <br> format: <br> 1) ‘hex_verbose’ 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" <br> 2） ‘hex’ 如 “5ce0e9a55ffa654bcee01238041fb31a” <br> 3）‘int’ - 如: “123456789012312313134124512351145145114” <br> 4）‘urn’ 如: “urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a”</td> 
  </tr> 
  <tr> 
   <td><strong>IPAddressField</strong></td> 
   <td>IPAddressField(protocol=‘both’, unpack_ipv4=False, **options)</td> 
  </tr> 
  <tr> 
   <td><strong>IntegerField</strong></td> 
   <td>IntegerField(max_value=None, min_value=None)</td> 
  </tr> 
  <tr> 
   <td><strong>FloatField</strong></td> 
   <td>FloatField(max_value=None, min_value=None)</td> 
  </tr> 
  <tr> 
   <td><strong>DecimalField</strong></td> 
   <td>DecimalField(max_digits, decimal_places, coerce_to_string=None, <br> max_value=None, min_value=None) <br> max_digits: 最多位数 <br> decimal_palces: 小数点位置</td> 
  </tr> 
  <tr> 
   <td><strong>DateTimeField</strong></td> 
   <td>DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)</td> 
  </tr> 
  <tr> 
   <td><strong>DateField</strong></td> 
   <td>DateField(format=api_settings.DATE_FORMAT, input_formats=None)</td> 
  </tr> 
  <tr> 
   <td><strong>TimeField</strong></td> 
   <td>TimeField(format=api_settings.TIME_FORMAT, input_formats=None)</td> 
  </tr> 
  <tr> 
   <td><strong>DurationField</strong></td> 
   <td>DurationField()</td> 
  </tr> 
  <tr> 
   <td><strong>ChoiceField</strong></td> 
   <td>ChoiceField(choices) <br> choices与Django的用法相同</td> 
  </tr> 
  <tr> 
   <td><strong>MultipleChoiceField</strong></td> 
   <td>MultipleChoiceField(choices)</td> 
  </tr> 
  <tr> 
   <td><strong>FileField</strong></td> 
   <td>FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)</td> 
  </tr> 
  <tr> 
   <td><strong>ImageField</strong></td> 
   <td>ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)</td> 
  </tr> 
  <tr> 
   <td><strong>ListField</strong></td> 
   <td>ListField(child=, min_length=None, max_length=None)</td> 
  </tr> 
  <tr> 
   <td><strong>DictField</strong></td> 
   <td>DictField(child=)</td> 
  </tr> 
 </tbody> 
</table>

## 选项参数： ##

<table> 
 <thead> 
  <tr> 
   <th>参数名称</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td><strong>max_length</strong></td> 
   <td>最大长度</td> 
  </tr> 
  <tr> 
   <td><strong>min_lenght</strong></td> 
   <td>最小长度</td> 
  </tr> 
  <tr> 
   <td><strong>allow_blank</strong></td> 
   <td>是否允许为空</td> 
  </tr> 
  <tr> 
   <td><strong>trim_whitespace</strong></td> 
   <td>是否截断空白字符</td> 
  </tr> 
  <tr> 
   <td><strong>max_value</strong></td> 
   <td>最大值</td> 
  </tr> 
  <tr> 
   <td><strong>min_value</strong></td> 
   <td>最小值</td> 
  </tr> 
 </tbody> 
</table>

### 通用参数： ###

<table> 
 <thead> 
  <tr> 
   <th>参数名称</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>read_only</td> 
   <td>表明该字段仅用于<font><strong>序列化输出</strong></font> ，默认False</td> 
  </tr> 
  <tr> 
   <td>write_only</td> 
   <td>表明该字段仅用于<font><strong>反序列化输入</strong></font> ，默认False</td> 
  </tr> 
  <tr> 
   <td>required</td> 
   <td>表明该字段在<font><strong>反序列化时必须输入</strong></font> ，默认True</td> 
  </tr> 
  <tr> 
   <td>default</td> 
   <td>反序列化时使用的默认值</td> 
  </tr> 
  <tr> 
   <td>allow_null</td> 
   <td>表明该字段是否允许传入None，默认False</td> 
  </tr> 
  <tr> 
   <td>validators</td> 
   <td><font><strong>该字段使用的验证器</strong></font></td> 
  </tr> 
  <tr> 
   <td>error_messages</td> 
   <td>包含错误编号与错误信息的字典</td> 
  </tr> 
  <tr> 
   <td>label</td> 
   <td>用于HTML展示API页面时，显示的字段名称</td> 
  </tr> 
  <tr> 
   <td>help_text</td> 
   <td>用于HTML展示API页面时，显示的字段帮助提示信息</td> 
  </tr> 
 </tbody> 
</table>

## 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属性获取。**

# 二、序列化使用 #

## 2.1. 基本使用 ##

*  先查询出一个图书对象

from booktest.models import BookInfo
    
    book = BookInfo.objects.get(id=2)

*  构造序列化器对象

from booktest.serializers import BookInfoSerializer
    
    serializer = BookInfoSerializer(book)

*  获取序列化数据

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

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

*  如果要被序列化的是包含多条数据的查询集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')])]

## 2.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)

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

*  **PrimaryKeyRelatedField**

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

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

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

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

使用效果：

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}

*  **StringRelatedField**

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

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

使用效果

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

*  **使用关联对象的序列化器**

hbook = BookInfoSerializer()

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

*  **many参数**

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

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

在BookInfoSerializer中添加关联字段：

使用效果：

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

# 三、反序列化的使用 #

## 3.1、验证 ##

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

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

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

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

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

如我们前面定义过的BookInfoSerializer

通过构造序列化器对象，并将要反序列化的数据传递给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.errors  # {}
    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)

## 3.2、自定义验证方式 ##

如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：

### 3.2.1 validate\_<field\_name> ###

通过定义`validate_<field_name>` 方法，对`<field_name>`字段进行验证，如：

class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        ...
    
        def validate_btitle(self, value):
            if 'django' not in value.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')]}

### 3.2.2 validate ###

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

class BookInfoSerializer(serializers.Serializer):
        """图书数据序列化器"""
        ...
    
        def validate(self, attrs):
            bread = attrs['bread']
            bcomment = attrs['bcomment']
            if bread < bcomment:
                raise serializers.ValidationError('阅读量小于评论量')
            return attrs

测试

from booktest.serializers import BookInfoSerializer
    data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20}
    s = BookInfoSerializer(data=data)
    s.is_valid()  # False
    s.errors
    #  {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

### 3.2.3 validators ###

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

def about_django(value):
        if 'django' not in value.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)

测试：

## 3.3 保存 ##

如果在验证成功后，想要基于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)

# 四、模型类序列化器ModelSerializer #

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

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

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

## 4.1 定义ModelSerializer ##

比如我们创建一个BookInfoSerializer：

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

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

我们可以在`python manage.py shell`中查看自动生成的`BookInfoSerializer`的具体实现:

>>> from booktest.serializers import BookInfoSerializer
    >>> serializer = BookInfoSerializer()
    >>> serializer
    BookInfoSerializer():
        id = IntegerField(label='ID', read_only=True)
        btitle = CharField(label='名称', max_length=20)
        bpub_date = DateField(allow_null=True, label='发布日期', required=False)
        bread = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False)
        bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)
        image = ImageField(allow_null=True, label='图片', max_length=100, required=False)

## 4.2、指定字段 ##

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

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

*  使用`exclude`可以明确排除掉哪些字段

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

*  显示指明字段，如：

class HeroInfoSerializer(serializers.ModelSerializer):
        hbook = BookInfoSerializer()
    
        class Meta:
            model = HeroInfo
            fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

*  指明只读字段

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

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

## 4.3 添加额外参数 ##

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

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},
            }
    
    # BookInfoSerializer():
    #    id = IntegerField(label='ID', read_only=True)
    #    btitle = CharField(label='名称', max_length=20)
    #    bpub_date = DateField(allow_null=True, label='发布日期', required=False)
    #    bread = IntegerField(label='阅读量', max_value=2147483647, min_value=0, required=True)
    #    bcomment = IntegerField(label='评论量', max_value=2147483647, min_value=0, required=True)

# 定义Serializer #

## 1. 定义方法 ##

Django REST framework中的Serializer使用类来定义，须继承自rest\_framework.serializers.Serializer。

例如，我们已有了一个数据库模型类BookInfo

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

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

## 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属性获取。**

# 二、序列化使用 #

## 2.1. 基本使用 ##

*  先查询出一个图书对象

from booktest.models import BookInfo
    
    book = BookInfo.objects.get(id=2)

*  构造序列化器对象

from booktest.serializers import BookInfoSerializer
    
    serializer = BookInfoSerializer(book)

*  获取序列化数据

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

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

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

## 2.2关联对象嵌套序列化 ##

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

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

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

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

*  **PrimaryKeyRelatedField**

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

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

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

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

使用效果：

*  **StringRelatedField**

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

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

使用效果

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

*  **使用关联对象的序列化器**

hbook = BookInfoSerializer()

*  **many参数**

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

在BookInfoSerializer中添加关联字段：

使用效果：

# 三、反序列化的使用 #

## 3.1、验证 ##

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

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

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

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

如我们前面定义过的BookInfoSerializer

# Return a 400 response if the data was invalid.
    serializer.is_valid(raise_exception=True)

## 3.2、自定义验证方式 ##

如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：

### 3.2.1 validate\_<field\_name> ###

通过定义`validate_<field_name>` 方法，对`<field_name>`字段进行验证，如：

测试

### 3.2.2 validate ###

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

测试

### 3.2.3 validators ###

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

测试：

## 3.3 保存 ##

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

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

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

book = serializer.save()

说明：

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

serializer.save(owner=request.user)

# 四、模型类序列化器ModelSerializer #

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

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

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

## 4.1 定义ModelSerializer ##

比如我们创建一个BookInfoSerializer：

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

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

我们可以在`python manage.py shell`中查看自动生成的`BookInfoSerializer`的具体实现:

## 4.2、指定字段 ##

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

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

*  使用`exclude`可以明确排除掉哪些字段

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

*  显示指明字段，如：

*  指明只读字段

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

## 4.3 添加额外参数 ##

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