如何在Python中利用Marshmallow进行复杂的对象序列化?

梦磊同学_6424

梦磊同学_6424

2026-06-14

703人浏览

原创

marshmallow本身不自动序列化复杂对象,只处理字典或基本类型;传入自定义类实例会因内部调用json.dumps()而报“object is not json serializable”错误,需通过attribute、pre_dump或as_dict等方式预处理为可序列化结构。

如何在python中利用marshmallow进行复杂的对象序列化?

Marshmallow 本身不处理对象序列化,它只做数据验证与序列化/反序列化——关键在于你传给它的必须是字典或基本类型,不是任意复杂对象。直接传入自定义类实例会报 TypeError: Object of type XXX is not JSON serializable

为什么 schema.dump(obj) 报错 “Object is not JSON serializable”

因为 dump() 内部调用的是 Python 的 json.dumps(),而 Marshmallow 的字段(如 String()Nested())只负责从输入数据中提取、转换、校验字段,不会自动把一个未定义 __dict__to_dict() 方法的类实例“拍平”成字典。

常见错误场景:

  • 直接传入 SQLAlchemy 模型实例,但没配置 SQLAlchemyAutoSchema 或没定义 fields
  • 传入 dataclass 实例,但没加 @post_dump 或没手动转成 dict
  • 嵌套了非 dict / list / primitive 的对象(比如 datetime 是例外,有 DateTime() 字段支持;但自定义类不是)

让自定义类被 schema.dump() 正确处理的三种方式

核心思路:确保 schema 能从对象上读到字段值。优先级从高到低:

  • 显式定义字段 + attribute 参数:适用于字段名和属性名不一致,或需调用方法
  • 在类中实现 __getattr__ 或提供 as_dict() 并配合 post_dump:适合已有成熟模型类,不想改 schema 定义
  • pre_dump 预处理对象为 dict:最灵活,但容易掩盖字段映射逻辑

示例(推荐第一种):

from marshmallow import Schema, fields
<p>class User:
def <strong>init</strong>(self, id, name, profile):
self.id = id
self.name = name
self.profile = profile  # 假设是另一个对象</p><p>class ProfileSchema(Schema):
bio = fields.String()</p><p>class UserSchema(Schema):
id = fields.Integer()
name = fields.String()
bio = fields.String(attribute="profile.bio")  # 直接链式取属性
</p>

注意:attribute="profile.bio" 仅在 profile 是普通对象且有 bio 属性时有效;若 profile 是 None,会抛 AttributeError,需配合 load_onlyallow_none=True 控制。

Shadows Python Sensei
Shadows Python Sensei

Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。

下载

Nested 字段怎么正确关联子对象?

Nested 不是“自动递归序列化”,它只在输入是 dict 或有对应字段可提取时才生效。如果传入的是子类实例,必须保证该实例能被子 schema 的字段成功读取。

  • 子 schema 必须明确定义字段,不能只靠 Nested(UserSchema) 就指望它猜出怎么取值
  • 若子对象字段名和 schema 字段名不一致,用 attributedata_key 显式绑定
  • 避免循环引用:A 包含 B,B 又包含 A → 用 lazy="joined"(SQLAlchemy)或延迟加载 Nested(如 Nested(lambda: UserSchema())

错误写法:

class UserSchema(Schema):
    profile = fields.Nested(ProfileSchema)  # ❌ profile 是 Profile 实例,但 ProfileSchema 没定义字段来读它

正确写法:

class ProfileSchema(Schema):
    bio = fields.String(attribute="bio")  # 明确告诉它从 profile.bio 读
<p>class UserSchema(Schema):
profile = fields.Nested(ProfileSchema, attribute="profile")  # ✅
</p>

性能与调试:什么时候该放弃 Marshmallow 直接用 pydantic

如果你的“复杂对象”大量依赖动态属性、__getattr__、描述符、或需要深度嵌套 + 自动模型发现(比如 FastAPI 默认行为),Marshmallow 的显式字段绑定反而成为负担。这时 pydantic.BaseModel.model_dump() 更自然。

但别轻易切换——已用 Marshmallow 的项目里,pre_dump + asdict()(对 dataclass)或 __dict__(对简单类)往往比重构成 pydantic 更省事。

最容易被忽略的一点:schema.dump() 返回的是 dict,不是 JSON 字符串。要输出 JSON,还得自己 json.dumps(result);而很多人卡在“为什么返回值打印出来是 dict 却不能直接给前端”,其实是漏了这步。

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

相关文章

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

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

下载

相关标签:

python

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

相关专题

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

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

2023.07.20

1551

4

python能做什么
python能做什么

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

2023.07.25

3644

7

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

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

2023.07.31

1569

3

python教程
python教程

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

2023.08.03

20757

23

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

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

2023.08.04

2567

5

python eval
python eval

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

2023.08.04

2627

5

scratch和python区别
scratch和python区别

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

2023.08.11

1063

5

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

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

2023.08.10

576

4

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

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

2023.08.11

2023

5

热门下载

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

精品课程

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