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

Go json.Encoder 怎样设置缩进输出

来源:17golang原创

时间:2026-10-14 17:21:58 256浏览 收藏

如果 JSON 是连续写入日志、文件或响应流,直接调用 json.NewEncoder(writer).Encode(value) 得到的内容通常是紧凑格式。需要人读、排查或保留层级时,不必先把整个对象改成字节切片,给同一个 json.Encoder 调用 SetIndent("", " ") 即可。第一个参数是每行的前缀,第二个参数是按嵌套层级重复的缩进字符串;设置后会作用于后续的 Encode。

最小结论是:SetIndent(prefix, indent) 只改变 JSON 的排版,不改变字段值、对象结构或解码语义;想恢复紧凑输出时调用 SetIndent("", "")。下面只讨论 json.Encoder 的缩进边界,不把 HTML 字符处理和第三方 JSON 库混进来。

要点速览
  • prefix 决定每个缩进行的固定前缀,常用空字符串。
  • indent 决定嵌套层级的重复内容,两个空格或一个制表符都可以。
  • 设置会影响后续编码值,空的 prefix 与 indent 可以关闭缩进。

SetIndent 控制的是哪一层

json.NewEncoder 把编码结果写入一个 io.Writer,例如文件、缓冲区或 HTTP 响应。SetIndent 处在“编码器的输出格式”这一层:它不负责选择字段,也不负责校验业务数据,只告诉编码器怎样排列对象和数组的换行与空白。

prefix 会出现在每个需要缩进的行前面,适合给日志片段加统一标识;indent 会随着嵌套深度重复。若把二者都设为空字符串,编码器回到紧凑输出。因为设置针对的是编码器实例,所以阅读代码时应把它和同一个实例后续的 Encode 调用放在一起看。

Go json.Encoder、SetIndent、prefix、indent 与后续 Encode 的静态关系说明图
图1:结构说明图,查看输出目标、格式参数和 Encoder 之间的静态关系。

用最小代码让连续 Encode 保持缩进

日志或导出程序通常会复用一个编码器。下面的写法把缩进设置放在第一次编码前,后面的多个值就共用这项输出格式。示例使用 bytes.Buffer 只是为了表达一个内存中的写入目标,换成文件或响应写入器时,SetIndent 的用法不变。

package main

import (
    "bytes"
    "encoding/json"
    "fmt"
)

func main() {
    var out bytes.Buffer
    enc := json.NewEncoder(&out)

    // 空前缀、两个空格缩进,适合日志和人工查看的 JSON。
    enc.SetIndent("", "  ")

    // 同一个 Encoder 的后续 Encode 都沿用这项排版设置。
    if err := enc.Encode(map[string]any{"name": "go", "enabled": true}); err != nil {
        panic(err)
    }
    if err := enc.Encode(map[string]any{"items": []int{1, 2, 3}}); err != nil {
        panic(err)
    }

    // 这里仅展示写入目标中的文本,不代表运行截图或线上结果。
    fmt.Print(out.String())
}

示例里两个 Encode 都属于同一个编码器实例,因此都使用相同的缩进规则。Encode 本身还会在每个编码值后写入换行,这和对象内部的层级缩进是两件事:前者便于连续记录,后者便于阅读一个值的结构。

prefix、indent 和关闭方式怎样选择

大多数服务只需要 SetIndent("", " ")。如果日志系统希望每一行都带固定标识,可以设置 prefix;如果输出要尽量紧凑,则让 indent 为空。不要把 prefix 当作层级空格,它是每个缩进行都可能出现的固定文本。

配置适合场景注意点
"", " "调试日志、配置导出层级清晰,文本更长
"> ", " "需要给缩进行加统一标识的文本prefix 会重复出现在缩进行前
"", "\t"希望用制表符表示层级不同查看器的显示宽度可能不同
"", ""恢复紧凑输出影响后续 Encode,不会改写已经写出的内容

关闭缩进的代码同样简单:

// 根据输出目的切换排版;空参数表示后续值使用紧凑格式。
enc.SetIndent("", "")
if err := enc.Encode(value); err != nil {
    // 真实程序中应把写入错误交给调用方,而不是静默忽略。
    return err
}
Go json.Encoder 的 prefix、indent、连续 Encode 与关闭缩进关系说明图
图2:参数关系说明图,对照 prefix、indent、连续 Encode 和恢复紧凑格式的范围。

不要把 Encoder 缩进和 MarshalIndent 混为一谈

Encoder.SetIndent 适合已经有 io.Writer 的流式输出,设置一次后可以服务同一编码器的后续值;json.MarshalIndent 则返回一份经过格式化的字节切片,更适合需要先拿到完整结果再保存或传递的场景。两者都能产生可读 JSON,但内存和写入边界不同。

如果只是把一个小对象格式化后交给另一个函数,MarshalIndent 更直接;如果程序本来就在逐个写日志记录或响应内容,继续复用 Encoder,只在合适的位置调用 SetIndent。当同一编码器在一次任务中切换格式时,要明确切换点,因为它不会回头修改已经写出的文本。

常见问题

SetIndent 会改变 JSON 数据吗?

不会。它改变的是换行和空白的排布,字段值与结构仍由原对象决定。

能不能只让某一次 Encode 缩进?

可以在该次调用前设置缩进,并在下一次调用前用 SetIndent("", "") 关闭;但已经写入的内容不会被重新排版。

为什么看不到缩进?

先确认调用的是同一个 Encoder 实例,并检查是否在 Encode 之后才设置;设置只影响后续编码值。还要确认传入的 indent 不是空字符串。

因此,Go 的 JSON 流式输出需要可读层级时,先创建编码器,再设置 SetIndent("", " "),随后复用它完成编码;需要压缩时再用空参数关闭。这个边界明确后,prefix、indent、Encode 和 MarshalIndent 各自负责什么就不会混在一起。

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