golang 结构体tag - Golang教程网

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使用的。

其实反引号就是字符串。

Go语言中的字符串字面量使用双引号或反引号来创建 ：

双引号用来创建 可解析的字符串字面量 (支持转义，但不能用来引用多行)；
反引号用来创建 原生的字符串字面量 ，这些字符串可能由多行组成(不支持任何转义序列)，原生的字符串字面量多用于书写多行消息、HTML以及正则表达式。

fmt.Println(`raw string`)

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"))

　　完整代码如下：
 
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
}

json可以加上omitempty

tag中如果带有"omitempty"选项，那么如果该字段值为空，就不会输出到JSON串中

UserName string `json:"user_name,omitempty" bson:"user_name" `

u = &User{UserId: 1}

没加omit:empty {"user_id":1,"user_name":""}
加了后
{"user_id":1}

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

`key01:"value01" key02:"value02" key03:"value03"`
定义完后，如何从结构体中，取出 Tag 呢？

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

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

获取字段 field

获取标签 tag

获取键值对 key:value

type Account struct {
    // Id的值会进行二次JSON编码    
    Id              int64  `json:"id"`
    Account         string `json:"account,omitempty" orm:"size(48)"`     // 账号
    PassWord        string `json:"-" orm:"size(32)"`                     // 密码
    //设置字段的长度
    Phone           string `json:"phone" orm:"size(16)"`                 // 手机号

    // 如果 LastLoginTime为空，则不输出到JSON串中
    LastLoginTime int64 `json:"lastlogintime,omitempty"`

    // 设置一对一关系同时含有json输出格式
    Score       *Score       `json:"score,omitempty" orm:"rel(one)"`           // 账号财富

    // 设置一对多的反向关系
    PaymentLog []*PaymentLog `json:"-" orm:"reverse(many)"`

     // 设置一对一反向关系(可选)
    User   *Userinfos `orm:"reverse(one)"`

    //设置多对多关系
    Tags  []*Tag     `orm:"rel(m2m)"`

    //设置反向多对多关系
    Posts []*Post `orm:"reverse(many)"`
}

字段的tag是"-"，那么这个字段不会输出到JSON
tag中如果带有"omitempty"选项，那么如果该字段值为空，就不会输出到JSON串中
如果字段类型是bool, string, int, int64等，而tag中带有",string"选项，那么这个字段在输出到JSON的时候会把该字段对应的值转换成JSON字符串