GoLang structTag說明

這是一個建立於 的文章，其中的資訊可能已經有所發展或是發生改變。

在處理json格式字串的時候，經常會看到聲明struct結構的時候，屬性的右側還有小米點括起來的內容。形如

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

 

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

 

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

 

beego的ORM中也通過tag來定義參數的。

 

package mainimport (   "fmt"   "reflect")type Job struct {   AlarmStatus      *string        `json:"alarm_status" name:"alarm_status"`   CPUTopology      string        `json:"cpu_topology" name:"cpu_topology"`}func main(){   a := "abc"   s := Job{&a,"hello"}   st := reflect.TypeOf(s)   field := st.Field(1)   fmt.Println(field.Tag.Get("json"), field.Tag.Get("name"))}

 

package mainimport (    "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輸出出來    }}