1. 程式人生 > 其它 >golang 結構體tag

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