在 Go 中创建标签

Jay Singh 2023年1月30日
  1. 在 Go 中使用 struct 函数创建标签
  2. 在 Go 中使用 JSON 创建标签
在 Go 中创建标签

结构,也称为结构,将多个数据位组合成一个实体。这些数据集定义了更高级别的概念,例如地址,由门牌号、街道、城市、州和邮政编码组成。

当从数据库或 API 等系统读取结构时,你可以使用 struct 标签来规范如何将这些信息分配给结构的字段。结构标签是连接到结构字段的元数据的短位,并为与之交互的其他 Go 代码提供指令。

这是一种将元数据添加到结构的方法。你的包或第三方应用程序可以使用这些数据来确定如何执行特定操作或适当地处理数据。

此元数据由空格分隔,并使用格式为 key: value 的字符串文字声明。多个标签存在于同一字段中,服务于不同的目的和库。

本教程将演示如何使用 Go 的 struct 函数创建标签。

在 Go 中使用 struct 函数创建标签

此示例中定义了带有名称字段的 User 类型。namestruct 标签已添加到 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 包来访问和使用标签。

如果使用传统格式,我们可以使用 StructTagGetLookup 方法来访问标签的信息。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"
}