Django model 序列化為json

本文環(huán)境

Python 3.6.5
Django 2.0.4

fix（2018.5.19）:最近得知Django 的model基類需要聲明為abstract，故在原來的代碼加入abstract聲明，以免誤導(dǎo)

在Django中塑煎，關(guān)于如何將model類序列化為json畴蹭，一般的話有兩種方法

將model類轉(zhuǎn)為字典鼎天，再使用json庫的dumps方法轉(zhuǎn)為json

第一種方法就不多講了晦鞋，直接去看官方文檔就好啦
一般來說罢防，官方提供的方法應(yīng)該都是比較好用和穩(wěn)定的艘虎，然而，使用官方的序列化器卻問題不少：

格式丑陋咒吐，格式如下野建，一言難盡：

[
    {
        "pk": "4b678b301dfd8a4e0dad910de3ae245b",
        "model": "sessions.session",
        "fields": {
            "expire_date": "2013-01-16T08:16:59.844Z",
            ...
        }
    }
]

是的，其中pk指的是默認(rèn)主鍵恬叹，model指的是該object的model類型候生，然后fields才是obj的各種字段...真的是不知如何評價(jià)了

不能很好地支持list
對于一些外鍵（包括ManyToManyField等）不是很友好
甚至對于自身的DateField也沒有很好的支持

數(shù)了一通官方序列化器的缺點(diǎn)，當(dāng)然了绽昼，上面的幾個(gè)點(diǎn)肯定是有解決方案的唯鸭，但是啊，我確實(shí)不想折騰了嚶嚶嚶硅确。

于是扔出我的解決方案：

新建一個(gè)類BaseModel目溉，此類繼承于官方的model類django.db.models.Model
在著個(gè)BaseModel中，聲明一個(gè)方法菱农，此方法用于生成關(guān)于這個(gè)object的字典
使用這個(gè)object的字典生成json

關(guān)于生成object的字典的策略是這樣的：

通過反射獲取這個(gè)object的所有字段名
根據(jù)字段名獲得某個(gè)字段field
如果filed的類型的是int停做、float、str的話大莫，直接將以 "字段名":字段值的形式放入字典中
若field的類型是datetime或者date的話蛉腌，使用date的方式處理，然后放入字典
若field的類型是BaseModel的話只厘，那么就調(diào)用該field的getDict方法遞歸獲得該field對應(yīng)的字典烙丛，然后放入字典中
若field的類型是ManyToMany類型，在具體草種中我們使用這個(gè)field的all方法來這個(gè)field的所有object羔味，然后也是通過getDict方法將其放入到字典中

源碼及使用方法

from django.db import models
import json


class BaseModel(models.Model):
    class Meta:
        abstract = True

    # 返回self._meta.fields中沒有的河咽，但是又是需要的字段名的列表
    # 形如['name','type']
    def getMtMField(self):
        pass

    # 返回需要在json中忽略的字段名的列表
    # 形如['password']
    def getIgnoreList(self):
        pass

    def isAttrInstance(self, attr, clazz):
        return isinstance(getattr(self, attr), clazz)

    def getDict(self):
        fields = []
        for field in self._meta.fields:
            fields.append(field.name)

        d = {}
        import datetime
        for attr in fields:
            if isinstance(getattr(self, attr), datetime.datetime):
                d[attr] = getattr(self, attr).strftime('%Y-%m-%d %H:%M:%S')
            elif isinstance(getattr(self, attr), datetime.date):
                d[attr] = getattr(self, attr).strftime('%Y-%m-%d')
            # 特殊處理datetime的數(shù)據(jù)
            elif isinstance(getattr(self, attr), BaseModel):
                d[attr] = getattr(self, attr).getDict()
            # 遞歸生成BaseModel類的dict
            elif self.isAttrInstance(attr, int) or self.isAttrInstance(attr, float) \
                    or self.isAttrInstance(attr, str):
                d[attr] = getattr(self, attr)
            # else:
            #     d[attr] = getattr(self, attr)

        mAttr = self.getMtMField()
        if mAttr is not None:
            for m in mAttr:
                if hasattr(self, m):
                    attlist = getattr(self, m).all()
                    l = []
                    for attr in attlist:
                        if isinstance(attr, BaseModel):
                            l.append(attr.getDict())
                        else:
                            dic = attr.__dict__
                            if '_state' in dic:
                                dic.pop('_state')
                            l.append(dic)
                    d[m] = l
        # 由于ManyToMany類不能存在于_meat.fields，因而子類需要在getMtMFiled中返回這些字段
        if 'basemodel_ptr' in d:
            d.pop('basemodel_ptr')

        ignoreList = self.getIgnoreList()
        if ignoreList is not None:
            for m in ignoreList:
                if d.get(m) is not None:
                    d.pop(m)
        # 移除不需要的字段
        return d

    def toJSON(self):
        import json
        return json.dumps(self.getDict(), ensure_ascii=False).encode('utf-8').decode()

使用方法：
models的所有類都繼承BaseModel類赋元，然后調(diào)用此類的toJSON()方法即可
注意忘蟹，不知為何，self._meta.fields中沒有包含ManyToManyField字段搁凸，因而需要重寫getMtMField方法媚值。例子如下：

class Book(BaseModel):
    name = models.CharField(max_length=50)
    authors = models.ManyToManyField(Author)
    publish = models.ForeignKey(Publisher, on_delete=models.SET_NULL, blank=True, null=True)
    page = models.IntegerField(default=0)  # 頁數(shù)
    introduction = models.CharField(max_length=500)
    bookType = models.ManyToManyField(BookType, null=True, blank=True)
    bookTag = models.ManyToManyField(BookTag, null=True, blank=True)
    evaluation = models.FloatField()
    coverUrl = models.CharField(max_length=100, null=True, blank=True)

    def getMtMField(self):
        return ['bookType', 'bookTag']

結(jié)果：

{
    "id":4,
    "name":"Django從入門到放棄",
    "page":123,
    "introduction":"introduction",
    "evaluation":1,
    "bookType":[
        {
            "id":1,
            "name":"類型"
        }
    ],
    "bookTag":[
        {
            "id":2,
            "name":"tag"
        }
    ]
}

后記

源碼有引用，即getDict方法中的第一個(gè)for循環(huán)护糖，但懶得找原鏈接了褥芒，望見諒，特此聲明嫡良；
本人python新手锰扶，代碼多有不規(guī)范之處献酗，望見諒；
代碼不精坷牛，但是也希望能幫到你^_罕偎；
原文鏈接：http://www.reibang.com/p/c3db3cc2c80a