讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

剧云
剧云

中文短剧剧本制作平台

updream

一键生成高质量推广成片

Seko
Seko

AI短剧一键生成成片

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

落杰大大_1364

落杰大大_1364

发布时间:2026-11-22 09:27:21

|

931人浏览过

|

来源于php中文网

原创

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 调用。

下载

立即学习“Python免费学习笔记(深入)”;

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

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

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

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

笔灵降AI

一款AI论文写作工具,主要用于论文降AI神器,适配知网及维普!一键降至安全线,100%保留原文格式;无口语化问题,文风更学术,降后字数控制最佳!,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

相关专题

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

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

1971

2023.07.20

python能做什么
python能做什么

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

5664

2023.07.25

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

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

1929

2023.07.31

python教程
python教程

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

34797

2023.08.03

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

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

4047

2023.08.04

python eval
python eval

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

4067

2023.08.04

scratch和python区别
scratch和python区别

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

1303

2023.08.11

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

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

636

2023.08.10

Navicat创建数据库教程
Navicat创建数据库教程

本专题整理Navicat创建数据库相关教程,介绍新建前的准备、基础设置和创建后的检查方法。内容兼顾入门学习及实际使用需求,帮助用户了解不同数据库类型下的操作差异,为后续建表、保存数据和日常管理提供参考。

0

2026.11.20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn