在使用django restframework serializer 序列化在django中定義的model時，有時候我們需要額外在serializer中增加一些model中沒有的欄位。有兩種方法實現這個目的。

假設現在有一個Animal模型，其中有name,type,country欄位，country為外來鍵。我們在序列化Animal時，需要額外增加外來鍵country的area資訊。

方法一修改資料庫，利用model 這裡就不多解釋，主要來說第二種，不修改django的model，直接使用SerializerMethodField(method_name=None)欄位。

class AnimalSerializer(serializers.ModelSerializer):
 country_area = serializers.SerializerMethodField()

 class Meta:
  model = Animal
  fields = ('id','name','type','country','country_area')

 def get_country_area(self,obj):
  return obj.country.area

SerializerMethodFiel是一個read-only欄位

當不指定其method_name時，預設為get_field_name

如果使用ModelSerializer並指定欄位時，要包含此時定義的欄位

補充知識：django restframework Serializer field

SerializerMethodField

這是一個只讀欄位。它通過呼叫它所連線的序列化類的方法來獲得它的值。它可用於將任何型別的資料新增到物件的序列化表示中。

簽名： SerializerMethodField(method_name=None)

method_name - 要呼叫序列化物件的方法的名稱。如果不包含，則預設為 get_<field_name>.

由 method_name 引數引用的序列化方法應該接受一個引數（除了 self），這是要序列化的物件。它應該返回你想要包含在物件的序列化表示中的任何內容。例如：

場景介紹：一個使用者往往對應多個角色，而角色欄位並不在UserProfile表中，這就需要我們新增角色欄位到user序列化中

from .models import UserProfile
from .models import UserRole

class UserProfileSerializer(serializers.ModelSerializer):
 """
 show list serializer
 """
 role = serializers.SerializerMethodField()

 class Meta:
  model = UserProfile
  # fields = "__all__"
  fields = ["id","username","role","account","really_name","department","tel_phone","create_time","email","last_time","creator"]

 def get_role(self,obj):
  user_id = obj.id
  roles = [i.role.name for i in UserRole.objects.filter(user_id=user_id)]
  roles = ",".join(roles)
  return roles

相反的場景：我們提交的表單資料存在於多表中(因為表中含有多對多欄位)，如何驗證所有欄位，並儲存完整的資料到各表中。

剛開始的思路在ModelSerializer中新增未定義欄位，然後發現這並不可行。我也犯了SerializerMethodField的錯誤，但隨後去讀了serializer的原始碼，以及瞭解serializer的順序，就知道SerializerMethodField僅用於list方法。

問題的突破點到底在哪裡呢，在drf serializer 官方文件中就有一個知識點，serializer.save(**kwargs),kwargs資料被繫結在serializer.validated_data物件上,當create或update的時候就會被新增進資料庫,相當於validated_data.update(kwargs)

實際原始碼不是這樣子，但也就是這麼個意思。

重寫Serializer create,update方法

from rest_framework.utils import model_meta

 def create(self,validated_data):
  field= validated_data.pop('field_name')
  validated_data = validated_data
  instance = Model.objects.create(**validated_data)
  # ...外來鍵表的操作
  return instance

 def update(self,instance,validated_data):
  field= validated_data.pop('field_name')
  info = model_meta.get_field_info(instance)

  for attr,value in validated_data.items():
   if attr in info.relations and info.relations[attr].to_many:
    field = getattr(instance,attr)
    field.set(value)
   else:
    setattr(instance,attr,value)
  instance.save()
  # ...
  return instance

以上這篇django restframework serializer 增加自定義欄位操作就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支援我們。