django drf to_internal_value

使用场景

用于将接收到的输入转换为内部可用的数据形式；

例子

to_internal_value主要在反序列化时用到，其作用处理API请求携带的数据，对其进行验证并转化为Python的数据类型。

假如我们的API客户端通过请求提交了额外的数据，比如extra_info字段，如下所示:

{
    "extra_info": {
        "msg": "Hello world!",
    },

    "data": {
        "name ": "liuyongzhan",
        "status ": "active",
        "liked_by": [2, 3, 4]
    }
}

由于extra_info字段不属于我们TestSerializer类里的字段，如果我们直接使用TestSerializer类对上述数据进行反序列化会出现错误。

事实上反序列化时我们只需要提取data然后对其反序列化即可，所以我们可以重写to_internal_value提取我们所需要的数据，忽略不想要的数据。

from django.db import models

class TestModel(models.Model):
   name = models.CharField(_("名称"), max_length=50, null=True, blank=True, default="")
   status = models.CharField(_("状态"), max_length=10, null=True)
   create_by = models.ForeignKey(to='users.User', on_delete=models.SET_NULL, null=True)
   liked_by = models.ManyToManyField(to='users.User')




from rest_framework import serializers


class TestSerializer(serializers.ModelSerializer):
  class Meta:
      model = TestModel
      fields = '__all__'

  def to_internal_value(self, data):
      # 提取所需要的数据，对其进行反序列化，data代表未验证的数据
      article_data = data['data']
      return super().to_internal_value(article_data)