背景
type MyB struct{
Age *int
}
type MyA struct{
Name *string
B *MyB
}
func main() {
a := MyA{}
fmt.Println("a", a) // a {} fmt.Println("a.B", a.B) // a.B // panic: runtime error: invalid memory address or nil pointer dereference fmt.Println("a.B.Age", a.B.Age)
}
在编写 Go 代码中经常会遇到上述层层嵌套的数据结构,比如 Google 的 protobuf 往往有好几层的嵌套。 通常因为业务逻辑的需要这样复杂的结构是必须的,但在编写测试样例时会大大增加开发的负担。因为单元测试只会关心一小部分变量,每次重复的初始化会造成代码的冗余显得很不优雅,所以我们迫切需要一个工具来这类初始化的工作。
事实上 github 已经有了类似的使用反射来实现初始化的项目 allocate ,为了方便大家看懂它的代码,下面我们会由浅入深地介绍相关的知识。
反射是什么?
反射的基本作用是提供了让程序检查数据类型的能力。一个常见的例子就是通过 reflect.TypeOf 方法查看原始数据的类型。在下面的例子中 reflect.TypeOf 可以直接输出变量 x 的原始类型为 MyInt。
type Myint int
func show(x interface{}){
// reflect.TypeOf(x) main.MyInt fmt.Println("reflect.TypeOf(x)", reflect.TypeOf(x))
}
func main() {
var a MyInt
show(a)
}
反射类型 Type 和 Kind 的区别?
type MyInt int
func main() {
var a MyInt = 1
x := reflect.ValueOf(a)
fmt.Println("x.Type()", x.Type()) // x.Type() main.MyIntfmt.Println("x.Kind()", x.Kind()) // x.Kind() int}
在了解反射后我们需要知道一下反射类型的概念。反射的类型有两种,一种是静态类型我们称为 Type,一种是底层类型我们称为 Kind。在上述代码中 a 的 Type 是 MyInt,a 的 Kind 是 int。
这里需要注意虽然 MyInt 本质上是 int ,但他们的 Type 是不同,所以需要进行一个转换才能相互赋值。下面这个例子可以看到直接转换会提示转换失败。
type MyInt int
func main() {
var a MyInt = 1
var b interface{} = a
res, ok := b.(int)
fmt.Println("res, ok", res, ok) // res, ok 0 false}
为什么需要 reflect 的反射对象?
因为 Go 没有提供直接操作底层数据的接口。所以当需要修改底层数据时就需要借助 reflect 这个工具来实现。下面为了更清晰地说明反射,我们需要先了解一下 interface 的知识。
func show(x interface{}){
// reflect.TypeOf(x) main.MyInt fmt.Println("reflect.TypeOf(x)", reflect.TypeOf(x))
}
这是上文例子中的 show 函数,它的参数是 interface{} 类型。通过 reflect 我们可以知道该参数原先的类型是 MyInt。我们需要引入一个基本知识:interface{} 的底层实现中存储着原始变量的两个指针,分别是变量的类型以及变量的数据。也正是基于这样的设计,我们才可以在被转换后的 interface 中知道原始的数据类型是什么,才可以做后续的操作。
type Reader interface {
Read()
}
type Writer interface {
Write()
}
type MyInt int
func (p MyInt) Write() {}
func (p MyInt) Read() {}
func main() {
var a MyInt = 1
var r Reader = a // 变量 a 转换为了 Reader的类型var w Writer = r.(Writer) // Reader 再次转换为 Writerfmt.Println(a, r, w)
}
在这个例子中,MyInt 实现了 Reader 和 Writer 的接口。第一步将 MyInt 转换为了 Reader 的接口,而第二步可以直接通过 Reader 转换为 Writer。也从侧面验证了 interface 会保留原始的数据。想要了解更多 interface 的底层实现可以参考一下这篇文章。
反射类型中的 type 和 value
前文提到了 interface 的底层数据包含了原始变量的类型和数据,为了分析 interface 我们需要知道原先的 type 和 value 分别是什么。但是我们的程序不能直接访问底层的数据,所以需要利用 reflect 这个库获取 interface 的 type 和 value,reflect.TypeOf 和 reflect.ValueOf 就是分别对应的两个方法。
var x float64 = 3.4
// type: float64fmt.Println("type:", reflect.TypeOf(x))
// value: (不加string默认会打印3.4)fmt.Println("value:", reflect.ValueOf(x).String())
反射对象的修改
在修改反射对象前,我们需要保证其值是可修改,可以用 v.CanSet() 来判断,也就是确保该对象是 addressable 的以及对应 struct 中的字段为非小写字母。
例子一:
func main() {
var a MyInt = 1
v := reflect.ValueOf(a)
fmt.Println("v.CanSet()", v.CanSet()) // v.CanSet() false}
这里传递给 ValueOf 函数的 a 是一个”值“,因此编译器只会复制 a 的值而不能真正修改原始的数据,所以这里 CanSet 是 false
例子二:
func main() {
var a MyInt = 1
v := reflect.ValueOf(&a)
// v.CanSet() falsefmt.Println("v.CanSet()", v.CanSet())
// v.Elem().CanSet() truefmt.Println("v.Elem().CanSet()", v.Elem().CanSet())
}
虽然这里传递的是 a 的地址,但是我们不能修改 a 指针本身,所以 CanSet () 同样是 false。而只有这里这个指针对应的元素才是我们可以修改的,也就是上述的 v.Elem()。
例子三:
func main() {
x := new(float64) // type of x *float64*x = 34
oldXPointer := x
v := reflect.ValueOf(&x).Elem() // 这里传递的是指针的指针fmt.Println("v.CanSet():", v.CanSet()) // v.CanSet(): true
c := reflect.New(v.Type().Elem()) // 创建原始的类型*(c.Interface().(*float64)) = 33 // 转换为 Interface 并且赋予新的值v.Set(c) // 改变原先的值
fmt.Println("oldXPointer", *oldXPointer) // oldXPointer 34fmt.Println("x", *x) // x 33}
这是一个较复杂的改动,传递的参数是指针的指针。具体的作用是可以修改存储指针的那块数据。同时这个例子也演示了怎么通过 reflect.New 创建一个新的变量,并且赋值。
结构体对象的操作
type T struct {
A int
B string
}
func main() {
t := T{23, "aaa"}
s := reflect.ValueOf(&t).Elem()
typeOfT := s.Type()
for i := 0; i < s.NumField(); i++ {
f := s.Field(i)
// 0: A int = 23// 1: B string = aaafmt.Printf("%d: %s %s = %v\n", i, typeOfT.Field(i).Name,
f.Type(), f.Interface())
}
}
这个例子演示了怎么操作结构体中的数据,也是解决背景中问题的核心操作。现在通过上述知识点,相信你已经可以自己实现“背景”中的问题了或者也可以参考该项目(allocate)的源码来实现。
参考资料:https://blog.golang.org/laws-of-reflectionblog.golang.orgGo Data Structures: Interfacesresearch.swtch.com