Django model轉字典的幾種方法

轉自： 的 《Django model轉字典的幾種方法》

原址：https://mp.weixin.qq.com/s/7gPLaCESHAB0dLgq7qZq5Q

平常的開發過程中不免遇到需要把model轉成字典的需求，尤其是現在流行前後端分離架構，Json格式幾乎成了前後端之間數據交換的標準，這種model轉dict的需求就更多了，本文介紹幾種日常使用的方法以供參考，所有例子均基於Django 2.0環境演示

背景介紹

model內容如下：

class Group(models.Model):
    name = models.CharField(max_length=255, unique=True, verbose_name='組名稱')

    def __str__(self):
        return self.name

class User(models.Model):
    create_time = models.DateTimeField(auto_now_add=True, verbose_name='創建時間')
    update_time = models.DateTimeField(auto_now=True, verbose_name='更新時間')
    username = models.EmailField(max_length=255, unique=True, verbose_name='用戶名')
    fullname = models.CharField(max_length=64, null=True, verbose_name='中文名')
    is_active = models.BooleanField(default=True, verbose_name='激活狀態')
    leader = models.ForeignKey('self', null=True, on_delete=models.CASCADE, verbose_name='上級')
    group = models.ManyToManyField(Group, null=True, verbose_name='所屬組')

    def __str__(self):
        return self.username

需求很簡單就是分別把Group和User表中的數據轉換成字典格式返回

方法一：直接構建字典

示例代碼：

>>> _t = Group.objects.get(id=1)
>>> 
>>> dict = {
...   'id': _t.id,
...   'name': _t.name
... }
>>> 
>>> print(dict)
{'name': 'GroupA', 'id': 1}

這種方法的好處是方便控制最終返回字典value的格式，例如對於User表，我想返回最終的數據是id、創建時間、中文名、上級中文名、所屬組名列表的話可以用下邊的代碼實現

>>> _t = User.objects.get(id=2)
>>> 
>>> dict = {
...   'id': _t.id,
...   'create_time': _t.create_time.strftime('%Y-%m-%d %H:%M:%S'),
...   'fullname': _t.fullname if _t.fullname else None,
...   'leader': _t.leader.fullname if _t.leader else None,
...   'group': [ i.name for i in _t.group.all() ],
... }
>>> 
>>> print(dict)
{'fullname': '運維咖啡吧', 'group': ['GroupA', 'GroupC', 'GroupE'], 'create_time': '2018-10-12 21:20:19', 'id': 2, 'leader': '公衆號'}
>>> 

缺點也很明顯，就是如果一個model字段很多且不需要轉換value格式的時候需要寫大量冗餘的代碼，這種問題怎麼解決呢？且看下邊的方法介紹

方法二：__dict__

示例代碼：

>>> Group.objects.get(id=1).__dict__
{'id': 1, 'name': 'GroupA', '_state': <django.db.models.base.ModelState object at 0x7f68612daef0>}
>>> 
>>> User.objects.get(id=1).__dict__
{'is_active': True, '_state': <django.db.models.base.ModelState object at 0x7f68612fa0b8>, 'id': 1, 'username': '[email protected]', 'leader_id': None, 'fullname': '公衆號', 'update_time': datetime.datetime(2018, 10, 12, 17, 49, 35, 504141), 'create_time': datetime.datetime(2018, 10, 12, 16, 9, 7, 813660)}

這種方法優點就是寫法簡單，容易理解，代碼量還少

但會發現多了個沒用的_state字段，同時Foreignkey字段名多了_id，也沒有ManyToManyField字段的數據，且不能按需顯示輸出，當我只需要其中幾個字段時會有大量冗餘數據

方法三：model_to_dict

示例代碼：

>>> model_to_dict(Group.objects.get(id=1))
{'name': 'GroupA', 'id': 1}
>>> 
>>> model_to_dict(User.objects.get(id=2))
{'leader': 1, 'is_active': True, 'username': '[email protected]', 'fullname': '運維咖啡吧', 'group': [<Group: GroupA>, <Group: GroupC>, <Group: GroupE>], 'id': 2}

這種方法能滿足大部分的需求，且輸出也較爲合理，同時還有兩個參數fields和exclude來配置輸出的字段，例如：

>>> model_to_dict(User.objects.get(id=2), fields=['fullname','is_active'])
{'is_active': True, 'fullname': '運維咖啡吧'}
>>> 
>>> model_to_dict(User.objects.get(id=2), exclude=['group','leader','id'])
{'fullname': '運維咖啡吧', 'is_active': True, 'username': '[email protected]'}

但是會跳過有editable=False屬性字段的展示，對於有auto_now_add=True和auto_now=True屬性的datetime字段會默認添加editable=False隱藏屬性，這也是上邊兩個time相關字段create_time和update_time轉換成dict後不顯示的原因，官方相關源碼如下：

for f in chain(opts.concrete_fields, opts.private_fields, opts.many_to_many):
    if not getattr(f, 'editable', False):
        continue

方法四：自定義to_dict

示例代碼：

from django.db.models.fields import DateTimeField
from django.db.models.fields.related import ManyToManyField

class User(models.Model):
    ...

    def to_dict(self, fields=None, exclude=None):
        data = {}
        for f in self._meta.concrete_fields + self._meta.many_to_many:
            value = f.value_from_object(self)

            if fields and f.name not in fields:
                continue

            if exclude and f.name in exclude:
                continue

            if isinstance(f, ManyToManyField):
                value = [ i.id for i in value ] if self.pk else None

            if isinstance(f, DateTimeField):
                value = value.strftime('%Y-%m-%d %H:%M:%S') if value else None

            data[f.name] = value

        return data

執行結果：

>>> User.objects.get(id=2).to_dict()
{'is_active': True, 'update_time': '2018-10-12 21:21:39', 'username': '[email protected]', 'id': 2, 'leader': 1, 'group': [1, 3, 5], 'create_time': '2018-10-12 21:20:19', 'fullname': '運維咖啡吧'}
>>> 
>>> User.objects.get(id=2).to_dict(fields=['fullname','is_active','create_time'])
{'is_active': True, 'fullname': '運維咖啡吧', 'create_time': '2018-10-12 21:20:19'}
>>> 
>>> User.objects.get(id=2).to_dict(exclude=['group','leader','id','create_time'])
{'is_active': True, 'update_time': '2018-10-12 21:21:39', 'username': '[email protected]', 'fullname': '運維咖啡吧'}

擁有model_to_dict一樣的便利性，同時也解決了不能輸出time時間字段（editable=False）的問題，還能對value按照自己需要的格式輸出，一舉多得
當然擁有便利性的同時需要自己實現to_dict的代碼，增加了複雜度