如果手里已经是一段带换行和缩进的 JSON,想在接口传输或缓存前去掉结构空白,Go 的 json.Compact 就是针对这个任务的标准库 API。它把 JSON 字节写入 bytes.Buffer,删除对象、数组和标记之间的无意义空白,但不会删除字符串值里的空格,也不会把 Go 结构体重新编码一遍。
官方文档地址:https://pkg.go.dev/encoding/json#Compact
Compact(dst, src) 的关键边界是“已有 JSON 字节”和“结构空白”。源数据必须是可解析的 JSON;字符串中的空格、换行转义和内容都属于值的一部分,不能当作格式空白删除。
src是待处理的 JSON 字节,dst是追加输出的bytes.Buffer。- 返回
error,源 JSON 非法时不要继续使用缓冲区里的结果。 - Compact 只负责紧凑化,不负责从 Go 值编码、重新缩进或 HTML 安全转义。
先分清哪些空白能删、哪些空白不能碰
JSON 对象的冒号、逗号和括号附近的空格通常只是排版;但字符串字面量中的空格属于数据。例如 {"name": "Go 语言"} 可以压成 {"name":"Go 语言"},字符串里的空格仍然保留。这个区别决定了 Compact 适合压缩格式化结果,却不适合用字符串替换规则硬删空格。
用 bytes.Buffer 把格式化 JSON 压成紧凑形式
最小实现只需要一个缓冲区和一段 JSON 字节。示例把错误单独处理,避免源数据非法时仍把部分输出送入下游。
package main
import (
"bytes"
"encoding/json"
"fmt"
)
func main() {
src := []byte("{\n \"name\": \"Go 语言\",\n \"note\": \"保留 内部空格\",\n \"items\": [1, 2]\n}")
var compact bytes.Buffer
// Compact 只删除 JSON 结构空白,不改动字符串值中的内容。
if err := json.Compact(&compact, src); err != nil {
// 非法 JSON 不能当作“压缩成功”,把错误交给调用方处理。
panic(err)
}
// Buffer.String 返回紧凑结果;这里仅用于展示,不代表运行截图。
fmt.Println(compact.String())
}
{"name":"Go 语言","note":"保留 内部空格","items":[1,2]}
注意 note 的两个内部空格没有消失,因为它们位于字符串边界内。若需要把结果直接发送给 HTTP 客户端,可以用 compact.Bytes() 写入请求体;若要保存文件,则应在写文件前确认错误已经是 nil。
压缩适合传输和缓存,但不等于重新编码
接口正文和缓存文件通常更关心体积,Compact 可以减少无意义的换行和缩进。人工审查、配置导出或排障日志则更需要层级,应该保留格式化 JSON,或使用 json.Indent 生成可读版本。不要为了“压缩”把 JSON 当普通文本做全局空格替换,否则很容易改坏字符串值。
| 目标 | 优先 API | 输入与结果 |
|---|---|---|
| 已有 JSON 去掉结构空白 | json.Compact | []byte 写入 bytes.Buffer |
| 已有 JSON 重新排版 | json.Indent | 保留结构并增加层级缩进 |
| Go 值生成 JSON | json.Marshal | 从 Go 值编码成新字节 |
| HTML 脚本中的特殊字符处理 | json.HTMLEscape | 改变字符串中的特定转义形式 |
错误、Buffer 复用和尾随数据要提前判断
Compact 返回错误时,优先丢弃本次 Buffer 或清理到明确边界,不要把可能残留的内容当成完整 JSON。复用缓冲区前调用 Reset,否则新结果会追加在旧结果后面。它也不是流式多文档解析器:如果输入中拼接了多个独立 JSON 值,应先明确协议边界,再分别处理。
如果业务要求把不合法的输入直接拒绝,可以先调用 json.Valid 做快速判断;但不要把这一步误认为 Compact 的替代品,因为 Compact 自身仍会返回解析错误。需要 HTML 安全转义时使用 HTMLEscape,需要重新缩进时使用 Indent,不要把不同职责混在一次字符串处理里。
func compactJSON(src []byte) ([]byte, error) {
var dst bytes.Buffer
// 预留容量只是减少扩容,不改变 Compact 的语义。
dst.Grow(len(src))
if err := json.Compact(&dst, src); err != nil {
// 返回 nil,避免调用者误用不完整的缓冲区内容。
return nil, err
}
result := append([]byte(nil), dst.Bytes()...)
return result, nil
}
Go json.Compact 常见问题
Compact 会删除字符串里的空格吗?
不会。只有 JSON 结构中的无意义空白会被省略,字符串值中的空格、转义换行和其他字符仍是数据。
Compact 能把结构体直接变成紧凑 JSON 吗?
不能。结构体应先用 json.Marshal 或 json.MarshalIndent 编码;Compact 的输入是已有 JSON 字节。
为什么结果 Buffer 里还有旧内容?
因为 Compact 是追加写入。复用 bytes.Buffer 前调用 Reset,或为每次结果使用新的 Buffer。
结语
把 Compact 记成“解析已有 JSON 并删除结构空白”即可:它适合传输和缓存,不改变字符串内容,也不替代编码、缩进和 HTML 转义。只要先处理 error、明确 Buffer 生命周期,再根据消费场景选择紧凑或可读格式,就能避免大多数 JSON 空白问题。