如何 JSON 序列化 Django 模型的 __dict__？

Posted 2023-02-23

【中文标题】如何 JSON 序列化 Django 模型的 __dict__？

【英文标题】：How to JSON serialize __dict__ of a Django model?

【发布时间】：2014-06-03 21:27:27

【问题描述】：

我想在 Django 中序列化单个模型的值。因为要使用get()，所以values()不可用。但是，我读过on Google Groups，您可以使用__dict__ 访问这些值。

from django.http import HttpResponse, Http404
import json
from customer.models import Customer

def single(request, id):
    try:
        model = Customer.objects.get(id=id, user=1)
    except Customer.DoesNotExist:
        raise Http404
    values = model.__dict__
    print(values)
    string = json.dumps(values)
    return HttpResponse(string, content_type='application/json')

print 语句输出这个。

'_state': <django.db.models.base.ModelState object at 0x0000000005556EF0>, 'web
site': 'http://example.com/', 'name': 'Company Name', 'id': 1, 'logo': '', 'use
r_id': 1, 'address3': 'City', 'notes': '', 'address2': 'Street 123', 'address1': 'Company Name', 'ustid': 'AB123456789', 'fullname': 'Full Name Of Company Inc.', 'mail': '[e-mail]'

由于 _state 键包含不可序列化的值，因此下一行失败并出现此错误。

<django.db.models.base.ModelState object at 0x0000000005556EF0> is not JSON serializable

如何在不包含_state 的情况下序列化从__dict__ 返回的字典？

【问题讨论】：

django webapi: dump django model to JSON的可能重复

@FallenAngel 序列化all() 返回的内容是微不足道的，但我的问题是关于get()。这是相关的，但不是重复的。

【参考方案1】：

查看源代码 django/core/serializers/__init__.py 评论：

Interfaces for serializing Django objects.

Usage::

    from django.core import serializers
    json = serializers.serialize("json", some_queryset)
    objects = list(serializers.deserialize("json", json))

To add your own serializers, use the SERIALIZATION_MODULES setting::

    SERIALIZATION_MODULES = 
        "csv" : "path.to.csv.serializer",
        "txt" : "path.to.txt.serializer",
    

对于一个对象

json = serializers.serialize("json", some_queryset[0:1])

【参考方案2】：

model_to_dict() 是你需要的：

from django.forms.models import model_to_dict

data = model_to_dict(model)
data['logo'] = data['logo'].url
return HttpResponse(json.dumps(data), content_type='application/json')

通过指定 fields 和 exclude 关键字参数，您可以控制要序列化的字段。

另外，您可以使用快捷方式get_object_or_404() 简化try/except 块：

model = get_object_or_404(Customer, id=id, user=1)

【讨论】：

谢谢！我在您的问题中添加了所需的导入。但是，我仍然无法序列化字典，因为它包含一个 Django 图像。我认为字典必须包含图像 url 而不是整个 Django 对象。有什么想法吗？

@danijar hm，它在图像字段中的表现如何？有什么错误吗？另外，您可以尝试使用建议的here 之类的内置查询集序列化程序吗？谢谢。

model_to_dict() 返回一个像 'name': 'Foo', 'user': 1, 'logo': <ImageFieldFile: None> 这样的字典，它无法序列化。 Django 序列化程序将字段字典包装在另一个我不想要的字典中。

@danijar 好的，我已经更新了答案。这个想法是使用model_to_dict() 来获取字典，然后覆盖logo 键。试一试。还有其他选择，但让我们先试试这个。谢谢。

我必须检查空文件，所以values['logo'] = values['logo'].url if values['logo'] else '' 做到了。感谢您的帮助。

【参考方案3】：

我发现实际上可以将values() 与get() 一起使用。您只需从过滤后的集合中获取值。

def single(request, id):
    user = 1
    try:
        models = Customer.objects.filter(id=id, user=user)
        values = models.values().get()
    except Customer.DoesNotExist:
        raise Http404
    string = json.dumps(values)
    return HttpResponse(string, content_type='application/json')