golang获取结构体中的tag_26. Go 语言中结构体的 Tag 用法

大家好，我是明哥。

由于某些不可抗力，之前该专栏的所有内容都被删除了。因此之后的一段时间内，我会重新发布这些文章，先给已经看过的关注者提个醒。

本文原文：http://golang.iswbm.com

Github：http://github.com/iswbm/GolangCodingTime

1. 抛砖引玉：什么是 Tag？

正常情况下，你定义的结构体是这样子的，每个字段都由名字和字段类型组成

type Person struct {Name string Age  int   Addr string
}

也有例外，就像下面这样子，字段上还可以额外再加一个属性，用反引号（Esc键下面的那个键）包含的字符串，称之为 Tag，也就是标签。

type Person struct {Name string `json:"name"`Age  int    `json:"age"`Addr string `json:"addr,omitempty"`
}

那么这个标签有什么用呢？

这边先以 encoding/json 库的用法抛砖引玉，看一下它能起到什么样的效果。

package mainimport ("encoding/json""fmt"
)type Person struct {Name string `json:"name"`Age  int    `json:"age"`Addr string `json:"addr,omitempty"`
}func main() {p1 := Person{Name: "Jack",Age:  22,}data1, err := json.Marshal(p1)if err != nil {panic(err)}// p1 没有 Addr，就不会打印了fmt.Printf("%sn", data1)// ================p2 := Person{Name: "Jack",Age:  22,Addr: "China",}data2, err := json.Marshal(p2)if err != nil {panic(err)}// p2 则会打印所有fmt.Printf("%sn", data2)
}

由于 Person 结构体里的 Addr 字段有 omitempty 属性，因此 encoding/json 在将对象转化 json 字符串时，只要发现对象里的 Addr 为 false， 0，空指针，空接口，空数组，空切片，空映射，空字符串中的一种，就会被忽略。

因此运行后，输出的结果如下

$ go run demo.go
{"name":"Jack","age":22}
{"name":"Jack","age":22,"addr":"China"}

2. 不懂就问：如何定义获取 Tag ？

Tag 由反引号包含，由一对或几对的键值对组成，通过空格来分割键值。格式如下

`key01:"value01" key02:"value02" key03:"value03"`

定义完后，如何从结构体中，取出 Tag 呢？

答案就是，我们上一节学过的 "反射"。

获取 Tag 可以分为三个步骤：

获取字段 field

获取标签 tag

获取键值对 key:value

演示如下

// 三种获取 field
field := reflect.TypeOf(obj).FieldByName("Name")
field := reflect.ValueOf(obj).Type().Field(i)  // i 表示第几个字段
field := reflect.ValueOf(&obj).Elem().Type().Field(i)  // i 表示第几个字段// 获取 Tag
tag := field.Tag // 获取键值对
labelValue := tag.Get("label")
labelValue,ok := tag.Lookup("label")

获取键值对，有Get 和 Lookup 两种方法，但其实 Get 只是对 Lookup 函数的简单封装而已，当没有获取到对应 tag 的内容，会返回空字符串。

func (tag StructTag) Get(key string) string {v, _ := tag.Lookup(key)return v
}

空 Tag 和不设置 Tag 效果是一样的

package mainimport ("fmt""reflect"
)type Person struct {Name string ``Age string
}
func main() {p := reflect.TypeOf(Person{})name, _ := p.FieldByName("Name")fmt.Printf("%qn", name.Tag) //输出 ""age, _ := p.FieldByName("Age")fmt.Printf("%qn", age.Tag) // 输出 ""
}

3. 实战一下：利用 Tag 搞点事情？

学会了如何定义 tag 和获取 tag，可以试着利用 tag 来做一些事情，来练习一下。

这边我举个例子吧。

如果我想实现一个函数（就叫 Print 吧），在打印 person 对象时，能够美化输出

type Person struct {Name        string Age         int    Gender      string
}person := Person{Name:        "MING",Age:         29,
}Print(person)

就像下面这样，key 和 value 之间有个 is:，如果没有指定 Gender 的值，那么显示为unknown（未知）。

Name is: MING
Age is: 29
Gender is: unknown

那该怎么做呢？

先改造下 Person 结构体，给每个字段加上 tag 标签，三个字段的tag 都有 label 属性，而 Gender 多了一个 default 属性，意在指定默认值。

type Person struct {Name        string `label:"Name is: "`Age         int    `label:"Age is: "`Gender      string `label:"Gender is: " default:"unknown"`
}

然后来写一下这个 Print 函数

func Print(obj interface{}) error {// 取 Valuev := reflect.ValueOf(obj)// 解析字段for i := 0; i < v.NumField(); i++ {// 取tagfield := v.Type().Field(i)tag := field.Tag// 解析label 和 defaultlabel := tag.Get("label")defaultValue := tag.Get("default")value := fmt.Sprintf("%v", v.Field(i))if value == "" {// 如果没有指定值，则用默认值替代value = defaultValue}fmt.Println(label + value)}return nil
}

最后执行一下，看了下输出，符合我们的预期：

$ go run demo.go
Name is: MING
Age is: 29
Gender is: unknown

到此，我们就把 Tag 的用法介绍完了。

好了，今天的文章就到这里了。

若今天的分享对你有帮助，不如点个赞，支持一下？