Python中将自定义类对象序列化为JSON的完整指南

预期目标与环境准备

我们的目标是让任意Python自定义实例能够稳定输出为合法的JSON字符串，且不依赖第三方扩展。实验基于Python 3.x标准环境即可运行，无需额外安装模块。基础数据结构定义如下：

class Label:
    def __init__(self, label, x, y, width, height):
        self.label = label
        self.x = x
        self.y = y
        self.width = width
        self.height = height

第1步：利用 __dict__ 快速提取并转换

该步骤适用于仅需临时导出对象属性，且对性能要求不苛刻的场景。Python对象自带__dict__属性，可直接返回包含所有实例变量的字典。将其传入json.dumps()即可绕过类型检查。

import json

label = Label("person", 10, 10, 4, 10)
# 验证原始打印效果
print(label)
# 获取字典视图并转为JSON字符串
json_str = json.dumps(label.__dict__)
print(json_str)

输出结果：
{"label": "person", "x": 10, "y": 10, "width": 4, "height": 10}

该方法代码极简，但缺点是每次调用都必须显式访问__dict__，在业务代码中略显冗余。

第2步：定制 JSONEncoder 实现无缝兼容

若希望在使用json.dumps()时保持原生调用语法，且不破坏原有封装结构，推荐继承json.JSONEncoder创建专属解析器。此方案在生产环境中更为健壮。

from json import JSONEncoder

class CustomLabelEncoder(JSONEncoder):
    def default(self, obj):
        # 遇到非标准JSON类型（如自定义对象）时自动执行
        return obj.__dict__

label = Label("person", 10, 10, 4, 10)
# 通过cls参数注入自定义编码器
result = json.dumps(label, cls=CustomLabelEncoder)
print(result)

通过指定cls参数，json.dumps()会在内部遍历树结构，每当遇到自定义对象便触发default()方法完成字典映射，最终输出完全一致的JSON内容。这种方式允许对象保持原有API，仅将序列化逻辑收敛至编码器类中。

排查与补充说明

部分开发者尝试重写__str__与__repr__来实现格式化输出。该做法能改善控制台打印时的可读性，但json.dumps()在底层调用的是对象的default处理逻辑而非字符串表示，因此覆盖这两个魔法方法并不能直接解决序列化报错。如需同时满足命令行展示与接口传输，建议组合使用：

class Label:
    # ... init 同上 ...
    def __str__(self):
        return json.dumps(self.__dict__, ensure_ascii=False)

此时独立打印变量即可获得格式化文本，配合前文的编码器方案即可覆盖全场景需求。

完成判断与总结

当运行脚本后控制台稳定输出符合JSON语法的字典字符串，且无TypeError警告时，即表示序列化配置生效。针对简单数据透传，直接使用obj.__dict__最为直观；面对复杂嵌套或严格API规范的项目，采用JSONEncoder子类化则是兼顾整洁性与扩展性的最佳实践。

以上就是在Python中将自定义类对象序列化为JSON的详细处理方案，更多关于Python高级应用与数据处理技巧的资料请关注本站其它相关文章！