理解Go语言json.Marshal的默认行为
在go语言中，当使用encoding/json包的json.marshal函数将一个结构体序列化为json字符串时，默认情况下，它会将结构体中所有导出（public）的字段（即字段名以大写字母开头）的名称直接作为json键名。例如，一个名为foo的字段在json中会表示为"foo"。
然而，在实际的Web服务或API开发中，JSON键名通常遵循小驼峰命名法（camelCase）或蛇形命名法（snake_case），并且通常是小写字母开头。例如，我们可能期望Foo字段在JSON中表示为"foo"。直接使用默认行为会导致JSON输出与预期不符，尤其是在与其他系统进行数据交互时，可能引发兼容性问题。
使用结构体标签（Struct Tags）自定义JSON键名
Go语言提供了一种简洁而强大的机制来解决这个问题：结构体标签（Struct Tags）。通过在结构体字段声明后添加反引号（）包裹的标签，我们可以为encoding/json`包提供额外的指令，告诉它如何处理该字段的序列化和反序列化。
要将大写字段名转换为小写JSON键名，我们可以在字段后添加json:"小写键名"的标签。
核心用法示例
假设我们有一个结构体T，其中包含一个导出字段Foo：
立即学习“go语言免费学习笔记（深入）”；
type T struct {
Foo int
}如果我们直接对其进行json.Marshal，结果将是：
{"Foo":42}为了得到{"foo":42}的输出，我们需要修改结构体定义，为其添加json标签：
type T struct {
Foo int `json:"foo"` // 添加json标签，指定JSON键名为"foo"
}现在，当我们再次序列化T类型的实例时：
package main
import (
"encoding/json"
"fmt"
)
type T struct {
Foo int `json:"foo"` // 指定JSON键名为"foo"
}
func main() {
data := T{Foo: 42}
out, err := json.Marshal(&data)
if err != nil {
fmt.Println("Error marshaling:", err)
return
}
fmt.Println(string(out))
}运行上述代码，输出将是：
{"Foo":42}这正是我们期望的小写键名。
进阶用法：结合其他json标签选项
json标签不仅可以用于重命名键，还可以包含其他选项，以提供更精细的控制。这些选项使用逗号分隔。
- omitempty: 如果字段的值是其类型的零值（例如，int为0，string为空字符串，指针为nil），则在JSON输出中省略该字段。
- -: 完全忽略该字段，不将其包含在JSON输出中。
- string: 将该字段的值序列化为JSON字符串，即使它是一个数字或布尔值。这对于JavaScript中的大整数处理很有用。
示例：结合omitempty
package main
import (
"encoding/json"
"fmt"
)
type Product struct {
ID int `json:"id"`
Name string `json:"name"`
Description string `json:"description,omitempty"` // 如果Description为空，则不输出
Price float64 `json:"price"`
Tags []string `json:"tags,omitempty"` // 如果Tags为空切片，则不输出
}
func main() {
// 示例1: Description和Tags都有值
p1 := Product{
ID: 1,
Name: "Laptop",
Description: "Powerful portable computer",
Price: 1200.50,
Tags: []string{"electronics", "computer"},
}
out1, err := json.MarshalIndent(p1, "", " ") // 使用MarshalIndent美化输出
if err != nil {
fmt.Println("Error marshaling p1:", err)
return
}
fmt.Println("Product 1:")
fmt.Println(string(out1))
// 预期输出：包含description和tags
fmt.Println("\n--------------------\n")
// 示例2: Description和Tags为空
p2 := Product{
ID: 2,
Name: "Mouse",
Price: 25.99,
// Description和Tags字段为空字符串和nil切片，将被omitempty省略
}
out2, err := json.MarshalIndent(p2, "", " ")
if err != nil {
fmt.Println("Error marshaling p2:", err)
return
}
fmt.Println("Product 2:")
fmt.Println(string(out2))
// 预期输出：不包含description和tags
}运行上述代码，输出如下：
Product 1:
{
"id": 1,
"name": "Laptop",
"description": "Powerful portable computer",
"price": 1200.5,
"tags": [
"electronics",
"computer"
]
}
--------------------
Product 2:
{
"id": 2,
"name": "Mouse",
"price": 25.99
}从输出可以看出，当Description和Tags字段为空值时，它们被omitempty选项成功地从JSON输出中省略了。
注意事项与最佳实践
- 一致性: 在整个项目中，尽量保持JSON键名命名风格的一致性（例如，全部小驼峰或全部蛇形）。这有助于提高代码的可读性和可维护性。
- 可读性: 尽管可以为每个字段手动指定json标签，但对于大型结构体，这可能会显得冗余。然而，为了清晰地定义API契约，这种显式定义通常是值得的。
- 反序列化（Unmarshaling）: json标签同样适用于json.Unmarshal。当从JSON字符串解析回Go结构体时，encoding/json会根据这些标签来匹配JSON键和结构体字段。如果JSON键与标签指定的名字匹配，或者与Go字段名（在忽略大小写和下划线的情况下）匹配，它就能正确地进行反序列化。
- 性能: 使用结构体标签对json.Marshal的性能影响微乎其微，无需担心。
- 嵌套结构体: 对于嵌套的结构体，json标签也同样适用。只需在嵌套结构体的字段上添加相应的标签即可。
总结
通过在Go结构体字段上使用json:"key_name"标签，我们可以轻松地将默认的大写导出字段名转换为小写或其他自定义格式的JSON键名。结合omitempty、-等选项，encoding/json包提供了强大的灵活性来控制JSON序列化的输出格式，使其能够更好地适应各种API和数据交换需求。掌握这一技巧是Go语言进行Web开发和API交互的关键能力之一。
