本文详细介绍了在go语言中如何使用`encoding/json`包的`marshalindent`函数来美化输出json数据。通过设置前缀和缩进字符串，可以使json结构更具可读性，无论是对go数据结构进行编码，还是对现有json字符串进行格式化，都能轻松实现。
在Go语言开发中，处理JSON数据是常见的任务。无论是构建API响应、配置文件还是日志输出，JSON的简洁性使其成为理想的数据交换格式。然而，当JSON数据变得复杂或嵌套层级较深时，未经格式化的输出会非常难以阅读和调试。这时，对JSON进行“美化打印”（Pretty-print）就显得尤为重要。Go语言标准库中的encoding/json包提供了简单而强大的方法来实现这一目标。
核心方法：json.MarshalIndent
Go语言标准库encoding/json包提供了MarshalIndent函数，专门用于生成带有缩进和换行的JSON输出。它的函数签名如下：
该函数接受三个参数：
- v interface{}：要编码的Go数据结构。它可以是任何Go类型，如结构体、映射、切片等。
- prefix string：在每个JSON行前添加的前缀字符串。通常为空字符串””，如果需要为每行添加特定标识，则可以使用。
- indent string：用于表示一个缩进级别的字符串。常见的选择是四个空格” “或一个制表符”t”。
MarshalIndent函数返回一个字节切片，其中包含美化后的JSON数据，以及一个错误对象（如果编码过程中发生错误）。
立即学习“go语言免费学习笔记（深入）”；
使用示例
下面通过一个具体的例子来演示如何使用json.MarshalIndent美化打印Go数据结构。
package main import ( "encoding/json" "fmt" "log" ) // User 定义一个示例结构体 type User struct { ID int `json:"id"` Name string `json:"name"` Email string `json:"email"` IsActive bool `json:"is_active"` Roles []string `json:"roles"` Settings map[string]interface{} `json:"settings"` } func main() { // 示例数据 userData := User{ ID: 101, Name: "Alice Smith", Email: "alice.smith@example.com", IsActive: true, Roles: []string{"admin", "editor"}, Settings: map[string]interface{}{ "theme": "dark", "notifications": map[string]bool{ "email": true, "sms": false, }, }, } // 1. 使用 json.Marshal 进行常规编码 (无美化) fmt.Println("--- 常规 JSON 输出 ---") rawJSON, err := json.Marshal(userData) if err != nil { log.Fatalf("常规编码失败: %v", err) } fmt.Println(string(rawJSON)) fmt.Println() // 2. 使用 json.MarshalIndent 进行美化编码 (四空格缩进) fmt.Println("--- 美化 JSON 输出 (四空格缩进) ---") prettyJSONSpaces, err := json.MarshalIndent(userData, "", " ") if err != nil { log.Fatalf("美化编码失败 (四空格): %v", err) } fmt.Println(string(prettyJSONSpaces)) fmt.Println() // 3. 使用 json.MarshalIndent 进行美化编码 (制表符缩进) fmt.Println("--- 美化 JSON 输出 (制表符缩进) ---") prettyJSONTabs, err := json.MarshalIndent(userData, "", "t") if err != nil { log.Fatalf("美化编码失败 (制表符): %v", err) } fmt.Println(string(prettyJSONTabs)) fmt.Println() }
输出结果（部分）：
Easily find JSON paths within JSON objects using our intuitive Json Path Finder
30 
--- 常规 JSON 输出 --- {"id":101,"name":"Alice Smith","email":"alice.smith@example.com","is_active":true,"roles":["admin","editor"],"settings":{"notifications":{"email":true,"sms":false},"theme":"dark"}} --- 美化 JSON 输出 (四空格缩进) --- { "id": 101, "name": "Alice Smith", "email": "alice.smith@example.com", "is_active": true, "roles": [ "admin", "editor" ], "settings": { "notifications": { "email": true, "sms": false }, "theme": "dark" } } --- 美化 JSON 输出 (制表符缩进) --- { "id": 101, "name": "Alice Smith", "email": "alice.smith@example.com", "is_active": true, "roles": [ "admin", "editor" ], "settings": { "notifications": { "email": true, "sms": false }, "theme": "dark" } }
从输出可以看出，MarshalIndent生成的JSON数据结构清晰，易于阅读。
处理现有JSON字符串
除了对Go数据结构进行美化编码外，有时我们可能需要美化一个已经存在的JSON字符串。MarshalIndent函数本身并不直接接受JSON字符串作为输入，但我们可以通过先将其反序列化（Unmarshal）为一个interface{}类型，然后再序列化（Marshal）回来，从而实现美化。
package main import ( "encoding/json" "fmt" "log" ) func main() { // 一个未经格式化的JSON字符串 jsonString := `{"name":"Bob","age":30,"city":"New York","hobbies":["reading","coding"]}` fmt.Println("--- 原始 JSON 字符串 ---") fmt.Println(jsonString) fmt.Println() // 1. 将JSON字符串反序列化为 interface{} var data interface{} err := json.Unmarshal([]byte(jsonString), &data) if err != nil { log.Fatalf("反序列化失败: %v", err) } // 2. 使用 MarshalIndent 将 interface{} 重新序列化为美化后的JSON fmt.Println("--- 美化后的 JSON 字符串 ---") prettyJSON, err := json.MarshalIndent(data, "", " ") // 使用两个空格缩进 if err != nil { log.Fatalf("美化序列化失败: %v", err) } fmt.Println(string(prettyJSON)) }
输出结果：
--- 原始 JSON 字符串 --- {"name":"Bob","age":30,"city":"New York","hobbies":["reading","coding"]} --- 美化后的 JSON 字符串 --- { "age": 30, "city": "New York", "hobbies": [ "reading", "coding" ], "name": "Bob" }
这种方法非常灵活，可以用于任何来源的JSON字符串美化。
注意事项
- 性能开销： 美化打印会增加JSON数据的体积（因为增加了换行符和空格），并可能带来轻微的性能开销。在对性能要求极高的生产环境API响应中，通常会选择不美化输出以减少网络传输量。但在开发、调试、日志记录或生成配置文件时，美化打印的优势远大于其开销。
- 缩进风格： 统一的缩进风格（如始终使用四个空格或一个制表符）有助于团队协作和代码一致性。
- 错误处理： 在实际应用中，始终要对json.MarshalIndent和json.Unmarshal可能返回的错误进行适当处理，以确保程序的健壮性。
总结
json.MarshalIndent是Go语言中一个非常实用的函数，它能够帮助开发者轻松地将JSON数据格式化为易于阅读的结构。无论是直接处理Go数据结构，还是对现有JSON字符串进行美化，通过合理设置prefix和indent参数，都能获得清晰、专业的JSON输出。掌握这一技巧，将大大提升Go语言中JSON数据处理的效率和可维护性。