Go 語言中結構體的 Tag 用法

轉自：https://zhuanlan.zhihu.com/p/258978922

拋磚引玉：什麼是 Tag？

正常情況下，你定義的結構體是這樣子的，每個字段都由名字和字段類型組成

type Person struct {
    Name string 
    Age  int   
    Addr string
}

也有例外，就像下面這樣子，字段上還可以額外再加一個屬性，用反引號（Esc鍵下面的那個鍵）包含的字符串，稱之爲 Tag，也就是標籤。

type Person struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
    Addr string `json:"addr,omitempty"`
}

那麼這個標籤有什麼用呢？

這邊先以 encoding/json 庫的用法拋磚引玉，看一下它能起到什麼樣的效果。

package main

import (
    "encoding/json"
    "fmt"
)

type Person struct {
    Name string `json:"name"`
    Age  int    `json:"age"`
    Addr string `json:"addr,omitempty"`
}

func main() {
    p1 := Person{
        Name: "Jack",
        Age:  22,
    }

    data1, err := json.Marshal(p1)
    if err != nil {
        panic(err)
    }

    // p1 沒有 Addr，就不會打印了
    fmt.Printf("%s\n", data1)

    // ================

    p2 := Person{
        Name: "Jack",
        Age:  22,
        Addr: "China",
    }

    data2, err := json.Marshal(p2)
    if err != nil {
        panic(err)
    }

    // p2 則會打印所有
    fmt.Printf("%s\n", data2)
}

由於 Person 結構體裏的 Addr 字段有 omitempty 屬性，因此 encoding/json 在將對象轉化 json 字符串時，只要發現對象裏的 Addr 爲 false， 0， 空指針，空接口，空數組，空切片，空映射，空字符串中的一種，就會被忽略。

因此運行後，輸出的結果如下

$ go run demo.go 
{"name":"Jack","age":22}
{"name":"Jack","age":22,"addr":"China"}

不懂就問：如何定義獲取 Tag ？

Tag 由反引號包含，由一對或幾對的鍵值對組成，通過空格來分割鍵值。格式如下

`key01:"value01" key02:"value02" key03:"value03"`

定義完後，如何從結構體中，取出 Tag 呢？

答案就是， "反射"。

• 獲取 Tag 可以分爲三個步驟：
• 獲取字段 field
• 獲取標籤 tag
• 獲取鍵值對 key:value

演示如下

// 三種獲取 field
field := reflect.TypeOf(obj).FieldByName("Name")
field := reflect.ValueOf(obj).Type().Field(i)  // i 表示第幾個字段
field := reflect.ValueOf(&obj).Elem().Type().Field(i)  // i 表示第幾個字段

// 獲取 Tag
tag := field.Tag 

// 獲取鍵值對
labelValue := tag.Get("label")
labelValue,ok := tag.Lookup("label")

獲取鍵值對，有Get 和 Lookup 兩種方法，但其實 Get 只是對 Lookup 函數的簡單封裝而已，當沒有獲取到對應 tag 的內容，會返回空字符串。

func (tag StructTag) Get(key string) string {
    v, _ := tag.Lookup(key)
    return v
}

空 Tag 和不設置 Tag 效果是一樣的

package main

import (
    "fmt"
    "reflect"
)

type Person struct {
    Name string ``
    Age string
}
func main() {
    p := reflect.TypeOf(Person{})
    name, _ := p.FieldByName("Name")
    fmt.Printf("%q\n", name.Tag) //輸出 ""
    age, _ := p.FieldByName("Age")
    fmt.Printf("%q\n", age.Tag) // 輸出 ""
}

實戰一下：利用 Tag 搞點事情？

學會了如何定義 tag 和 獲取 tag，可以試着利用 tag 來做一些事情，來練習一下。

這邊我舉個例子吧。

如果我想實現一個函數（就叫 Print 吧），在打印 person 對象時，能夠美化輸出

type Person struct {
    Name        string 
    Age         int    
    Gender      string
}

person := Person{
    Name:        "MING",
    Age:         29,
}

Print(person)

就像下面這樣，key 和 value 之間有個 is:，如果沒有指定 Gender 的值，那麼顯示爲unknown（未知）。

Name is: MING
Age is: 29
Gender is: unknown

那該怎麼做呢？

先改造下 Person 結構體，給每個字段加上 tag 標籤，三個字段的tag 都有 label 屬性，而 Gender 多了一個 default 屬性，意在指定默認值。

type Person struct {
    Name        string `label:"Name is: "`
    Age         int    `label:"Age is: "`
    Gender      string `label:"Gender is: " default:"unknown"`
}

然後來寫一下這個 Print 函數

func Print(obj interface{}) error {
    // 取 Value
    v := reflect.ValueOf(obj)

    // 解析字段
    for i := 0; i < v.NumField(); i++ {

        // 取tag
        field := v.Type().Field(i)
        tag := field.Tag

        // 解析label 和 default
        label := tag.Get("label")
        defaultValue := tag.Get("default")

        value := fmt.Sprintf("%v", v.Field(i))
        if value == "" {
            // 如果沒有指定值，則用默認值替代
            value = defaultValue
        }

        fmt.Println(label + value)
    }

    return nil
}

最後執行一下，看了下輸出，符合我們的預期：

$ go run demo.go 
Name is: MING
Age is: 29
Gender is: unknown

到此，我們就把 Tag 的用法介紹完了。