小编典典

Go中标签的用途是什么?

go

Go语言规范中,它提到了标签的简要概述:

字段声明后可以跟一个可选的字符串文字标签,该标签成为相应字段声明中所有字段的属性。这些标签通过反射界面可见,但在其他情况下将被忽略。

// A struct corresponding to the TimeStamp protocol buffer.
// The tag strings define the protocol buffer field numbers.
struct {
  microsec  uint64 "field 1"
  serverIP6 uint64 "field 2"
  process   string "field 3"
}

这是IMO的简短解释,我想知道是否有人可以为我提供这些标签的用途?


阅读 757

收藏
2020-07-02

共1个答案

小编典典

字段标签允许您将元信息附加到可以使用反射获取的字段上。通常,它用于提供有关如何将结构域编码为另一种格式(或从另一种格式存储(或从数据库中检索))的转换信息,但是您可以使用它存储想要存储的任何元信息,这些元信息既可以用于另一种包装或供您自己使用。

如的文档所述reflect.StructTag,按照惯例,标记字符串的值是用空格分隔的key:"value"成对列表,例如:

type User struct {
    Name string `json:"name" xml:"name"`
}

key通常表示包,随后的"value"是,例如json密钥被处理/使用的encoding/json包。

如果要在中传递多个信息"value",通常通过用逗号(',')隔开来指定它,例如

Name string `json:"name,omitempty" xml:"name"`

通常用破折号('-'"value"表示将字段从过程中排除(例如,在这种情况下,json表示不封送或取消封送该字段)。

使用反射访问自定义标签的示例

我们可以使用反射(reflect包)来访问结构字段的标记值。基本上,我们需要获取Type结构的,然后可以使用Type.Field(i int)或查询字段Type.FieldByName(name string)。这些方法返回的值StructField描述/表示一个struct字段;并且StructField.TagStructTag描述/表示标记值的类型值。

以前我们谈论过 “惯例” 。该公约的手段,如果你遵循它,你可以使用StructTag.Get(key string)它解析变量的值,并返回该方法"value"key指定。该
公约
实施/内置到这个Get()方法。如果您不遵守约定,Get()将无法解析key:"value"对并找到您要查找的内容。这也不是问题,但是随后您需要实现自己的解析逻辑。

还有StructTag.Lookup()(在Go
1.7中添加了),它 “类似于,Get()但是将不包含给定键的标签与将空字符串与给定键相关联的标签区分开”

因此,让我们看一个简单的示例:

type User struct {
    Name  string `mytag:"MyName"`
    Email string `mytag:"MyEmail"`
}

u := User{"Bob", "bob@mycompany.com"}
t := reflect.TypeOf(u)

for _, fieldName := range []string{"Name", "Email"} {
    field, found := t.FieldByName(fieldName)
    if !found {
        continue
    }
    fmt.Printf("\nField: User.%s\n", fieldName)
    fmt.Printf("\tWhole tag value : %q\n", field.Tag)
    fmt.Printf("\tValue of 'mytag': %q\n", field.Tag.Get("mytag"))
}

输出(在Go Playground上尝试):

Field: User.Name
    Whole tag value : "mytag:\"MyName\""
    Value of 'mytag': "MyName"

Field: User.Email
    Whole tag value : "mytag:\"MyEmail\""
    Value of 'mytag': "MyEmail"

GopherCon 2015上有一个关于struct标签的演示,名为:

结构标签的许多面孔(幻灯片)
(和视频

以下是常用标签键的列表:

2020-07-02