django restframework serializer 增加自定義字段操作
在使用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 UserProfilefrom .models import UserRoleclass 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 增加自定義字段操作就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支持好吧啦網。
相關文章: