django restframework serializer 增加自定義字段操作
在使用django restframework serializer 序列化在django中定義的model時(shí),有時(shí)候我們需要額外在serializer中增加一些model中沒(méi)有的字段。有兩種方法實(shí)現(xiàn)這個(gè)目的。
假設(shè)現(xiàn)在有一個(gè)Animal模型,其中有name, type, country字段,country為外鍵。我們?cè)谛蛄谢疉nimal時(shí),需要額外增加外鍵country的area信息。
方法一修改數(shù)據(jù)庫(kù),利用model 這里就不多解釋?zhuān)饕獊?lái)說(shuō)第二種,不修改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是一個(gè)read-only字段
當(dāng)不指定其method_name時(shí),默認(rèn)為get_field_name
如果使用ModelSerializer并指定字段時(shí),要包含此時(shí)定義的字段
補(bǔ)充知識(shí):django restframework Serializer field
SerializerMethodField
這是一個(gè)只讀字段。它通過(guò)調(diào)用它所連接的序列化類(lèi)的方法來(lái)獲得它的值。它可用于將任何類(lèi)型的數(shù)據(jù)添加到對(duì)象的序列化表示中。
簽名: SerializerMethodField(method_name=None)
method_name - 要調(diào)用序列化對(duì)象的方法的名稱(chēng)。如果不包含,則默認(rèn)為 get_<field_name>.
由 method_name 參數(shù)引用的序列化方法應(yīng)該接受一個(gè)參數(shù)(除了 self),這是要序列化的對(duì)象。它應(yīng)該返回你想要包含在對(duì)象的序列化表示中的任何內(nèi)容。例如:
場(chǎng)景介紹:一個(gè)用戶(hù)往往對(duì)應(yīng)多個(gè)角色,而角色字段并不在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
相反的場(chǎng)景:我們提交的表單數(shù)據(jù)存在于多表中(因?yàn)楸碇泻卸鄬?duì)多字段),如何驗(yàn)證所有字段,并保存完整的數(shù)據(jù)到各表中。
剛開(kāi)始的思路在ModelSerializer中新增未定義字段,然后發(fā)現(xiàn)這并不可行。我也犯了SerializerMethodField的錯(cuò)誤,但隨后去讀了serializer的源碼,以及了解serializer的順序,就知道SerializerMethodField僅用于list方法。
問(wèn)題的突破點(diǎn)到底在哪里呢,在drf serializer 官方文檔中就有一個(gè)知識(shí)點(diǎn),serializer.save(**kwargs),kwargs數(shù)據(jù)被綁定在serializer.validated_data對(duì)象上,當(dāng)create或update的時(shí)候就會(huì)被添加進(jìn)數(shù)據(jù)庫(kù),相當(dāng)于validated_data.update(kwargs)
實(shí)際源碼不是這樣子,但也就是這么個(gè)意思。
重寫(xiě)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 增加自定義字段操作就是小編分享給大家的全部?jī)?nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持好吧啦網(wǎng)。
相關(guān)文章:
1. django 獲取字段最大值,最新的記錄操作2. 阿里前端開(kāi)發(fā)中的規(guī)范要求3. .Net Core和RabbitMQ限制循環(huán)消費(fèi)的方法4. Ajax實(shí)現(xiàn)表格中信息不刷新頁(yè)面進(jìn)行更新數(shù)據(jù)5. ajax post下載flask文件流以及中文文件名問(wèn)題6. 關(guān)于Ajax跨域問(wèn)題及解決方案詳析7. vue實(shí)現(xiàn)點(diǎn)擊按鈕切換背景顏色的示例代碼8. asp讀取xml文件和記數(shù)9. XML入門(mén)精解之結(jié)構(gòu)與語(yǔ)法10. UDDI FAQs
