Go 语言入门与进阶:反射获取类型属性和方法

6,034 阅读4分钟

这是我参与更文挑战的第 21 天,活动详情查看: 更文挑战

前文回顾

如果你还没有 Go 语言基础,建议阅读我的 从零学 Go

本系列文章,我将会进一步加深对 Go 语言的讲解,更一步介绍 Go 中的包管理、反射和并发等高级特性。 前面一篇文章主要介绍了 reflect.Type 类型对象。本文将会继续介绍 Go 反射 reflect.StructField 和 reflect.Method 相关的内容。

reflect.StructField 和 reflect.Method

如果变量是一个结构体,我们还可以通过结构体域类型对象 reflect.StructField 来获取结构体下字段的类型属性。Type 接口下提供了不少用于获取字段结构体域类型对象的方法,我们主要介绍以下几个接口:

	// 获取一个结构体内的字段数量
	NumField() int
	// 根据 index 获取结构体内的成员字段类型对象
	Field(i int) StructField
	// 根据字段名获取结构体内的成员字段类型对象
	FieldByName(name string) (StructField, bool)

通过以上的 3 个方法,我们可以轻易地拿到一个结构体变量内的所有成员字段的类型对象 reflect.StructField。通过 reflect.StructField,我们可以知道成员字段所属的类型和种类,其内主要由以下的属性:

type StructField struct {
	// 成员字段的名称
	Name string
	// 成员字段 Type
	Type      Type
	// Tag
	Tag       StructTag
	// 字节偏移
	Offset    uintptr
	// 成员字段的 index
	Index     []int
	// 成员字段是否公开
	Anonymous bool
}

StructField 中提供了 Type 用于获取字段的的类型信息,而 StructTag 一般用来描述结构体成员字段的额外信息,比如在 JSON 进行序列化和对象映射时会被使用。StructTag 一般由一个或者多个键值对组成,一个简单的例子如下:

ID string `json:"id"`

键与值使用 : 分隔,值用 "" 括起来, 键值对之间使用空格分隔。上面例子中说明 ID 字段在 JSON 序列化时会被变成 id 。

接下来,我们通过遍历 Hero 结构体,获取其内字段的类型并输出,代码如下所示:

func main()  {

	typeOfHero := reflect.TypeOf(Hero{})

	// 通过 #NumField 获取结构体字段的数量
	for i := 0 ; i < typeOfHero.NumField(); i++{
		fmt.Printf("field' name is %s, type is %s, kind is %s\n", typeOfHero.Field(i).Name, typeOfHero.Field(i).Type, typeOfHero.Field(i).Type.Kind())
	}
	// 获取名称为 Name 的成员字段类型对象
	nameField, _ := typeOfHero.FieldByName("Name")
	fmt.Printf("field' name is %s, type is %s, kind is %s\n", nameField.Name, nameField.Type, nameField.Type.Kind())

}

预期的结果如下所示:

field' name is Name, type is string, kind is string
field' name is Age, type is int, kind is int
field' name is Speed, type is int, kind is int
field' name is Name, type is string, kind is string

上述代码中先使用 Type#NumField 获取 Hero 结构体中字段的数量,再通过 typeOfHero#Field 根据 index 获取每个字段域类型对象并打印它们的类型信息。代码最后还演示如何通过 typeOfHero#FieldByName 获取了字段名为 Name 的字段域类型对象。

除了获取结构体下的字段域类型对象,Type 还提供方法获取接口下方法的方法类型对象 Method,接口方法描述如下:


	// 根据 index 查找方法
	Method(int) Method
	// 根据方法名查找方法
	MethodByName(string) (Method, bool)
	// 获取类型中公开的方法数量
	NumMethod() int

获取到的方法类型描述对象 Method 描述了方法的基本信息,包括方法名,方法类型等,代码如下所示:

type Method struct {
	// 方法名
	Name    string
	// 方法类型
	Type  Type
	// 反射对象,可用于调用方法
	Func  Value
	// 方法的index
	Index int
}

在 Method 中 Func 字段是一个反射值对象,可用于进行方法的调用。如果 Method 是来自于接口类型反射得到的 Type ,那么 Func 传递的第一个参数需要为实现方法的接收器,这部分区别我们将在 Value 中进行具体的介绍。

我们可以通过 Type 中提供的方法获取接口 Person 中方法的方法类型对象,代码如下所示:

func main()  {
	// 声明一个 Person 接口,并用 Hero 作为接收器
		var person Person = &Hero{}
	// 获取接口Person的类型对象
	typeOfPerson := reflect.TypeOf(person)
	// 打印Person的方法类型和名称
	for i := 0 ; i < typeOfPerson.NumMethod(); i++{
		fmt.Printf("method is %s, type is %s, kind is %s.\n", typeOfPerson.Method(i).Name, typeOfPerson.Method(i).Type, typeOfPerson.Method(i).Type.Kind())
	}
	method, _ := typeOfPerson.MethodByName("Run")
	fmt.Printf("method is %s, type is %s, kind is %s.\n", method.Name, method.Type, method.Type.Kind())
	}

预期的输出结果如下所示:

method is Run, type is func(*main.Hero), kind is func
method is SayHello, type is func(*main.Hero, string), kind is func
method is Run, type is func(*main.Hero) string, kind is func.

除了通过 typeOfPerson#Method 根据 index 获取方法类型对象,还可以使用 typeOfPerson#MethodByName 根据方法名查找对应的方法类型对象。从输出结果可以看出,方法的种类均为 func,而类型则为方法的声明。

小结

本文主要介绍了 Go 语言的反射基础 reflect.StructField 和 reflect.Method。通过反射,我们可以拿到类型信息和定义的方法等,Go 的反射实现了反射的大多数功能,获取类型信息需要配合使用标准库中的词法、语法解析器和抽象语法数对源码进行扫描。下一篇文章将会继续介绍 Go 语言的反射 reflect.Value 反射值对象相关内容。

阅读最新文章,关注公众号:aoho求索