Golang反射获取结构体tag的实现方式

9次阅读

必须用 reflect.StructTag.Get(“key”) 解析结构体字段 tag,它自动处理引号、转义和空格;不能字符串分割,Get 不存在时返回空字符串;嵌套字段需手动递归遍历,匿名字段 tag 不自动继承。

Golang 反射获取结构体 tag 的实现方式

reflect.StructTag 解析结构体字段的 tag 字符串

Go 的反射不能直接“读取 tag 的某个 key”,必须先用 reflect.StructField.Tag 拿到原始字符串(如 `json:"name,omitempty" db:"user_name"`),再调用 Get 方法提取指定 key 的值。这个字符串本质是 reflect.StructTag 类型,它实现了 Get(key string) string 方法。

常见错误是把 Tag 当成普通字符串去 strings.Split 或正则匹配——既不可靠(没处理引号转义),也不符合 Go 的设计约定。

  • Tag 是结构体字段的 reflect.StructField 字段的属性,类型为 reflect.StructTag
  • 必须用 field.Tag.Get("json") 获取 json key 对应的值,不是 field.Tag["json"](语法错误)
  • 如果 key 不存在,Get 返回空字符串,不会 panic

嵌套结构体或匿名字段时 tag 不会自动继承

反射获取的是当前字段自身的 tag,不关心它指向的类型有没有同名 tag。比如字段是 Address 结构体,即使 Address 的字段有 json tag,也不会影响外层字段的 field.Tag.Get("json") 结果——它只看 type User struct {Addr Address `json:"address"`} 这个 Addr 字段自己声明的 tag。

若想递归提取嵌套字段的 tag(比如生成完整 JSON 路径),需手动遍历 field.Type 并逐层调用 reflect.TypeOf(……).Elem().Field(i),不能依赖外层字段的 tag 透传。

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

  • 匿名字段(内嵌)的 tag 只在它被提升(promoted)时才参与外层结构体的字段查找,但 reflect.StructField.Tag 仍只返回该字段自身定义的 tag
  • 如果字段类型是指针(如 *Address),需先 Elem() 才能拿到目标结构体类型,否则 NumField() 为 0

注意 tag 值里的空格、逗号和引号处理

reflect.StructTag.Get 内部已按 RFC 规范解析:忽略 key 后的空格,支持双引号 / 反引号包裹的值,自动去除引号并解码转义(如 "a"b"a"b)。你不需要自己写 parser。

但容易踩的坑是手写 tag 字符串时漏掉引号或写错分隔符。例如:`json:name` 是非法的,必须是 `json:"name"``json:"name,omitempty,foo"` 中的 foo 不会被识别为选项,因为标准 tag 解析只认 omitempty 和自定义 flag(需自行解析值内容)。

  • 多个 tag 用空格分隔,不是逗号:`json:"name" db:"user_name"` ✅,`json:"name",db:"user_name"`
  • 值中含双引号必须转义:`json:"a"b"`,否则编译失败
  • 使用反引号可避免大部分转义,但值里不能出现反引号本身

完整示例:遍历结构体所有字段并打印 json tag

以下代码演示如何安全获取每个导出字段的 json tag,跳过非结构体字段,并处理匿名字段:

package main  import ("fmt" 	"reflect")  type User struct {Name  string `json:"name"` 	Age   int    `json:"age,omitempty"` 	Email string `json:"email"`}  func printJSONTags(v interface{}) {rv := reflect.ValueOf(v) 	if rv.Kind() == reflect.Ptr { 		rv = rv.Elem() 	} 	if rv.Kind() != reflect.Struct { 		return}  	rt := rv.Type() 	for i := 0; i < rt.NumField(); i++ {field := rt.Field(i) 		if !field.IsExported() { 			continue} 		jsonTag := field.Tag.Get("json") 		if jsonTag == ""{jsonTag = field.Name // fallback to field name} else if idx := strings.Index(jsonTag,","); idx > 0 {jsonTag = jsonTag[:idx] // strip options like omitempty 		} 		fmt.Printf("%s -> %sn", field.Name, jsonTag) 	} }  func main() { 	u := User{Name:"Alice"} 	printJSONTags(&u) }

注意:示例中用了 strings.Index 剥离 omitempty 等选项,这是常见需求,但 reflect.StructTag 本身不提供该能力——它只负责基础 key-value 提取,其余逻辑由你控制。

真正难的不是取 tag,而是决定什么时候忽略它、怎么合并嵌套 tag、是否支持自定义解析规则(比如 form:"user.name" 映射到嵌套路径)。这些都得在反射遍历之外额外建模,不是 Tag.Get 能解决的。

text=ZqhQzanResources