golang结构体转map

结构体转map

借助反射和标签实现结构体转map

代码

go 复制代码
func StructToMap(data any, tagName string) (mp map[string]any, err error) {
	// 初始化一个空的 map 用于存储结果
	mp = make(map[string]any)

	// 使用 reflect 包获取传入数据的反射值
	v := reflect.ValueOf(data)

	// 检查传入的数据是否为结构体类型
	if v.Kind() != reflect.Struct {
		// 如果不是结构体,则返回错误
		err = errors.New("传入转化的对象非结构体")
		return
	}

	// 打印结构体类型信息,可用于调试
	fmt.Println(v.Type())

	// 遍历结构体的每个字段
	for i := 0; i < v.NumField(); i++ {
		// 获取当前字段的反射值
		val := v.Field(i)
		// 获取当前字段的类型信息,并从指定标签中取得 tag 值
		tag := v.Type().Field(i).Tag.Get(tagName)

		// 如果 tag 为空或者等于 "-", 则跳过此字段
		if tag == "" || tag == "-" {
			continue
		}

		// 特别处理指针类型的字段
		if val.Kind() == reflect.Ptr {
			// 如果指针是 nil, 跳过此字段
			if val.IsNil() {
				continue
			}
			// 否则,解引用指针并将其值存入 map 中
			mp[tag] = val.Elem().Interface()
			continue
		}

		// 对于非指针类型的字段,直接将字段值存入 map 中
		mp[tag] = val.Interface()
	}

	// 返回生成的 map 和 nil 错误表示成功
	return
}

工作流程

  1. 初始化结果容器
    • 创建一个空的 map[string]any 来存储转换后的键值对。
  2. 获取传入参数的反射值
    • 使用 reflect.ValueOf(data) 获取传入结构体的反射值 v
  3. 验证输入是否为结构体
    • 检查 v.Kind() 是否等于 reflect.Struct。如果不是,则抛出错误并终止函数执行。
  4. 遍历结构体字段
    • 使用 v.NumField() 方法得到结构体字段的数量,并使用 for 循环迭代这些字段。
  5. 处理每个字段
    • 对于每一个字段,获取其反射值 val 和对应的类型信息。
    • 使用 v.Type().Field(i).Tag.Get(tagName) 获取指定标签名的 tag 值,这通常用于序列化配置(如 JSON, XML 标签)。
    • 如果 tag 是空字符串或者特定标记 -,则跳过该字段,不加入到最终的 map 中。
  6. 处理指针类型字段
    • 当字段是 reflect.Ptr 类型时,额外检查它是否为 nil。如果是非 nil 的指针,解引用指针以获取实际值,并将该值存入 map 中。
  7. 添加字段到 map
    • 将字段值(直接值或指针指向的值)和对应的 tag 名称作为键值对添加到 map 中。
  8. 返回结果
    • 最后,函数返回填充好的 map 和任何可能发生的错误。

测试

go 复制代码
func TestStructToMap(t *testing.T) {
	type successTestStruct struct {
		String string `tag-string:"string"`
		Int    int    `tag-number:"int"`
		Bool   bool   `tag-bool:"bool"`
	}
	var test = successTestStruct{
		String: "测试",
		Int:    10086,
		Bool:   false,
	}
	var testMap map[string]any
	var err error
	if testMap, err = struct_to_map.StructToMap(test, "tag-string"); testMap["string"] != "测试" {
		fmt.Println(err)
		t.Fatal("字符串结构体转map失败")
	} else {
		fmt.Println(testMap)
		t.Log("字符串结构体转map成功")
	}
	if testMap, err = struct_to_map.StructToMap(test, "tag-number"); testMap["int"] != 10086 {
		fmt.Println(err)
		t.Fatal("整型结构体转map失败")
	} else {
		fmt.Println(testMap)
		t.Log("整型结构体转map成功")
	}
	if testMap, err = struct_to_map.StructToMap(test, "tag-bool"); testMap["bool"] != false {
		fmt.Println(err)
		t.Fatal("布尔结构体转map失败")
	} else {
		fmt.Println(testMap)
		t.Log("布尔结构体转map成功")
	}
}

测试结果

bash 复制代码
=== RUN   TestStructToMap
map[string:测试]
    StructToMap_test.go:28: 字符串结构体转map成功
map[int:10086]
    StructToMap_test.go:35: 整型结构体转map成功
map[bool:false]
    StructToMap_test.go:42: 布尔结构体转map成功
--- PASS: TestStructToMap (0.00s)
PASS
相关推荐
CVer儿20 分钟前
qt资料2025
开发语言·qt
DevilSeagull29 分钟前
JavaScript WebAPI 指南
java·开发语言·javascript·html·ecmascript·html5
2zcode1 小时前
基于Matlab不同作战类型下兵力动力学模型的构建与稳定性分析
开发语言·matlab
期待のcode2 小时前
Spring框架1—Spring的IOC核心技术1
java·后端·spring·架构
葵野寺2 小时前
【RelayMQ】基于 Java 实现轻量级消息队列(七)
java·开发语言·网络·rabbitmq·java-rabbitmq
zyx没烦恼3 小时前
Qt 基础编程核心知识点全解析:含 Hello World 实现、对象树、坐标系及开发工具使用
开发语言·qt
木心爱编程3 小时前
C++链表实战:STL与手动实现详解
开发语言·c++·链表
mkhase3 小时前
9.11-QT-QT的基本使用
开发语言·qt
Livingbody4 小时前
10分钟完成 ERNIE-4.5-21B-A3B-Thinking深度思考模型部署
后端
Kyln.Wu4 小时前
【python实用小脚本-211】[硬件互联] 桌面壁纸×Python梦幻联动|用10行代码实现“开机盲盒”自动化改造实录(建议收藏)
开发语言·python·自动化