struct tag 是用反引号包裹的结构化元数据,格式为 key:"value",需严格遵循语法(如引号不可省略、不支持单引号),必须通过 reflect.Tag.Get("key") 显式读取,标准库如 encoding/json 依赖其控制序列化行为。

struct tag 是什么,为什么不能直接用字符串赋值
Go 语言中,struct 的字段标签(tag)不是普通字符串,而是写在字段声明后、用反引号 ` 包裹的结构化元数据。它必须是合法的 Go 字符串字面量(即双引号或反引号包裹),且格式为 key:"value" 键值对组合。如果写成 json: "name"(中间有空格)或漏掉引号,编译器会直接报错:missing value in struct tag 或 unknown struct tag key。
常见错误现象:
- 字段后写了
json:name—— 缺少引号,语法非法 - 用了单引号
json:'name'—— Go 不支持单引号字符串 - 多个 tag 之间没空格,如
json:"name"xml:"Name"db:"user_name"—— 合法,但可读性差;建议用空格分隔
如何正确定义和读取 struct tag
定义时用反引号包裹,每个 tag 以键值对形式存在;读取时必须通过 reflect 包获取字段的 StructField,再调用 Tag.Get("key") 提取值。注意:tag 值本身不参与运行时逻辑,只是静态元信息,必须显式反射读取。
实操要点:
立即学习“go语言免费学习笔记(深入)”;
-
Tag.Get("json")返回的是完整 value 字符串,比如"name,omitempty",需要进一步解析(如用strings.Split()拆分选项) - 若字段未设置某 tag(如没写
json),Tag.Get("json")返回空字符串"",不是nil -
标准库如
encoding/json就是靠反射读取jsontag 来决定序列化行为的
type User struct {
Name string `json:"name" db:"user_name"`
Email string `json:"email,omitempty"`
}
u := User{Name: "Alice"}
t := reflect.TypeOf(u).Field(0) // 获取第一个字段
fmt.Println(t.Tag.Get("json")) // 输出:name
fmt.Println(t.Tag.Get("db")) // 输出:user_name
fmt.Println(t.Tag.Get("xml")) // 输出:(空字符串)
json tag 的常见写法与陷阱
json tag 控制结构体字段在 JSON 序列化/反序列化时的行为,最常用但也最容易踩坑。
关键细节:
-
json:"-"表示该字段完全忽略(不序列化也不反序列化) -
json:"name,omitempty"表示值为零值(""、0、false、nil)时不输出该字段 -
json:"name,string"表示将数字类型(如int)序列化为 JSON 字符串(例如123→"123"),仅对数字和布尔类型有效 - 嵌套结构体字段若未导出(小写开头),即使有
jsontag 也无法被json.Marshal访问——反射无法读取非导出字段
自定义 tag 的使用场景和注意事项
除了 json、xml、yaml 等标准 tag,你可以自由定义任意 key(如 validate、gorm、form),只要你的代码里用 reflect 显式读取即可。
典型用法:
- 表单绑定(如 Gin 的
binding:"required,email") - 数据库映射(GORM 的
gorm:"column:user_name;type:varchar(100)") - 参数校验(
validate:"min=1,max=100")
容易被忽略的一点:tag 值中的空格、引号、逗号都是你解析逻辑的一部分。比如 validate:"required,min=10",不能指望 Tag.Get("validate") 自动帮你拆成规则列表——得自己用 strings.Split 或正则提取。
另外,不同库对同一 tag key 的解析方式可能冲突(比如两个包都读 json,但一个加了额外语义),要留意依赖库是否覆盖或扩展了标准行为。










