golang 結構體tag

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字符串