golang反射自定义tag

Python010

golang反射自定义tag,第1张

维基百科中反射的定义:在计算机科学中,反射是指计算机程序在运行时(Run time)可以访问、检测和修改它本身状态或行为的一种能力。用比喻来说,反射就是程序在运行的时候能够“观察”并且修改自己的行为。

golang reflect包实现了反射。动态的获得程序运行时对象的结构和信息。

reflect 包中提供了两个基础的关于反射的函数来获取上述的接口和结构体:

func TypeOf(i interface{}) Type

func ValueOf(i interface{}) Value

大体上可以这样理解,TypeOf获取对象的类型信息,ValueOf获取对象中存储的值。

golang tag

golang中可以为结构体的字段添加tag。golang本身的encoding/json包解析json使用了tag,一些开源的orm框架如gorm,也使用了tag。tag可以方便的为结构体的字段添加一些信息,用reflect可以读取到,加以利用。

这是一个用tag标记列名以实现结构体自动生成xlsx的例子:

```

type Employee struct{

ID int `xlsx:”工号”`

Name string `xlsx:”姓名”`

Email string `xlsx:”邮箱”`

}

func Outputxlsx(es []*Employee) ([]byte, error) {

xt := reflect.TypeOf(es[0])

xv := reflect.ValueOf(es[0])

rows := [][]interface{}{}

headers := []interface{}{}

for i := 0i <xt.Elem().NumField()i++ {

head, ok := xt.Elem().Field(i).Tag.Lookup("xlsx")

if ok {

headers = append(headers, head)

}

}

for _, e := range es {

cells := []interface{}{}

xv := reflect.ValueOf(e)

for i := 0i <xv.Elem().NumField()i++ {

_, ok := xt.Elem().Field(i).Tag.Lookup("xlsx")

if ok {

cells = append(cells, xv.Elem().Field(i).Interface())

}

}

rows = append(rows, cells)

}

file := xlsx.NewFile()

sheet, _ := file.AddSheet("sheet1")

row := sheet.AddRow()

for _, header := range headers {

row.AddCell().Value = fmt.Sprintf("%v", header)

}

for _, v := range rows {

row := sheet.AddRow()

for _, vv := range v {

row.AddCell().Value = fmt.Sprintf("%v", vv)

}

}

var buffer bytes.Buffer

if err := file.Write(&buffer)err != nil {

return nil, err

}

return buffer.Bytes(), nil

}

```

作为C语言家族的一员,go和c一样也支持结构体。可以类比于java的一个POJO。

在学习定义结构体之前,先学习下定义一个新类型。

新类型 T1 是基于 Go 原生类型 int 定义的新自定义类型,而新类型 T2 则是 基于刚刚定义的类型 T1,定义的新类型。

这里要引入一个底层类型的概念。

如果一个新类型是基于某个 Go 原生类型定义的, 那么我们就叫 Go 原生类型为新类型的底层类型

在上面的例子中,int就是T1的底层类型。

但是T1不是T2的底层类型,只有原生类型才可以作为底层类型,所以T2的底层类型还是int

底层类型是很重要的,因为对两个变量进行显式的类型转换,只有底层类型相同的变量间才能相互转换。底层类型是判断两个类型本质上是否相同的根本。

这种类型定义方式通常用在 项目的渐进式重构,还有对已有包的二次封装方面

类型别名表示新类型和原类型完全等价,实际上就是同一种类型。只不过名字不同而已。

一般我们都是定义一个有名的结构体。

字段名的大小写决定了字段是否包外可用。只有大写的字段可以被包外引用。

还有一个点提一下

如果换行来写

Age: 66,后面这个都好不能省略

还有一个点,观察e3的赋值

new返回的是一个指针。然后指针可以直接点号赋值。这说明go默认进行了取值操作

e3.Age 等价于 (*e3).Age

如上定义了一个空的结构体Empty。打印了元素e的内存大小是0。

有什么用呢?

基于空结构体类型内存零开销这样的特性,我们在日常 Go 开发中会经常使用空 结构体类型元素,作为一种“事件”信息进行 Goroutine 之间的通信

这种以空结构体为元素类建立的 channel,是目前能实现的、内存占用最小的 Goroutine 间通信方式。

这种形式需要说的是几个语法糖。

语法糖1:

对于结构体字段,可以省略字段名,只写结构体名。默认字段名就是结构体名

这种方式称为 嵌入字段

语法糖2:

如果是以嵌入字段形式写的结构体

可以省略嵌入的Reader字段,而直接访问ReaderName

此时book是一个各个属性全是对应类型零值的一个实例。不是nil。这种情况在Go中称为零值可用。不像java会导致npe

结构体定义时可以在字段后面追加标签说明。

tag的格式为反单引号

tag的作用是可以使用[反射]来检视字段的标签信息。

具体的作用还要看使用的场景。

比如这里的tag是为了帮助 encoding/json 标准包在解析对象时可以利用的规则。比如omitempty表示该字段没有值就不打印出来。

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

如的文档所述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.Tag是StructTag描述/表示标记值的类型值。

以前我们谈论过 “惯例” 。该公约的手段,如果你遵循它,你可以使用StructTag.Get(key

string)它解析变量的值,并返回该方法"value"的key指定。该公约实施/内置到这个Get()方法。如果不遵守约定,Get()将无法解析key:"value"对并找到您要查找的内容。这也不是问题,但是随后您需要实现自己的解析逻辑。

还有StructTag.Lookup()(在Go1.7中添加了),它 “类似于,Get()但是将不包含给定键的标签与将空字符串与给定键相关联的标签区分开”。因此,看一个简单的示例:

type User struct {

Name  string `mytag:"MyName"`

Email string `mytag:"MyEmail"`}

u := User{"Bob", "[email protected]"}

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标签的演示,名为:结构标签的许多面孔(幻灯片)

(和视频)以下是常用标签键的列表:

json-由encoding/json包装使用,详细说明json.Marshal()

xml-由encoding/xml包装使用,详细说明xml.Marshal()

bson-由gobson使用,详细说明bson.Marshal()

protobuf-由github.com/golang/protobuf/proto,在软件包doc中有详细说明

yaml-由gopkg.in/yaml.v2包装使用,详细说明yaml.Marshal()

db-由github.com/jmoiron/sqlx包装使用;也被github.com/go-gorp/gorp包装使用

orm-由github.com/astaxie/beego/orm包装使用,在“ 型号– Beego ORM”中有详细说明

gorm-由github.com/jinzhu/gorm软件包使用,示例可在其文档中找到:模型

valid-由github.com/asaskevich/govalidator软件包使用,示例可以在项目页面中找到

datastore-由appengine/datastore(Google App Engine平台,数据存储区服务)使用,在“ 属性”中有详细说明

schema-用于通过HTML表单值github.com/gorilla/schema填充(struct包文档中有详细说明)

asn-由encoding/asn1包装使用,详细说明在asn1.Marshal()和asn1.Unmarshal()

csv-由github.com/gocarina/gocsv包装使用