如何在Python中优雅地为类实例实现json序列化

落杰大大_1364

落杰大大_1364

2026-11-22

931人浏览

原创

json.dumps(obj)报错因只支持内置类型,自定义类需用default参数配转换函数或在类中实现__json__方法,避免直接用JSONEncoder子类。

如何在python中优雅地为类实例实现json序列化

为什么 json.dumps(obj) 直接报 TypeError: Object of type X is not JSON serializable

因为 Python 的 json 模块默认只认内置类型(dict、list、str、int、float、bool、None),遇到自定义类实例会直接抛错。它不会自动调用 __dict__,也不会识别你写的 to_dict() 方法。

最简可行方案:用 default 参数配一个转换函数

这是最轻量、侵入性最小的方式,适合临时序列化或结构较固定的类。

  • 定义一个函数,接收任意对象,返回可序列化的等价物(如 dict),对不认识的类型抛回原错误
  • 传给 json.dumps(..., default=your_func)
  • 注意:该函数会被递归调用,所以必须能处理嵌套对象(比如类里有另一个自定义类属性)
def to_serializable(obj):
    if hasattr(obj, '__dict__'):
        return obj.__dict__
    elif isinstance(obj, (datetime.date, datetime.datetime)):
        return obj.isoformat()
    raise TypeError(f"Object of type {type(obj).__name__} is not JSON serializable")

json.dumps(my_instance, default=to_serializable)

更可控的做法:让类自己声明如何序列化(实现 __json__ 或统一接口)

Python 本身没有强制约定,但你可以约定一个方法名(比如 __json__ 或 to_json_dict),并在 default 函数中检查它。这样逻辑集中在类内部,避免外部函数越写越胖。

  • 在类中定义 def __json__(self): return {"name": self.name, "id": self.id}
  • default 函数里加一句 if hasattr(obj, '__json__'): return obj.__json__()
  • 比纯 __dict__ 更安全:可过滤敏感字段、处理不可序列化的属性(如数据库连接)、做类型预转换
  • 注意:别在 __json__ 里返回自身或循环引用对象,否则 json 会栈溢出

别碰 JSONEncoder 子类,除非你真需要全局复用

继承 json.JSONEncoder 看似“正规”,但实际容易踩坑:

Exa JS Web Search SDK 用于 AI 应用程序
Exa JS Web Search SDK 用于 AI 应用程序

exa-js 是 Exa 官方 JavaScript 软件开发工具包,Exa 是一个为 AI 工作流构建的网络搜索 API。它为代理提供了一种具体的方式来搜索网络、检索页面内容,并从代码中生成有来源的答案,而不是手动拼接原始 HTTP 调用。

下载
  • 必须重写 default(self, obj),逻辑和上面手动写的 default 函数几乎一样
  • 一旦设为全局 cls=MyEncoder,所有 json.dumps 都走它,容易误伤第三方库返回的对象
  • 无法按需启用——比如只想序列化 A 类,不想影响 B 类,就得每次传 cls=,反而更啰嗦
  • 调试时难定位:错误堆栈里看不到你写的 encoder 逻辑在哪被触发

真正需要它的场景极少,比如你在写一个 SDK,要求所有用户输出都走同一套序列化规则,并且能保证输入类型可控。

最常被忽略的一点是:序列化不是单向操作。如果你靠 __dict__ 草率导出,反序列化时得手动构造实例,字段缺失、类型错位、嵌套对象还原失败这些问题,会在下游悄悄爆发。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python js json

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1971

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5664

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1929

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

34797

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

4047

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

4067

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1303

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

636

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

3163

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程