0

0

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

P粉602998670

P粉602998670

发布时间:2026-01-08 16:26:40

|

306人浏览过

|

来源于php中文网

原创

必须用 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。

Mapify
Mapify

Mapify是由Xmind推出的AI思维导图生成工具,原名ChatMind

下载

但容易踩的坑是手写 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 -> %s\n", 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 能解决的。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

177

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

226

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

336

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

208

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

388

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

194

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

189

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

191

2025.06.17

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

23

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.1万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号