登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  python教程

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 仍然会保留完整结果的内存占用;如果目标只是写出,就不必先收集它们。

Python JSONEncoder iterencode 从对象产生多个字符串片段并通过 join 组成完整 JSON 文本的结构说明图
图1:结构说明图,展示对象、JSONEncoder、str 片段与完整 JSON 文本之间的关系;片段只是编码输出,不是独立文档。

怎样把片段逐段写入输出目标

如果输出目标实现了文本写入接口,可以在循环中直接写入每个片段。下面用 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,应另外设计长度前缀、换行分隔或其他明确的消息边界。

Python iterencode 的字符串片段经过文本写入或 UTF-8 编码后到达输出边界并与消息分帧分离的结构说明图
图2:边界说明图,展示字符串片段到文本写入、UTF-8 字节接口的转换关系,并区分序列化与消息分帧。

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 字符串,但输入对象仍然要存在,最终节省多少取决于数据结构和输出目标。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>