Go 中如何优雅地打印变量(Pretty Print)

go 语言虽无内置类似 ruby `awesome_print` 的调试打印工具,但可通过标准库 `encoding/json` 的 `marshalindent` 实现结构清晰、缩进美观的变量输出,尤其适合调试 map、slice、struct 等复合类型。

在 Go 开发中,快速、可读性强的变量调试输出至关重要。虽然 fmt.Printf("%#v", x) 能显示变量的完整类型和值,但其输出格式面向 Go 语法而非人类阅读——嵌套深、无换行、缩进缺失,不利于快速理解数据结构。

更优雅的替代方案是使用标准库 encoding/json 提供的 json.MarshalIndent。它将支持 JSON 序列化的类型(如 map, slice, struct,且字段需为导出字段)转换为格式化良好的 JSON 字符串,天然具备缩进与换行,视觉效果接近 awesome_print:

package main

import (
    "encoding/json"
    "fmt"
)

func main() {
    x := map[string]interface{}{"a": 1, "b": 2, "nested": []int{3, 4, 5}}

    b, err := json.MarshalIndent(x, "", "  ")
    if err != nil {
        fmt.Println("JSON marshaling error:", err)
        return
    }

    fmt.Print(string(b))
}

输出结果:

{
  "a": 1,
  "b": 2,
  "nested": [
    3,
    4,
    5
  ]
}

优势:零依赖、标准库保障、输出整洁、天然支持嵌套结构。
⚠️ 注意事项

  • 仅支持 JSON 可表示的类型(如 int, string, bool, nil, map[string]interface{}, []interface{} 等);
  • 非导出字段(小写首字母 struct 字段)会被忽略;
  • 不支持函数、channel、unsafe.Pointer、含循环引用的结构体,会返回错误;
  • 若需打印任意类型(包括未导出字段或非 JSON 类型),建议搭配第三方库如 go-spew 或 pretty,它们提供更全面的反射式深度打印能力。

综上,json.MarshalIndent 是标准库中最贴近“Pretty Print”体验的轻量级方案;追求极致调试体验时,再按需引入成熟第三方库即可。