Django Serializers高级用法之动态修改Fields参数

一言不合,上代码

class SlidesSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Slides
        fields = ('id', 'title', 'image', 'url', 'no',)

使用Django开发的童鞋应该很面熟上面的代码吧,因为在开发中常常会编写如上的各种Serializer类来为我们的Model类数据进行序列化操作。通常上面这个SlidesSerializer类的主要作用就是将其Meta类中指定Model对象models.Slides序列化成由其 fields属性声明的那些字段组成的字符串

#序列化之后的models.Slides对象
{'id': 2, 'title': '道地良品', 'image': '/daodi.png', 'url': 'www.daodikeji.com', 'no': 'DD_BJ_001'}

一切都挺ok,突然有一天,小五童鞋觉得除了idimagetitle字段,其它字段都不需要序列化,于是他给models.Slides又写了一个精简版的SerializerSlidesLiteSerializer

class SlidesSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Slides
        fields = ('id', 'title', 'image', 'url', 'no',)

#精简序列化版
class SlidesLiteSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Slides
        fields = ('id', 'title','image',)

额,好像有点Low...


的确,怎么可以则个样子啊,虽然也能解决问题,但要是再来个需要id与其它四个字段分别俩俩搭配的需求,岂不是又得整一堆Serializer...
作为一个有点强迫症的码农,我表示不能忍啊
于是,参照官网api文档,我对SlidesLiteSerializer进行了一番改造

class SlidesSerializer(serializers.ModelSerializer):
    """
     此处的`fields`字段是用来替换上面Serializer内部Meta类中指定的`fields`属性值
    """

    def __init__(self, *args, **kwargs):
        # 在super执行之前
        # 将传递的`fields`中的字段从kwargs取出并剔除,避免其传递给基类ModelSerializer
        # 注意此处`fields`中在默认`self.fields`属性中不存在的字段将无法被序列化 也就是`fields`中的字段应该      
        # 是`self.fields`的子集
        fields = kwargs.pop('fields', None)

        super(BaseModeSerializer, self).__init__(*args, **kwargs)

        if fields is not None:
            # 从默认`self.fields`属性中剔除非`fields`中指定的字段 
            allowed = set(fields)
            existing = set(self.fields.keys())
            for field_name in existing - allowed:
                self.fields.pop(field_name)

    class Meta:
        model = models.Slides
        fields = ('id', 'title', 'image', 'url', 'no',)

现在,来试试:

>>> print SlidesSerializer(sides)
{'id': 2, 'title': '道地良品', 'image': '/daodi.png', 'url': 'www.daodikeji.com', 'no': 'DD_BJ_001'}
>>> print SlidesSerializer(sides, fields=('id', 'title'))
{'id': 2, 'title': '道地良品'}
>>> print SlidesSerializer(sides, fields=('id', 'title','image'))
{'id': 2, 'title': '道地良品', 'image': '/daodi.png'}

Nice!!!

Ps:建议将构造器部分代码实现放置于基类Serializer,然后将Model类对应的Serializer实现类继承该基类,酱紫,所有继承该基类的Serializer均能实现Fields参数的动态修改

希望对大家有所帮助,如果喜欢,不要小气,给个♥呗!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,013评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,205评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,370评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,168评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,153评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,954评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,271评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,916评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,382评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,877评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,989评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,624评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,209评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,199评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,418评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,401评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,700评论 2 345