Golang struct tag在反射中的典型应用

struct tag 是附着在结构体字段后的字符串字面量,供反射等工具解析;需用 reflect.StructTag.Get 安全提取,避免手动解析错误。

struct

tag 是什么,为什么反射里总要处理它

Go 的 struct tag 本质是字符串字面量,附着在字段声明后,供反射(reflect 包)或其他工具解析使用。它本身不参与编译或运行时逻辑,但像 jsonyamldb 这类库都依赖它做字段映射。没正确读取 tag,json.Marshal 可能输出空字段,ORM 插入时可能漏列,甚至 panic。

reflect.StructTag.Get 安全提取 tag 值

别直接用 field.Tag 拿原始字符串 —— 它是 reflect.StructTag 类型,实现了 Get(key string) 方法,内部已做引号剥离和空格规整。手动解析容易出错,比如忽略双引号、误判转义。

  • json:"name,omitempty"field.Tag.Get("json") 返回 "name,omitempty"(不含引号)
  • json:""Get 返回空字符串,不是 ""nil
  • key 不存在时返回空字符串,不会 panic
type User struct {
    Name string `json:"name"`
    Age  int    `json:"age,omitempty"`
}
v := reflect.ValueOf(User{Name: "Alice", Age: 0})
t := v.Type()
for i := 0; i < t.NumField(); i++ {
    field := t.Field(i)
    jsonTag := field.Tag.Get("json")
    if jsonTag == "" {
        continue // 跳过无 json tag 字段
    }
    // 解析 jsonTag,如拆分 name 和 omitempty
}

解析 tag value 时必须拆分 key 和 option

json:"user_id,string" 这种写法,value 是逗号分隔的组合体:第一个是字段名(user_id),后面是 flag(stringomitempty)。标准库用 strings.SplitN(tag, ",", 2) 拆,自己写也要照这个逻辑,否则会把 omitempty 当成字段名。

  • 只取第一个 , 左侧作为名称(strings.SplitN(tag, ",", 2)[0]
  • 右侧部分用 strings.FieldsFunc(opts, func(r rune) bool { return r == ',' }) 拆选项
  • 注意:json:"-,omitempty" 中的 - 表示忽略该字段,需单独判断

自定义 tag key 冲突与大小写敏感问题

Go 不限制 tag key 名称,但多个库共存时容易冲突,比如 gorm:"column:user_id"json:"user_id" 都想控制字段名。更隐蔽的是大小写:tag key 是**完全区分大小写**的,JSON:"name"json:"name" 是两个不同 tag,Get("JSON") 找不到后者。

立即学习“go语言免费学习笔记(深入)”;

  • 社区约定小写 key(jsonyamldb),自定义也建议统一小写
  • 如果同时支持多种序列化,别复用同一个 key,比如用 api_jsondb_column 明确区分语义
  • 测试时用 reflect.StructTagLookup 方法可同时获取值和是否存在标志,比 Get 更安全
实际写反射工具时,最常被忽略的是 tag 值为空字符串(`json:""`)和 - 忽略标记的处理逻辑 —— 它们既不是有效字段名,也不能当成默认名 fallback,必须显式分支判断。