Python json.JSONEncoder.iterencode 怎样分段生成 JSON 文本
来源:17golang原创
时间:2026-11-19 17:56:22 211浏览 收藏
当一个 Python 对象需要编码成 JSON,又不想在调用点一次性拿到完整字符串时,可以使用 json.JSONEncoder.iterencode()。它会按可用程度逐段产生 str,调用方可以把片段拼接起来,也可以逐段写入文本目标。要注意:这些片段不是独立 JSON 文档,也不自动等于网络消息帧。
官方文档:https://docs.python.org/3/library/json.html#json.JSONEncoder.iterencode
iterencode()的核心是“迭代产生 JSON 字符串片段”。需要完整字符串时用"".join();需要写入文件或发送数据时逐段处理;如果目标 API 只接受字节,则在发送边界统一使用 UTF-8 编码。
iterencode 返回的是字符串片段
官方 API 的定义是对对象进行编码,并在结果可用时逐个产生字符串表示。一个列表、字典或自定义对象可能被拆成多个片段,片段边界由编码器内部决定,不能把每个片段都当成完整 JSON 来调用 json.loads()。
如果调用方需要完整文档,最简单的做法是消费迭代器并连接所有片段。下面的示例使用 ensure_ascii=False 保留中文,使用紧凑分隔符减少无意义空白。
import json
payload = {
"name": "示例服务",
"items": ["alpha", "beta"],
}
# 选项与 dumps/encode 的含义一致;这里保留中文并减少分隔空白。
encoder = json.JSONEncoder(
ensure_ascii=False,
separators=(",", ":"),
)
# 每个元素都是 str 片段,片段边界不是 JSON 语法边界。
chunks = list(encoder.iterencode(payload))
document = "".join(chunks)
print(chunks)
print(document)
这里的 document 才是一份可以整体交给 JSON 解析器的文本。把片段收集到列表再 join 仍然会保留完整结果的内存占用;如果目标只是写出,就不必先收集它们。

怎样把片段逐段写入输出目标
如果输出目标实现了文本写入接口,可以在循环中直接写入每个片段。下面用 io.StringIO 表示一个文本目标;真实项目中也可以替换成打开的文本文件或自定义的文本写入器。
import io
import json
def write_json_text(obj, target):
# 统一创建编码器,避免把对象先转换为完整中间字符串。
encoder = json.JSONEncoder(ensure_ascii=False)
for chunk in encoder.iterencode(obj):
# iterencode 产生 str;文本目标应接收 str,而不是 bytes。
target.write(chunk)
buffer = io.StringIO()
write_json_text({"ok": True, "message": "已生成"}, buffer)
result = buffer.getvalue()
print(result)
如果目标是原始 socket 或二进制文件,就不能直接把 str 交给它。应在这一层明确编码,例如 chunk.encode("utf-8") 后再调用字节接口。不要在每个片段后额外添加换行或逗号,否则会改变 JSON 文档本身。
还要区分“逐段写出”和“流式协议分帧”:iterencode() 只负责序列化,多个片段合起来才是一个 JSON 文档。若接收端需要连续发送多份 JSON,应另外设计长度前缀、换行分隔或其他明确的消息边界。

iterencode、encode 和 dump 怎么选
| 接口 | 得到的结果 | 适合的场景 |
|---|---|---|
encode(obj) | 完整 str | 调用方需要整体处理、缓存或记录一份 JSON 文本。 |
iterencode(obj) | 可迭代的多个 str 片段 | 希望逐段写入文本目标,或把编码和发送循环放在同一层。 |
dump(obj, fp) | 直接写入文件对象 | 目标已经是支持 write(str) 的文件类对象。 |
iterencode() 并不意味着输入对象完全不占内存,也不自动把同步编码变成异步任务。它解决的是输出端可以逐段消费的问题;如果对象本身已经是一个巨大的列表,构造这个对象的成本仍然存在。
几个容易误用的边界
- 不要逐片段解析:片段可能只包含半个结构,完整 JSON 应在整体拼接或由接收端按协议重组后再解析。
- 注意
str与bytes:文件文本模式接收字符串,socket 的字节方法通常需要先按 UTF-8 编码。 - 异常发生在迭代过程中:不可序列化对象、循环引用或不允许的特殊浮点值,可能在消费迭代器时抛出异常,应在写出层做好处理。
- 不要重复 dump 当作协议:JSON 不是自带边界的 framed protocol;在同一个文件中连续 dump 多个对象会得到无法按单份 JSON 解析的内容。
实际选择可以记成一句话:需要完整字符串就用 encode(),需要自己控制逐段消费就用 iterencode(),已经有文本文件对象且不需要自定义循环时用 dump()。
相关问题
iterencode 的每个片段都是合法 JSON 吗?
不一定。它们是同一份 JSON 输出的字符串片段,只有按原顺序组合后,才构成完整 JSON 文档。
iterencode 能不能直接发送到 socket?
如果 socket 接口接收字节,需要先把每个 str 片段按约定编码成 bytes;同时还要由应用协议定义多份 JSON 之间的消息边界。
iterencode 会显著降低对象本身的内存占用吗?
它避免了额外构造一份完整 JSON 字符串,但输入对象仍然要存在,最终节省多少取决于数据结构和输出目标。
-
332 收藏
-
329 收藏
-
377 收藏
-
141 收藏
-
203 收藏
-
342 收藏
-
422 收藏
-
文章 · python教程 | 20分钟前 | python · SQLite · Python order by sqlite3 COLLATE Connection create_collation215 收藏
-
414 收藏
-
255 收藏
-
369 收藏
-
480 收藏
-
336 收藏
-
238 收藏
-
文章 · python教程 | 1天前 | 标准库 · python · Python 参数绑定 Signature BoundArguments inspect.Signature.bind_partial492 收藏
-
273 收藏
-
290 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习