Go 结构体标签(Struct Tag)

原文链接:http://www.01happy.com/golang-struct-tag-desc-and-get/

在处理json格式字符串的时候,经常会看到声明struct结构的时候,属性的右侧还有小米点括起来的内容。形如:

1 type User struct {
2     UserId   int    `json:"user_id" bson:"user_id"`
3     UserName string `json:"user_name" bson:"user_name"`
4 }

这个小米点里的内容是用来干什么的呢?

struct成员变量标签(Tag)说明

要比较详细的了解这个,要先了解一下golang的基础,在golang中,命名都是推荐都是用驼峰方式,并且在首字母大小写有特殊的语法含义:包外无法引用。但是由经常需要和其它的系统进行数据交互,例如转成json格式,存储到mongodb啊等等。这个时候如果用属性名来作为键值可能不一定会符合项目要求。

所以呢就多了小米点的内容,在golang中叫标签(Tag),在转换成其它数据格式的时候,会使用其中特定的字段作为键值。例如上例在转成json格式

u := &User{UserId: 1, UserName: "tony"}
j, _ := json.Marshal(u)
fmt.Println(string(j))
// 输出内容:{"user_id":1,"user_name":"tony"} 

如果在属性中不增加标签说明,则输出:

{"UserId":1,"UserName":"tony"}

可以看到直接用struct的属性名做键值。

其中还有一个bson的声明,这个是用在将数据存储到mongodb使用的。

struct成员变量标签(Tag)获取

那么当我们需要自己封装一些操作,需要用到Tag中的内容时,咋样去获取呢?这边可以使用反射包(reflect)中的方法来获取

t := reflect.TypeOf(u)
field := t.Elem().Field(0) 
fmt.Println(field.Tag.Get("json"))
fmt.Println(field.Tag.Get("bson"))

  

完整代码:

 1 package main
 2  
 3 import (
 4     "encoding/json"
 5     "fmt"
 6     "reflect"
 7 )
 8  
 9 func main() {
10     type User struct {
11         UserId   int    `json:"user_id" bson:"user_id"`
12         UserName string `json:"user_name" bson:"user_name"`
13     }
14     // 输出json格式
15     u := &User{UserId: 1, UserName: "tony"}
16     j, _ := json.Marshal(u)
17     fmt.Println(string(j))
18     // 输出内容:{"user_id":1,"user_name":"tony"}
19  
20     // 获取tag中的内容
21     t := reflect.TypeOf(u)
22     field := t.Elem().Field(0)
23     fmt.Println(field.Tag.Get("json"))
24     // 输出:user_id
25     fmt.Println(field.Tag.Get("bson"))
26     // 输出:user_id
27 }
posted @ 2020-07-18 15:38  -零  阅读(2702)  评论(0编辑  收藏  举报