Go json.Indent 怎样把 JSON 格式化而不改动字符串内容

如果你已经拿到一段 JSON 字节，只想把对象和数组排版得更容易阅读，json.Indent 会把格式化结果追加到 bytes.Buffer，不会把字符串值里的普通空格当成缩进重新整理。最容易混淆的是 prefix 只负责每个嵌套元素行首的前缀，indent 才负责随层级重复的缩进文本；输入不是合法 JSON 时，函数会返回错误。

官方文档地址：https://pkg.go.dev/encoding/json#Indent

排查 json.Indent 的关键是先看输出目标是否复用、再看两个格式化参数，最后单独检查输入前后的空白边界。字符串内容本身不会因为缩进而被拆行或改写。

• 原始 JSON：传入 src []byte，它必须符合 JSON 语法。
• 输出目标：传入 *bytes.Buffer，结果会追加到现有内容之后。
• 行首样式：prefix 出现在对象或数组元素行的前面，indent 按嵌套深度重复。

先看清 json.Indent 的四个输入

json.Indent(dst, src, prefix, indent) 不是把 Go 结构体重新编码，而是读取已有的 JSON 文本，再把对象和数组中的元素按层级排版到目标缓冲区。dst 可以已有内容，因此它适合把一段 JSON 嵌入更大的输出；如果希望每次得到一份独立结果，应新建缓冲区或先清空它。

下面的静态结构说明图把输入、解析边界和输出目标分开，阅读时重点看“字符串值”与“结构空白”是两类不同的数据。

prefix 和 indent 怎样影响每一行

prefix 是行首固定文本，常用于加上日志标记或层级符号；indent 是每深入一层要重复的文本，常见值是两个空格或一个制表符。函数不会在最外层输出前缀或缩进，所以结果更适合嵌入已有的格式化 JSON。

package main

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

func main() {
    src := []byte(`{"name":"Go 语言","note":"保留  两个空格","items":[{"id":1}]}`)
    var out bytes.Buffer

    // 用固定前缀区分每个结构行，用两个空格表达嵌套层级。
    if err := json.Indent(&out, src, "| ", "  "); err != nil {
        // 输入 JSON 不合法时不要把半成品当成成功结果继续发布。
        log.Fatal(err)
    }

    // 这里的输出是格式化后的 JSON 文本，字符串值仍属于 JSON 数据。
    fmt.Println(out.String())
}

这个例子中，note 字符串里的两个空格仍是字符串数据；数组和对象的换行、前缀及缩进才是 Indent 新增的结构空白。代码块展示的是可复用写法和静态结果关系，不把未在本机执行的输出当成运行截图。

输出看起来不对时，按边界逐项检查

第一项检查是错误返回：源文本存在缺逗号、引号未闭合或结构未结束时，不能只检查 out.String() 是否非空。第二项检查是目标缓冲区：函数会追加结果，复用同一个 buffer 时要明确是否需要先清空。

第三项检查是输入两端的空白。官方文档说明，输入开头的空格、制表符、回车和换行会被丢弃；输入结尾的空白会被保留并复制到输出。因此，如果你在日志中看到尾部换行，不要误判为缩进参数造成的额外内容。

第四项检查是字符串值。普通空格、转义字符和字符串内部的文本不属于结构缩进，不能用“输出换行更多”来判断字符串被改写。若业务要求规范化键顺序、重新编码 Go 值或改变 HTML 转义策略，应换到对应的编码 API，而不是把 Indent 当成通用清洗器。

什么时候改用 MarshalIndent

如果手里已经是 Go 的结构体、切片或映射，通常直接使用 json.MarshalIndent 更清楚：它负责把 Go 值编码成 JSON 并同时设置前缀和缩进。json.Indent 更适合已有 JSON 字节、需要保留原始文本语义并把结果写入指定 buffer 的场景。

package main

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

type Config struct {
    Name  string `json:"name"`
    Retry int    `json:"retry"`
}

func main() {
    value := Config{Name: "worker", Retry: 3}

    // Go 值直接编码为带缩进的 JSON，不需要先手写 src 字节。
    formatted, err := json.MarshalIndent(value, "", "  ")
    if err != nil {
        // 编码失败时保留错误上下文，避免返回空配置。
        log.Fatal(err)
    }

    fmt.Println(string(formatted))
}

可以用下面的速查表决定入口：

常见问题

json.Indent 会改变字符串里的空格吗？

不会把字符串内部的普通空格当成结构缩进。字符串仍是 JSON 值；变化主要发生在对象和数组元素之间的结构空白。

为什么结果最外层没有 prefix？

文档约定追加到 buffer 的数据不以 prefix 或缩进开头，便于嵌入其他已经格式化的 JSON。prefix 从嵌套元素的行首开始出现。

同一个 bytes.Buffer 能连续调用吗？

可以，函数会追加到现有内容；如果你需要独立 JSON 文本，应在下一次调用前清空或新建 buffer，并分别处理每次调用的错误。

json.Indent 能修复不合法 JSON 吗？

不能。它负责排版合法 JSON；缺少逗号、引号或结束括号时，应先修复输入生成逻辑，再根据错误返回定位来源。