本文探讨在go语言中如何实现json结构体字段的选择性序列化与反序列化，即某个字段只在反序列化时读取，而在序列化时忽略。针对`json:”-“`标签无法满足此需求的问题，文章提出通过语义分离，将结构体拆分为不同用途的类型，并利用结构体嵌入实现这一目标，同时保持代码的清晰性和可维护性。
在Go语言的开发实践中，我们经常需要处理JSON数据的序列化（marshaling）和反序列化（unmarshaling）。有时，一个结构体字段可能在接收外部数据时是必需的（例如敏感信息如密码哈希），但在向外部输出数据时却需要被隐藏或忽略。Go标准库encoding/json提供了结构体标签（json:”fieldName”或json:”-“）来控制这一行为。然而，json:”-“标签会将字段在序列化和反序列化两个方向上都完全忽略，这无法满足只读不写的特定需求。
理解 json:”-” 标签的局限性
json:”-“标签的作用是告诉encoding/json包，在进行JSON编解码时完全忽略带有此标签的字段。这意味着无论是在将JSON数据解析到结构体（反序列化）时，还是将结构体转换为JSON数据（序列化）时，该字段都不会被处理。
考虑以下User结构体：
type User struct { UserName string `json:"userName"` Projects []string `json:"projects"` PasswordHash string `json:"-"` // 此标签会使PasswordHash在读写时均被忽略 IsAdmin bool `json:"isAdmin"`}
如果使用此结构体进行反序列化：
import ( "encoding/json" "fmt")func main() { jsonContent := []byte(`{"userName":"alice","projects":["proj1"],"passwordHash":"some_secret_hash","isAdmin":true}`) var user User err := json.Unmarshal(jsonContent, &user) if err != nil { fmt.Println("Unmarshal error:", err) return } fmt.Printf("反序列化结果: %+vn", user) // 输出: 反序列化结果: {UserName:alice Projects:[proj1] PasswordHash: IsAdmin:true} // PasswordHash 字段为空，因为它被 `json:"-"` 忽略了}
可以看到，PasswordHash字段在反序列化时被忽略了，这与我们的“只读不写”目标不符。
解决方案：语义分离与结构体嵌入
当输入和输出的语义对象存在差异时，最好的做法是在代码中也将其分离。这意味着，如果一个结构体用于接收所有数据（包括敏感字段），而另一个结构体用于对外展示或存储非敏感数据，那么它们应该被定义为不同的Go类型。这种方法通过明确区分数据的用途，避免了单一结构体在不同场景下行为不一致的困境。
我们可以将原始结构体拆分为两个：一个包含所有字段（用于内部处理和反序列化），另一个只包含非敏感字段（用于对外展示和序列化）。通过结构体嵌入（embedding），可以优雅地实现这一目标。
重构后的结构体定义：
// UserInfo 结构体用于对外暴露的用户信息，不包含敏感数据type UserInfo struct { UserName string `json:"userName"` Projects []string `json:"projects"` IsAdmin bool `json:"isAdmin"`}// User 结构体用于内部处理，包含所有字段，包括敏感数据type User struct { UserInfo // 嵌入UserInfo，使其字段可直接访问 PasswordHash string `json:"passwordHash"` // 此处不再使用 "-" 标签}
在这个设计中：
UserInfo代表了用户公开可见或非敏感的信息。User代表了完整的内部用户数据模型，它通过嵌入UserInfo继承了其所有字段，并额外包含了敏感的PasswordHash字段。
适配序列化与反序列化逻辑
有了新的结构体定义，我们可以相应地调整JSON的序列化和反序列化逻辑。
反序列化（读取所有字段）
反序列化时，我们将JSON内容完整地解析到包含所有字段的User结构体中。encoding/json包会自动处理嵌入结构体的字段。
import ( "encoding/json" "fmt")func main() { jsonContent := []byte(`{"userName":"alice","projects":["proj1"],"passwordHash":"some_secret_hash","isAdmin":true}`) var user User err := json.Unmarshal(jsonContent, &user) if err != nil { fmt.Println("Unmarshal error:", err) return } fmt.Printf("反序列化结果: %+vn", user) // 输出: 反序列化结果: {UserInfo:{UserName:alice Projects:[proj1] IsAdmin:true} PasswordHash:some_secret_hash} // PasswordHash 字段现在可以正确地被读取了。}
序列化（只写入非敏感字段）
序列化时，我们只对User结构体中的UserInfo部分进行序列化，从而忽略敏感的PasswordHash字段。
import ( "bytes" "encoding/json" "fmt")func main() { // 假设我们有一个完整的User对象 userToMarshal := User{ UserInfo: UserInfo{ UserName: "bob", Projects: []string{"proj2", "proj3"}, IsAdmin: false, }, PasswordHash: "another_secret_hash_for_bob", } // 关键：只序列化 userToMarshal.UserInfo 部分 userBytes, err := json.Marshal(userToMarshal.UserInfo) if err != nil { fmt.Println("Marshal error:", err) return } // 为了美观输出，进行缩进 var respBuffer bytes.Buffer json.Indent(&respBuffer, userBytes, "", " ") fmt.Println("序列化结果:") fmt.Println(respBuffer.String()) /* 输出: 序列化结果: { "userName": "bob", "projects": [ "proj2", "proj3" ], "isAdmin": false } */ // PasswordHash 字段被成功忽略，不会出现在序列化结果中。}
通过这种方式，我们实现了PasswordHash字段在反序列化时被读取，但在序列化时被忽略的目标。
注意事项与最佳实践
清晰性与可维护性: 这种方法明确了每个结构体的职责，提高了代码的可读性和可维护性。User代表完整的内部数据模型，UserInfo代表对外暴露的视图模型，这种分离符合“关注点分离”的原则。安全性: 确保敏感数据不会意外地通过序列化操作泄露出去，这在处理用户凭证、API密钥等信息时尤为重要。替代方案:自定义 MarshalJSON 和 UnmarshalJSON 方法: 结构体可以实现 json.Marshaler 和 json.Unmarshaler 接口，通过自定义方法来完全控制序列化和反序列化过程。这提供了最大的灵活性，但通常代码量更大，复杂性更高，适用于更复杂的逻辑或特殊格式需求。对于本文所述的简单场景，分离结构体通常是更简洁且易于理解的选择。临时匿名结构体: 在序列化时，可以创建一个只包含所需字段的匿名结构体，然后对其进行序列化。这种方法适用于一次性或特定上下文的需求，例如：
// ... userToMarshal 定义同上 ...tempStruct := struct { UserName string `json:"userName"` Projects []string `json:"projects"` IsAdmin bool `json:"isAdmin"`}{ UserName: userToMarshal.UserName, Projects: userToMarshal.Projects, IsAdmin: userToMarshal.IsAdmin,}userBytes, _ := json.Marshal(tempStruct)
这种方法在字段较少时可行，但当字段较多或需要频繁操作时，不如分离的具名结构体清晰和可维护。
总结
通过将结构体按照其在不同操作（输入/输出）中的语义进行分离，并利用Go语言的结构体嵌入特性，我们可以优雅地解决JSON字段只读不写的问题。这种模式不仅使得代码逻辑更加清晰，也有效提升了数据处理的安全性和灵活性。在实际开发中，应根据具体场景和复杂性，选择最合适的结构体设计和JSON处理策略。对于需要区分读写权限的字段，语义分离通常是比自定义编解码方法更直接、更易于管理的方案。
以上就是Go JSON：如何让结构体字段只被反序列化而不被序列化的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1418290.html
微信扫一扫 
支付宝扫一扫 
