在Go语言的JSON数据处理场景中,我们常常需要让部分字段仅支持序列化输出,不允许反序列化时被写入,比如用户ID、创建时间这类由系统生成、不应被客户端修改的字段。结构体分离策略就是通过将序列化与反序列化使用的结构体拆分,来达成JSON字段只读不写的目标。

结构体分离策略的实现思路
核心逻辑是定义两个结构体,一个用于JSON序列化输出,包含所有需要返回的字段,其中只读字段正常定义;另一个用于JSON反序列化接收请求参数,不包含只读字段,或者将只读字段设置为不可导出的形式,这样在反序列化时就不会被赋值。
基础示例:用户信息场景
假设我们需要处理用户相关的JSON数据,用户ID、注册时间属于只读字段,昵称、邮箱属于可修改字段。
首先定义用于序列化输出的结构体:
// UserOutput 用于序列化输出,包含所有需要返回的字段
type UserOutput struct {
ID int64 `json:"id"`
Nickname string `json:"nickname"`
Email string `json:"email"`
RegisterAt string `json:"register_at"`
}
接着定义用于反序列化接收参数的结构体,不包含只读的ID和RegisterAt字段:
// UserInput 用于反序列化接收请求参数,只包含可修改的字段
type UserInput struct {
Nickname string `json:"nickname"`
Email string `json:"email"`
}
使用时,序列化阶段使用UserOutput结构体,反序列化阶段使用UserInput结构体,即可实现只读字段不被写入的效果:
package main
import (
"encoding/json"
"fmt"
)
// UserOutput 用于序列化输出,包含所有需要返回的字段
type UserOutput struct {
ID int64 `json:"id"`
Nickname string `json:"nickname"`
Email string `json:"email"`
RegisterAt string `json:"register_at"`
}
// UserInput 用于反序列化接收请求参数,只包含可修改的字段
type UserInput struct {
Nickname string `json:"nickname"`
Email string `json:"email"`
}
func main() {
// 模拟从数据库查询到的用户数据,包含只读字段
user := UserOutput{
ID: 1001,
Nickname: "测试用户",
Email: "test@ipipp.com",
RegisterAt: "2024-01-01 12:00:00",
}
// 序列化输出,只读字段会正常返回
outputBytes, _ := json.Marshal(user)
fmt.Println("序列化结果:", string(outputBytes))
// 模拟接收前端传入的修改请求
inputJSON := `{"nickname":"新昵称","email":"new@ipipp.com","id":999}`
var input UserInput
// 反序列化,只读字段id不会被解析到结构体中
json.Unmarshal([]byte(inputJSON), &input)
fmt.Printf("反序列化结果:%+vn", input)
}
共用基础结构体的优化方式
如果两个结构体的可修改字段有大量重复,可以定义一个基础结构体,让输入输出结构体分别嵌入基础结构体,减少重复代码:
package main
import (
"encoding/json"
"fmt"
)
// UserBase 基础用户结构体,包含可修改的公共字段
type UserBase struct {
Nickname string `json:"nickname"`
Email string `json:"email"`
}
// UserOutput 输出结构体,嵌入基础结构体,新增只读字段
type UserOutput struct {
UserBase
ID int64 `json:"id"`
RegisterAt string `json:"register_at"`
}
// UserInput 输入结构体,直接嵌入基础结构体,不包含只读字段
type UserInput struct {
UserBase
}
func main() {
// 序列化场景
output := UserOutput{
UserBase: UserBase{
Nickname: "测试用户",
Email: "test@ipipp.com",
},
ID: 1001,
RegisterAt: "2024-01-01 12:00:00",
}
outputBytes, _ := json.Marshal(output)
fmt.Println("序列化结果:", string(outputBytes))
// 反序列化场景
inputJSON := `{"nickname":"新昵称","email":"new@ipipp.com","id":999}`
var input UserInput
json.Unmarshal([]byte(inputJSON), &input)
fmt.Printf("反序列化结果:%+vn", input)
}
注意事项
- 如果两个结构体需要互相转换,比如将输入结构体转换为输出结构体用于后续处理,需要手动赋值公共字段,避免遗漏。
- 若只读字段需要参与部分场景的反序列化,可以单独定义对应的输入结构体,不要混用同一个结构体。
- 结构体字段的JSON tag需要保持一致,否则序列化反序列化时字段名映射会出现问题。
适用场景
结构体分离策略适合输入输出字段差异较大、只读字段较多的场景,比如接口的请求参数和返回结果结构差异明显的业务。如果只有个别字段需要只读,也可以考虑使用不可导出字段配合自定义序列化方法的方式,但结构体分离的策略逻辑更清晰,维护性更好。