Django ORM对象Json序列化问题

悠悠 2022-06-01 14:15 311阅读 0赞

碰到了一个问题：在使用json.dumps()序列化Django ORM的Queryset对象，传递给前端的时候，程序报错：

`Object of type 'QuerySet' is not JSON serializable`

在python 中，常用的json 的序列化是从simplejson 基础上改变而来。这个json 包主要提供了dump,load 来实现dict 与 字符串之间的序列化与反序列化，这很方便的可以完成，但现在的问题是，这个json包不能序列化 django 的models 里面的对象的实例。  
经过一番度娘搜索，发现有如下解决方案：  
使用django.core自带的serializers模块：

#django ORM的 Queryset对象默认无法被直接json.dumps()序列化，django.core提供的serializers模块提供将其序列化成str类型
    #的功能，serializers处理后，再次json.dumps传给前端，前端需要经过两次json.Parse()处理，才能得到原对象类型，但是格式发
    #生了变化，需要按新的方式取索引.例如：obj['pk']取主键，obj['fields']["caption"]取obj的caption字段
    由QuerySet:[<Business: Business object>]
    变为了：
    [{"model": "cmdb.business", "pk": 1, "fields": {"caption": "develop"}}]

这样前端就可以正常获取数据了，只不过此字段需要两次json.Parse()处理。

至于使用models.Host.objects.get(id=xx)的方式获取到单个对象，而非Queryset对象，serializers默认也无法处理的问题，可以自定义json方法来实现dumps序列化

json默认只支持python原生的list、tuple、dict数据类型对象的序列化，若需要扩展其他类型对象的序列化功能，可以这样修改：

import json as default_json
    from json.encoder import JSONEncoder
    
    
    class BaseResponse(object):
        def __init__(self):
            self.status = True
            self.message = None
            self.data = None
            self.error = None
    o=BaseResponse()
    
    class JsonCustomEncoder(JSONEncoder):
        def default(self, o):
            if isinstance(o, BaseResponse):
                return o.__dict__
            return JSONEncoder.default(self, o)
    
    o1=json.dumps(o,cls=JsonCustomEncoder)
    
    
    >>> print(o1)
    {
       "message": null, "error": null, "data": null, "status": true}
    >>> print(type(o1))
    <class 'str'>
    
    #在序列化时指定cls参数，cls=自定义的序列化类，在自定义序列化类的default方法中判断，如果是指定的类的实例的话，则将该类转换成dict格式返回，若指定类的实例，则使用json模块默认的序列化方法。最终得到的return值为str类型。

参考链接：  
[Django model,QuerySet 序列化成json的方法][Django model_QuerySet _json]

[Django model_QuerySet _json]: http://www.yihaomen.com/article/python/279.htm