
本文介绍一种基于结构体嵌入的优雅方案:通过将“安全字段”与“敏感字段”分离,并利用 MarshalJSON 方法控制序列化行为,实现在不破坏原有 json tag 语义的前提下,仅在 json.Marshal 时自动省略密码等敏感字段,而 json.Unmarshal 仍能完整解析。
本文介绍一种基于结构体嵌入的优雅方案:通过将“安全字段”与“敏感字段”分离,并利用 `marshaljson` 方法控制序列化行为,实现在不破坏原有 `json` tag 语义的前提下,仅在 `json.marshal` 时自动省略密码等敏感字段,而 `json.unmarshal` 仍能完整解析。
在 Go 的 API 开发中,一个常见且关键的安全需求是:接收用户提交的密码(需反序列化),但绝不在响应中返回密码(需序列化时排除)。若直接使用 json:"-" 或 json:"pwd,omitempty",会导致反序列化失败;而为每个场景定义独立 struct(如 User 和 SafeUser)又易引发字段同步维护问题。
最佳实践是采用 嵌入式分层设计:定义一个基础 User 结构体(含所有需公开传输的字段),再定义一个 UnsafeUser(或更贴切的命名如 UserInput)嵌入 User 并额外添加敏感字段(如 Password)。这样既复用字段定义,又天然隔离序列化逻辑。
以下是推荐实现:
package main
import (
"encoding/json"
"fmt"
)
type User struct {
ID string `json:"id"`
Username string `json:"username"`
// 其他公共字段(如 Email、CreatedAt)可统一在此定义
}
type UserInput struct { // 更语义化的命名:表示“输入/创建时允许携带敏感信息”
User
Password string `json:"pwd"`
}
// MarshalJSON 仅序列化嵌入的 User 部分,自动忽略 Password
func (u UserInput) MarshalJSON() ([]byte, error) {
return json.Marshal(u.User)
}
// 可选:为一致性,也可实现 UnmarshalJSON(但非必需,因默认行为已满足)
// func (u *UserInput) UnmarshalJSON(data []byte) error { ... }
func main() {
origJSON := []byte(`{"id":"1","username":"Chad","pwd":"sillypants"}`)
fmt.Println("Original: " + string(origJSON))
var input UserInput
if err := json.Unmarshal(origJSON, &input); err != nil {
panic(err)
}
fmt.Printf("Unmarshalled: %+v\n", input) // 输出:{User:{ID:"1" Username:"Chad"} Password:"sillypants"}
marshalled, err := json.Marshal(input)
if err != nil {
panic(err)
}
fmt.Println("ReMarshalled: " + string(marshalled)) // 输出:{"id":"1","username":"Chad"}
}
✅ 优势总结:
exa-js 是 Exa 官方 JavaScript 软件开发工具包,Exa 是一个为 AI 工作流构建的网络搜索 API。它为代理提供了一种具体的方式来搜索网络、检索页面内容,并从代码中生成有来源的答案,而不是手动拼接原始 HTTP 调用。
- ✅ 零字段重复:新增字段(如
FirstName)只需在User中声明一次,UserInput自动继承; - ✅ 完全兼容
jsontag:所有字段标签(如json:"id")保持原样,无侵入性修改; - ✅ 语义清晰:
UserInput明确表达“该结构用于接收输入”,避免UnsafeUser等易引发误解的命名; - ✅ 可扩展性强:后续可为不同场景定义
UserUpdate、UserAdminView等嵌入变体,复用同一套核心字段。
⚠️ 注意事项:
- 此方案依赖
MarshalJSON方法,因此序列化必须调用json.Marshal(而非第三方库的非标准实现); - 若需支持
json.RawMessage或复杂嵌套,建议补充单元测试验证边界行为; - 生产环境务必对密码做哈希处理(如
bcrypt),此处仅解决传输层字段控制问题。
通过结构体嵌入与自定义 MarshalJSON,你能在保持代码简洁性的同时,精准控制序列化行为——这才是 Go “组合优于继承”哲学的典型落地。










