Go语言中JSON序列化时将字段名转换为小写键名

在Go语言中，为了使结构体的字段能够被外部包访问（即“导出”），其字段名必须以大写字母开头。然而，在进行JSON序列化时，尤其是在与前端或外部API交互时，通常期望JSON的键名采用小写字母（例如snake_case或camelCase）。Go标准库的encoding/json包在默认情况下，会将结构体导出字段的名称直接作为JSON的键名。

例如，考虑以下结构体：

package main

import (
    "encoding/json"
    "fmt"
)

type MyData struct {
    Foo int
    Bar string
}

func main() {
    data := MyData{Foo: 42, Bar: "hello"}
    out, err := json.Marshal(&data)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println(string(out))
}

执行上述代码，将得到如下JSON输出：

{"Foo":42,"Bar":"hello"}

这与我们期望的 {"foo":42,"bar":"hello"} 存在差异。

立即学习“go语言免费学习笔记（深入）”；

解决方案：使用结构体标签（Struct Tags）

Go语言提供了一种简洁而强大的机制来解决这个问题，即结构体标签（Struct Tags）。通过在结构体字段声明后添加反引号（`）包裹的标签字符串，我们可以为encoding/json包提供关于如何处理该字段的额外指令。

要将大写字段名转换为小写JSON键名，我们可以在字段标签中使用json:"fieldName"格式。

package main

import (
    "encoding/json"
    "fmt"
)

// MyDataWithTags 结构体使用json标签来定义JSON键名
type MyDataWithTags struct {
    // Foo 字段将被序列化为JSON键 "foo"
    Foo int `json:"foo"` 
    // Bar 字段将被序列化为JSON键 "bar"
    Bar string `json:"bar"`
    // Baz 字段将被序列化为JSON键 "baz_value"
    Baz int `json:"baz_value"`
}

func main() {
    data := MyDataWithTags{Foo: 42, Bar: "hello", Baz: 100}
    out, err := json.Marshal(&data)
    if err != nil {
        fmt.Println("Error:", err)
        return
    }
    fmt.Println(string(out))
}

运行这段代码，我们将得到期望的输出：

析稿Ai写作

科研人的高效工具：AI论文自动生成，十分钟万字，无限大纲规划写作思路。

142

查看详情

{"foo":42,"bar":"hello","baz_value":100}

通过这种方式，我们不仅可以将字段名转换为小写，还可以将其转换为任意自定义的键名，例如baz_value。

进阶用法与注意事项

除了简单的键名重命名，json标签还支持其他有用的选项，以逗号分隔：

1. omitempty: 如果字段的值是其类型的零值（例如，int为0，string为空字符串""，slice为nil），则在JSON输出中省略该字段。

   type Product struct {
       Name  string `json:"name"`
       Price float64 `json:"price,omitempty"` // 如果Price为0.0，则不显示
       Tags  []string `json:"tags,omitempty"`  // 如果Tags为nil或空切片，则不显示
   }
   
   // 示例：
   // p1 := Product{Name: "Laptop", Price: 1200.0} -> {"name":"Laptop","price":1200}
   // p2 := Product{Name: "Book"} -> {"name":"Book"} (Price和Tags被省略)

   登录后复制

2. - (连字符): 如果将键名设置为-，则该字段在JSON序列化和反序列化时都将被完全忽略。

   type User struct {
       ID       int    `json:"id"`
       Password string `json:"-"` // Password字段将被忽略
       Username string `json:"username"`
   }
   
   // 示例：
   // u := User{ID: 1, Username: "admin", Password: "secret"}
   // out, _ := json.Marshal(u) -> {"id":1,"username":"admin"}

   登录后复制

3. string: 将字段值编码为JSON字符串。这对于int、float或bool类型字段很有用，当它们在JSON中需要表示为字符串时。

   type Item struct {
       ID int `json:"id,string"` // ID会被编码为字符串 "123"
   }
   
   // 示例：
   // item := Item{ID: 123}
   // out, _ := json.Marshal(item) -> {"id":"123"}

   登录后复制

总结

利用Go结构体标签是处理JSON序列化时字段命名问题的标准且推荐的方法。它提供了高度的灵活性，允许开发者精确控制每个字段在JSON中的表示方式，包括键名、是否省略空值以及数据类型转换等。这种方法不仅代码简洁、易于理解，而且符合Go语言的惯用做法，确保了代码的可读性和可维护性。对于大多数Go应用程序而言，使用json标签是解决JSON键名大小写及其他格式化需求的首选方案。

以上就是Go语言中JSON序列化时将字段名转换为小写键名的详细内容，更多请关注php中文网其它相关文章！