打开APP
userphoto
未登录

开通VIP,畅享免费电子书等14项超值服

开通VIP
Go 语言系列39:结构体里的 Tag 标签

在之前 Go 语言系列14:结构体 我们讲过结构体的使用,一般情况下,我们定义结构体每个字段都是由字段名字以及字段的类型构成,例如:

type Person struct {
    Name   string
    Age    int
    Gender string
}


Tag 的使用

但这一期要讲的是在字段上增加一个属性,这个属性是用反引号括起来的一个字符串,我们称之为 Tag(标签) 。例如:

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

结构体的 Tag 可以是任意的字符串面值,但是通常是一系列用空格分隔的 key:"value" 键值对序列;因为值中含有双引号字符,因此成员 Tag 一般用原生字符串面值的形式书写。一般我们常用在 JSON 的数据处理方面。

json 开头键名对应的值用于控制 encoding/json 包的编码和解码的行为,并且 encoding/... 下面其它的包也遵循这个约定。Tagjson 对应值的第一部分用于指定 JSON 对象的名字,比如将 Go 语言中的 TotalCount 成员对应到 JSON 中的 total_count 对象。

上面的例子中 gender 字段的 Tag 还带了一个额外的 omitempty 选项,表示当 Go 语言结构体成员为空或零值时不生成该 JSON 对象(这里 false 为零值)。例如:

package main

import (
 "encoding/json"
 "fmt"
)

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

func main() {
 // Person 1 without Gender
 person1 := Person{
  Name: "菜籽",
  Age: 25,
 }
 // 结构体转为 JSON
 data1, err := json.Marshal(person1)
 if err != nil {
  panic(err)
 }
 // person1 won't print Gender attribute
 fmt.Printf("%s\n", data1)

 // Person 2 have Gender attribute
 person2 := Person{
  Name: "Tom",
  Age: 18,
  Gender: "male",
 }
 // 结构体转为 JSON
 data2, err := json.Marshal(person2)
 if err != nil {
  panic(err)
 }
 // person2 will print Gender attribute
 fmt.Printf("%s\n", data2)
}

运行该程序输出如下的结果:

{"name":"菜籽","age":25}
{"name":"Tom","age":18,"gender":"male"}

可以看到,因为 Gender 字段里有 omitempty 属性,因此 encoding/json 在将此结构体对象转化为 JSON 字符串时,发现对象里面的 Gender 为 false , 0 ,空指针,空接口,空数组,空切片,空映射,空字符串中的一种,就会被忽略。

Tag 的获取

Tag 的格式上面已经说了,它是由反引号括起来的一系列用空格分隔的 key:"value" 键值对序列:

`key1:"value1" key2:"value2" key3:"value3"`

那么我们如何获取到结构体中的 Tag 呢?这里我们用反射的方法。

使用反射的方法获取 Tag 步骤如下:

  1. 获取字段
  2. 获取 Tag
  3. 获取键值对

其中获取字段有三种方式,而获取键值对有两种方式。

// 三种获取 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 当没有获取到对应 Tag 的内容,会返回空字符串

下面是一个获取 Tag 以及键值对的例子:

package main

import (
 "fmt"
 "reflect"
)

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

func main() {
 p := reflect.TypeOf(Person{})
 name, _ := p.FieldByName("Name")
 tag := name.Tag
 fmt.Println("Name Tag :", tag)
 keyValue, _ := tag.Lookup("json")
 fmt.Println("key: json, value:", keyValue)
}

运行上面的程序输出如下:

Name Tag : json:"name"
key: json, value: name

参考文献:

[1] Alan A. A. Donovan; Brian W. Kernighan, Go 程序设计语言, Translated by 李道兵, 高博, 庞向才, 金鑫鑫 and 林齐斌, 机械工业出版社, 2017.

👇周一至周五更新,期待你的关注👇

本站仅提供存储服务,所有内容均由用户发布,如发现有害或侵权内容,请点击举报
打开APP,阅读全文并永久保存 查看更多类似文章
猜你喜欢
类似文章
【热】打开小程序,算一算2024你的财运
【七天入门Go语言】 文件 && 包 | 第五天
Go语言基础之结构体(冬日篇)
Golang的Json encode/decode以及[]byte和string的转换
golang之json小谈
Go语言基础之结构体
一篇文章教会你Go语言基础之结构体反射
更多类似文章 >>
生活服务
热点新闻
分享 收藏 导长图 关注 下载文章
绑定账号成功
后续可登录账号畅享VIP特权!
如果VIP功能使用有故障,
可点击这里联系客服!

联系客服