Go语言struct tag介绍

一、tag说明

先介绍一下``(反引号):反引号用来创建 原生的字符串字面量 ,这些字符串可能由多行组成(不支持任何转义序列),原生的字符串字面量多用于书写多行消息、HTML以及正则表达式 。

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

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

要比较详细的了解这个,要先了解一下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使用的。

二、tag获取

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

package main
 
import (
 "encoding/json"
 "fmt"
 "reflect"
)
 
func main() {
 type User struct {
 UserId int `json:"user_id" bson:"user_id"`
 UserName string `json:"user_name" bson:"user_name"`
 }
 // 输出json格式
 u := &User{UserId: 1, UserName: "tony"}
 j, _ := json.Marshal(u)
 fmt.Println(string(j)) // 输出内容:{"user_id":1,"user_name":"tony"}
 
 // 获取tag中的内容
 t := reflect.TypeOf(u)
 field := t.Elem().Field(0)
 fmt.Println(field.Tag.Get("json")) // 输出:user_id
 fmt.Println(field.Tag.Get("bson")) // 输出:user_id
}

package main
import (
 "fmt"
 "reflect" // 这里引入reflect模块
)
 
type User struct {
 Name string "user name" //这引号里面的就是tag
 Passwd string "user passsword"
}
 
func main() {
 user := &User{"chronos", "pass"}
 s := reflect.TypeOf(user).Elem() //通过反射获取type定义
 for i := 0; i < s.NumField(); i++ {
 fmt.Println(s.Field(i).Tag) //将tag输出出来
 }
}

本文来自:51CTO博客

感谢作者:hgqxjj

查看原文:Go语言struct tag介绍

• 编辑
• 预览