go - Go 中标签的用途是什么？

Question

在Go Language Specification中，它提到了标签的简要概述：

字段声明后面可以跟一个可选的字符串文字标记，它成为相应字段声明中所有字段的属性。标签通过反射界面可见，但在其他方面被忽略。
// 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，我想知道是否有人可以向我提供这些标签的用途？

score 865 · Accepted Answer

字段的标签允许您将元信息附加到可以使用反射获取的字段。通常它用于提供有关如何将结构字段编码为另一种格式或从另一种格式解码（或从数据库中存储/检索）的转换信息，但您可以使用它来存储您想要的任何元信息，或者用于另一个包装或供您自己使用。

正如的文档中所提到的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)or Type.FieldByName(name string)。这些方法返回一个StructField描述/表示结构字段的值；并且StructField.Tag是类型[ StructTag] 6的值，它描述/表示标签值。

之前我们谈到了“约定”。这个约定意味着如果您遵循它，您可以使用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 有一个关于结构标签的演示文稿，称为：

结构标签的多面性（幻灯片）（和视频）

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

json - 由encoding/json包使用，详细信息见json.Marshal()
xml - 由encoding/xml包使用，详细信息见xml.Marshal()
bson - 由gobson使用，详细信息在bson.Marshal(); 也由mongo-go驱动程序，在bson package doc中有详细说明
protobuf -github.com/golang/protobuf/proto使用者，在包装文档中有详细说明
yaml - 由gopkg.in/yaml.v2包使用，详细信息见yaml.Marshal()
db - 被github.com/jmoiron/sqlx包使用；也被github.com/go-gorp/gorp包使用
orm - 由github.com/astaxie/beego/orm包使用，详见Models – Beego ORM
gorm - 使用gorm.io/gorm，示例可以在他们的文档中找到
valid - 由github.com/asaskevich/govalidator包使用，示例可以在项目页面中找到
datastore- 由appengine/datastore（Google App Engine 平台、Datastore 服务）使用，详情见属性
schema - 用于github.com/gorilla/schema填充structHTML 表单值，在包文档中有详细说明
asn - 由encoding/asn1包使用，详细信息在asn1.Marshal()和asn1.Unmarshal()
csv - 被github.com/gocarina/gocsv包使用
env - 被github.com/caarlos0/env包使用

score 163 · Accepted Answer

这是一个非常简单的标签示例，它与encoding/json包一起使用，以控制在编码和解码期间如何解释字段：

现场直播：http ://play.golang.org/p/BMeR8p1cKf

package main

import (
    "fmt"
    "encoding/json"
)

type Person struct {
    FirstName  string `json:"first_name"`
    LastName   string `json:"last_name"`
    MiddleName string `json:"middle_name,omitempty"`
}

func main() {
    json_string := `
    {
        "first_name": "John",
        "last_name": "Smith"
    }`

    person := new(Person)
    json.Unmarshal([]byte(json_string), person)
    fmt.Println(person)

    new_json, _ := json.Marshal(person)
    fmt.Printf("%s\n", new_json)
}

// *Output*
// &{John Smith }
// {"first_name":"John","last_name":"Smith"}

json 包可以查看字段的标签并被告知如何映射 json <=> 结构字段，以及额外的选项，例如在序列化回 json 时是否应忽略空字段。

基本上，任何包都可以在字段上使用反射来查看标签值并对这些值进行操作。
在反射包http://golang.org/pkg/reflect/#StructTag中有更多关于它们的信息：

按照惯例，标签字符串是可选用空格分隔的键：“值”对的串联。每个键都是一个非空字符串，由除空格 (U+0020 ' ')、引号 (U+0022 '"') 和冒号 (U+003A ':') 以外的非控制字符组成。每个值都被引用使用 U+0022 '"' 字符和 Go 字符串文字语法。

score 2 · Accepted Answer

它是某种规范，指定包如何处理带有标签的字段。

例如：

type User struct {
    FirstName string `json:"first_name"`
    LastName string `json:"last_name"`
}

json 标记通知json包编组以下用户的输出

u := User{
        FirstName: "some first name",
        LastName:  "some last name",
    }

会是这样的：

{"first_name":"some first name","last_name":"some last name"}

另一个例子是gorm包标签声明必须如何进行数据库迁移：

type User struct {
  gorm.Model
  Name         string
  Age          sql.NullInt64
  Birthday     *time.Time
  Email        string  `gorm:"type:varchar(100);unique_index"`
  Role         string  `gorm:"size:255"` // set field size to 255
  MemberNumber *string `gorm:"unique;not null"` // set member number to unique and not null
  Num          int     `gorm:"AUTO_INCREMENT"` // set num to auto incrementable
  Address      string  `gorm:"index:addr"` // create index with name `addr` for address
  IgnoreMe     int     `gorm:"-"` // ignore this field
}

在此示例中，对于Email带有 gorm 标签的字段，我们声明数据库中字段 email 的对应列必须是 varchar 类型，最大长度为 100，并且它还必须具有唯一索引。

另一个例子是在包binding中最常使用的标签。gin

type Login struct {
    User     string `form:"user" json:"user" xml:"user"  binding:"required"`
    Password string `form:"password" json:"password" xml:"password" binding:"required"`
}


var json Login
if err := c.ShouldBindJSON(&json); err != nil {
     c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
     return
}

此示例中的绑定标记向 gin 包提示发送到 API 的数据必须具有用户和密码字段，因为这些字段是按要求标记的。

所以一般标签是包需要知道他们应该如何处理不同结构类型的数据的数据，熟悉包需要的标签的最佳方法是完整地阅读包文档。

go - Go 中标签的用途是什么？

3 回答 3

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

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

Related

Reference