在使用Go语言的encoding/json包进行结构体序列化时，开发者可能会遇到json.Marshal返回空JSON对象{}的问题。本文将深入探讨这一常见现象的根本原因——Go语言的字段导出规则，并提供详细的解决方案和示例代码，确保结构体数据能够正确地被序列化为JSON格式。
1. 问题现象：json.Marshal返回空对象
在go语言中，当尝试将一个包含数据的结构体通过encoding/json包的json.marshal函数序列化为json字符串时，有时会得到一个空的json对象{}，但同时json.marshal返回的错误err却是nil。这常常让初学者感到困惑，因为结构体本身明明包含了数据，且没有报告任何错误。
考虑以下示例代码，它定义了Address、Name和Person三个结构体，并尝试将一个Person实例序列化为JSON：
package mainimport ( "encoding/json" "fmt")type Address struct { street string extended string city string state string zip string}type Name struct { first string middle string last string}type Person struct { name Name age int address Address phone string}func main() { myname := Name{"Alfred", "H", "Eigenface"} myaddr := Address{"42 Place Rd", "Unit 2i", "Placeton", "ST", "00921"} me := Person{myname, 24, myaddr, "000 555-0001"} b, err := json.Marshal(me) if err != nil { fmt.Println("Error marshalling:", err) return } fmt.Println("Marshalled JSON:", string(b)) // 输出: Marshalled JSON: {} fmt.Println("Original Person struct:", me) // 输出: Original Person struct: { {Alfred H Eigenface} 24 {42 Place Rd Unit 2i Placeton ST 00921} 000 555-0001}}
从上述输出可以看出，string(b)打印的是一个空的JSON对象{}，而me结构体实例本身的数据是完整的。
2. 根本原因：Go语言的字段导出规则
造成json.Marshal返回空对象的核心原因在于Go语言的字段导出（Exported Fields）规则。在Go语言中，一个结构体的字段是否能被包外访问（或被其他包的函数处理），取决于其名称的首字母大小写。
首字母大写的字段是公共的（Public）或已导出的（Exported），可以被其他包访问和处理。首字母小写的字段是私有的（Private）或未导出的（Unexported），只能在定义它们的包内部访问。
encoding/json包在进行JSON序列化时，只会处理结构体中已导出的（首字母大写）字段。对于未导出的字段，json.Marshal会直接忽略它们，不会将其包含在生成的JSON输出中。
立即学习“go语言免费学习笔记（深入）”；
在本例中，Address、Name和Person结构体中的所有字段（如street, first, age等）都是首字母小写的，因此它们都是未导出的私有字段。json.Marshal在尝试序列化这些结构体时，发现没有可导出的字段，所以最终生成了一个空的JSON对象。
为什么err是nil？err为nil表示json.Marshal函数在执行过程中没有遇到任何编码或语法错误。它仅仅表明所有“可访问”（即已导出）的字段都被正确地处理了。由于本例中没有可导出的字段，所以没有错误发生，但结果自然也是空的。
3. 解决方案：导出结构体字段
要解决这个问题，只需将需要序列化到JSON中的结构体字段的首字母改为大写，使其成为已导出的字段。
修改后的结构体定义如下：
package mainimport ( "encoding/json" "fmt")// Address 结构体，字段首字母大写以导出type Address struct { Street string Extended string City string State string Zip string}// Name 结构体，字段首字母大写以导出type Name struct { First string Middle string Last string}// Person 结构体，字段首字母大写以导出type Person struct { Name Name Age int Address Address Phone string}func main() { myname := Name{"Alfred", "H", "Eigenface"} myaddr := Address{"42 Place Rd", "Unit 2i", "Placeton", "ST", "00921"} me := Person{myname, 24, myaddr, "000 555-0001"} b, err := json.Marshal(me) if err != nil { fmt.Println("Error marshalling:", err) return } fmt.Println("Marshalled JSON:", string(b)) fmt.Println("Original Person struct:", me)}
运行上述修改后的代码，将得到以下JSON输出：
Marshalled JSON: {"Name":{"First":"Alfred","Middle":"H","Last":"Eigenface"},"Age":24,"Address":{"Street":"42 Place Rd","Extended":"Unit 2i","City":"Placeton","State":"ST","Zip":"00921"},"Phone":"000 555-0001"}Original Person struct: {{Alfred H Eigenface} 24 {42 Place Rd Unit 2i Placeton ST 00921} 000 555-0001}
此时，json.Marshal成功地将结构体数据序列化为完整的JSON字符串。
4. 进阶：JSON Tag的使用
虽然将字段首字母大写可以解决序列化问题，但在某些情况下，我们可能希望JSON输出的字段名与Go结构体中的字段名不同，或者希望忽略某些已导出的字段。这时，可以使用结构体标签（json tag）来实现更灵活的控制。
例如，如果我们希望Street字段在JSON中显示为street_address，并且忽略Phone字段：
package mainimport ( "encoding/json" "fmt")type Address struct { Street string `json:"street_address"` // JSON输出为 street_address Extended string `json:"extended_info,omitempty"` // 如果为空，则不输出 City string `json:"city"` State string `json:"state"` Zip string `json:"zip"`}type Name struct { First string `json:"first_name"` Middle string `json:"middle_name,omitempty"` Last string `json:"last_name"`}type Person struct { Name Name `json:"full_name"` Age int `json:"age"` Address Address `json:"address_details"` Phone string `json:"-"` // 使用 "-" 标签表示该字段在JSON中被忽略}func main() { myname := Name{"Alfred", "H", "Eigenface"} myaddr := Address{"42 Place Rd", "", "Placeton", "ST", "00921"} // extended 为空 me := Person{myname, 24, myaddr, "000 555-0001"} b, err := json.Marshal(me) if err != nil { fmt.Println("Error marshalling:", err) return } fmt.Println("Marshalled JSON with tags:", string(b))}
输出结果将是：
Marshalled JSON with tags: {"full_name":{"first_name":"Alfred","last_name":"Eigenface"},"age":24,"address_details":{"street_address":"42 Place Rd","city":"Placeton","state":"ST","zip":"00921"}}
可以看到，Street被改名为street_address，Extended字段因为值为空且有omitempty标签而被省略，Phone字段也被完全忽略。
5. 注意事项与总结
字段可见性是关键： 始终记住，只有首字母大写的字段才能被encoding/json包序列化。这是Go语言设计哲学的一部分，用于明确区分包的公共API和内部实现。错误处理： 即使json.Marshal返回的err为nil，也不意味着JSON输出一定是您期望的完整数据。它仅表示序列化过程本身没有遇到语法或编码错误。对于空JSON输出的情况，需要检查结构体字段的导出状态。json tag的灵活性： 善用json tag可以更好地控制JSON输出的格式，包括字段命名、条件省略（omitempty）和完全忽略（-）等。性能考量： 对于大型或频繁序列化的结构体，合理设计字段和使用json tag可以优化JSON输出的大小和处理效率。
通过理解Go语言的字段导出规则，并正确地应用它，开发者可以有效避免json.Marshal返回空JSON对象的问题，确保数据能够按照预期被序列化和反序列化。
以上就是Go语言中结构体JSON序列化为空的深度解析与解决方案的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1410672.html
微信扫一扫 
支付宝扫一扫 
