在 Go 中建立標籤

Jay Singh 2023年1月30日

Go Go Tag

在 Go 中使用 struct 函式建立標籤
在 Go 中使用 JSON 建立標籤

結構，也稱為結構，將多個資料位組合成一個實體。這些資料集定義了更高階別的概念，例如地址，由門牌號、街道、城市、州和郵政編碼組成。

當從資料庫或 API 等系統讀取結構時，你可以使用 struct 標籤來規範如何將這些資訊分配給結構的欄位。結構標籤是連線到結構欄位的後設資料的短位，併為與之互動的其他 Go 程式碼提供指令。

這是一種將後設資料新增到結構的方法。你的包或第三方應用程式可以使用這些資料來確定如何執行特定操作或適當地處理資料。

此後設資料由空格分隔，並使用格式為 key: value 的字串文字宣告。多個標籤存在於同一欄位中，服務於不同的目的和庫。

本教程將演示如何使用 Go 的 struct 函式建立標籤。

在 Go 中使用 `struct` 函式建立標籤

此示例中定義了帶有名稱欄位的 User 型別。name 的 struct 標籤已新增到 Name 列。

示例 1：

package main

import "fmt"

type User struct {
    Name string `example:"name"`
}

func (u *User) String() string {
    return fmt.Sprintf("Hello, I am %s", u.Name)
}

func main() {
    u := &User{
    Name: "Jay Singh",
    }

    fmt.Println(u)
}

輸出：

Hello, I am Jay Singh

你需要使用 reflect 包來訪問和使用標籤。

如果使用傳統格式，我們可以使用 StructTag 的 Get 和 Lookup 方法來訪問標籤的資訊。Lookup 方法還返回值 ok，指示是否在欄位中找到標記。

示例 2：

package main

import (
    "fmt"
    "reflect"
)

type User struct {
    Name  string `color:"white"`
    Age   int    `color:"black"`
    Email string
}

func main() {
    a := User{"Jay", 99, "example@jay.com"}

    ut := reflect.TypeOf(a)
    for i := 0; i < ut.NumField(); i++ {
        field := ut.Field(i)
        if color, ok := field.Tag.Lookup("color"); ok {
            if color == "" {
                fmt.Println("(blank)")
            } else {
                fmt.Println(color)
            }
        } else {
            fmt.Println("(Not Specified)")
        }
    }
}

輸出：

white
black
(Not Specified)

在 Go 中使用 JSON 建立標籤

標準庫的 JSON 編碼器使用 struct 標籤作為註釋來告訴編碼器你希望如何命名 JSON 輸出中的欄位。encoding/json 包包含這些 JSON 編碼和解碼機制。

要了解如何在沒有 struct 標籤的情況下對 JSON 進行編碼，請嘗試以下示例：

package main

import (
    "encoding/json"
    "fmt"
    "log"
    "os"
    "time"
)

type User struct {
    Name      string
    Password  string
    Address   []string
    CreatedAt time.Time
}

func main() {
    a := &User{
    Name:      "Jay Singh",
    Password:  "qwertyuiop",
    CreatedAt: time.Now(),
    }

    out, err := json.MarshalIndent(a, "", "  ")
    if err != nil {
        log.Println(err)
        os.Exit(1)
    }

    fmt.Println(string(out))
}

輸出：

{
    "Name": "Jay Singh",
    "Password": "qwertyuiop",
    "Address": null,
    "CreatedAt": "2022-03-10T23:00:00Z"
}

在 Go 中使用 struct 函式建立標籤

在 Go 中使用 JSON 建立標籤

在 Go 中使用 `struct` 函式建立標籤