反射让静态类型语言 Go 在运行时具备了某种基于类型信息的 “动态特性”,利用这种特性,fmt.Println 在无法提前获知传入参数的真正类型的情况下依旧可以对其进行正确地格式化输出;json.Marshal 也是通过这种特性对传入的任意结构体类型进行 “解构” 并正确生成对应的 JSON 文本。下面我们通过一个简单的构建 SQL 查询语句的例子来更为直观地感受 Go 反射的 “魔法”:

    1. // go-reflect/construct_sql_query_stmt.go
    2. package main
    3. import (
    4. "bytes"
    5. "errors"
    6. "fmt"
    7. "reflect"
    8. "time"
    9. )
    10. func ConstructQueryStmt(obj interface{}) (stmt string, err error) {
    11. // 仅支持struct或struct指针类型
    12. typ := reflect.TypeOf(obj)
    13. if typ.Kind() == reflect.Ptr {
    14. typ = typ.Elem()
    15. }
    16. if typ.Kind() != reflect.Struct {
    17. err = errors.New("only struct is supported")
    18. return
    19. }
    20. buffer := bytes.NewBufferString("")
    21. buffer.WriteString("SELECT ")
    22. if typ.NumField() == 0 {
    23. err = fmt.Errorf("the type[%s] has no fields", typ.Name())
    24. return
    25. }
    26. for i := 0; i < typ.NumField(); i++ {
    27. field := typ.Field(i)
    28. if i != 0 {
    29. buffer.WriteString(", ")
    30. }
    31. column := field.Name
    32. if tag := field.Tag.Get("orm"); tag != "" {
    33. column = tag
    34. }
    35. buffer.WriteString(column)
    36. }
    37. stmt = fmt.Sprintf("%s FROM %s", buffer.String(), typ.Name())
    38. return
    39. }
    40. type Product struct {
    41. ID uint32
    42. Name string
    43. Price uint32
    44. LeftCount uint32 `orm:"left_count"`
    45. Batch string `orm:"batch_number"`
    46. Updated time.Time
    47. }
    48. type Person struct {
    49. ID string
    50. Name string
    51. Age uint32
    52. Gender string
    53. Addr string `orm:"address"`
    54. Updated time.Time
    55. }
    56. func main() {
    57. stmt, err := ConstructQueryStmt(&Product{})
    58. if err != nil {
    59. fmt.Println("construct query stmt for Product error:", err)
    60. return
    61. }
    62. fmt.Println(stmt)
    63. stmt, err = ConstructQueryStmt(Person{})
    64. if err != nil {
    65. fmt.Println("construct query stmt for Person error:", err)
    66. return
    67. }
    68. fmt.Println(stmt)
    69. }

    我们来看一下上述示例的运行结果:

    1. $go run construct_sql_query_stmt.go
    2. SELECT ID, Name, Price, left_count, batch_number, Updated FROM Product
    3. SELECT ID, Name, Age, Gender, address, Updated FROM Person

    Rob Pike 还为 Go 反射的规范使用定义了三大法则,如果经过评估,你必须使用反射才能实现你要的功能特性,那么你在使用反射时需要牢记这三条法则:

    1. 反射世界的入口:经由接口 (interface{}) 类型变量值进入到反射的世界并获得对应的反射对象 (reflect.Value 或 reflect.Type);
    2. 反射世界的出口:反射对象 (reflect.Value) 通过化身为一个接口 (interface{}) 类型变量值的形式走出反射世界;
    3. 修改反射对象的前提:其对应的 reflect.Value 必须是可设置的 (Settable)

    对于前两条法则,我们可以用下面的图来表示:

    image.png

    • 进入到反射世界的入口:reflect.TypeOf 和 reflect.ValueOf
    1. // reflect.ValueOf().Type() 等价于 reflect.TypeOf()
    2. var i int = 5
    3. val := reflect.ValueOf(i)
    4. typ := reflect.TypeOf(i)
    5. fmt.Println(reflect.DeepEqual(typ, val.Type())) // true

    反射世界入口可以获取 Go 变量实例的类型信息和值信息的关键在于它们利用了 interface{} 类型形式参数对传入的实际参数 (Go 变量实例) 的析构能力 (可参考第 26 条 “了解接口类型变量的内部表示”),两个入口函数分别将得到的值信息和类型信息存储在 reflect.Value 对象和 reflect.Type 对象中。

    果然是在传参的时候元信息就被创建了.

    进入反射世界后,我们就可以通过 reflect.Value 实例和 reflect.Type 实例进行值信息和类型信息的检视。我们先来看看对 Go 的一些简单原生类型的检视结果:

    1. // go-reflect/examine_value_and_type.go
    2. // 简单原生类型
    3. var b = true // 布尔类型
    4. val := reflect.ValueOf(b)
    5. typ := reflect.TypeOf(b)
    6. fmt.Println(typ.Name(), val.Bool()) // bool true
    7. var i = 23 // 整型
    8. val = reflect.ValueOf(i)
    9. typ = reflect.TypeOf(i)
    10. fmt.Println(typ.Name(), val.Int()) // int 23
    11. var f = 3.14 // 浮点型
    12. val = reflect.ValueOf(f)
    13. typ = reflect.TypeOf(f)
    14. fmt.Println(typ.Name(), val.Float()) // float64 3.14
    15. var s = "hello, reflection" // 字符串
    16. val = reflect.ValueOf(s)
    17. typ = reflect.TypeOf(s)
    18. fmt.Println(typ.Name(), val.String()) //string hello, reflection
    19. var fn = func(a, b int) int { // 函数(一等公民)
    20. return a + b
    21. }
    22. val = reflect.ValueOf(fn)
    23. typ = reflect.TypeOf(fn)
    24. fmt.Println(typ.Kind(), typ.String()) // func func(int, int) int

    reflect.Value 类型拥有很多方便我们进行值检视的方法,比如:Bool、Int、String 等,但显然这些方法不能对所有的变量类型都适用,比如:Bool 方法仅适用于对布尔类型变量进行反射后得到的 Value 对象。一旦应用的方法与 Value 对象的值类型不匹配,我们将收到运行时 panic

    使用前需要检查类型.

    1. var i = 17
    2. val := reflect.ValueOf(i)
    3. fmt.Println(val.Bool()) // panic: reflect: call of reflect.Value.Bool on int Value

    reflect.Type 是一个接口类型,它包含了很多用于检视类型信息的方法,而对于简单原生类型来说,通过 Name、String 或 Kind 方法就可以得到我们想要的类型名称或类型类别等信息。Name 方法返回有确定定义的类型的名字 (不包括包名前缀),比如:int、string,对于上面的函数类型变量,Name 方法将返回空;我们可以通过 String 方法得到类型的描述字符串,比如上面的 func(int, int) int。String 方法返回的类型描述可能包含包名 (一般使用短包名,即仅使用包导入路径的最后一段),比如:main.Person;Type 接口的 Kind 方法则返回类型的特定类别,比如下面的两个变量 pi 和 ps 虽然是不同类型的指针,但是它们的 Kind 都是 ptr:

    1. var pi = (*int)(nil)
    2. var ps = (*string)(nil)
    3. typ := reflect.TypeOf(pi)
    4. fmt.Println(typ.Kind(), typ.String()) // ptr *int
    5. typ = reflect.TypeOf(ps)
    6. fmt.Println(typ.Kind(), typ.String()) // ptr *string

    接下来我们再来看看对原生复合类型以及其他自定义类型的检视结果:

    1. 接下来我们再来看看对原生复合类型以及其他自定义类型的检视结果:
    1. // go-reflect/examine_value_and_type.go
    2. // 原生复合类型
    3. var sl = []int{5, 6} // 切片
    4. val = reflect.ValueOf(sl)
    5. typ = reflect.TypeOf(sl)
    6. fmt.Printf("[%d %d]\n", val.Index(0).Int(),
    7. val.Index(1).Int()) // [5, 6]
    8. fmt.Println(typ.Kind(), typ.String()) // slice []int
    9. var arr = [3]int{5, 6} // 数组
    10. val = reflect.ValueOf(arr)
    11. typ = reflect.TypeOf(arr)
    12. fmt.Printf("[%d %d %d]\n", val.Index(0).Int(),
    13. val.Index(1).Int(), val.Index(2).Int()) // [5 6 0]
    14. fmt.Println(typ.Kind(), typ.String()) // array [3]int
    15. var m = map[string]int{ // map
    16. "tony": 1,
    17. "jim": 2,
    18. "john": 3,
    19. }
    20. val = reflect.ValueOf(m)
    21. typ = reflect.TypeOf(m)
    22. iter := val.MapRange()
    23. fmt.Printf("{")
    24. for iter.Next() {
    25. k := iter.Key()
    26. v := iter.Value()
    27. fmt.Printf("%s:%d,", k.String(), v.Int())
    28. }
    29. fmt.Printf("}\n") // {tony:1,jim:2,john:3,}
    30. fmt.Println(typ.Kind(), typ.String()) // map map[string]int
    31. type Person struct {
    32. Name string
    33. Age int
    34. }
    35. var p = Person{"tony", 23} // 结构体
    36. val = reflect.ValueOf(p)
    37. typ = reflect.TypeOf(p)
    38. fmt.Printf("{%s, %d}\n", val.Field(0).String(),
    39. val.Field(1).Int()) // {"tony", 23}
    40. fmt.Println(typ.Kind(), typ.Name(), typ.String()) // struct Person main.Person
    41. var ch = make(chan int, 1) // channel
    42. val = reflect.ValueOf(ch)
    43. typ = reflect.TypeOf(ch)
    44. ch <- 17
    45. v, ok := val.TryRecv()
    46. if ok {
    47. fmt.Println(v.Int()) // 17
    48. }
    49. fmt.Println(typ.Kind(), typ.String()) // chan chan int
    50. // 其他自定义类型
    51. type MyInt int
    52. var mi MyInt = 19
    53. val = reflect.ValueOf(mi)
    54. typ = reflect.TypeOf(mi)
    55. fmt.Println(typ.Name(), typ.Kind(), typ.String(), val.Int()) // MyInt int main.MyInt 19

    通过反射对象,我们还可以调用函数或对象的方法:

    1. // go-reflect/call_func_and_method.go
    2. ... ...
    3. func Add(i, j int) int {
    4. return i + j
    5. }
    6. type Calculator struct{}
    7. func (c Calculator) Add(i, j int) int {
    8. return i + j
    9. }
    10. func main() {
    11. // 函数调用
    12. f := reflect.ValueOf(Add)
    13. var i = 5
    14. var j = 6
    15. vals := []reflect.Value{reflect.ValueOf(i), reflect.ValueOf(j)}
    16. ret := f.Call(vals)
    17. fmt.Println(ret[0].Int()) // 11
    18. // 方法调用
    19. c := reflect.ValueOf(Calculator{})
    20. m := c.MethodByName("Add")
    21. ret = m.Call(vals)
    22. fmt.Println(ret[0].Int()) // 11
    23. }

    我们看到通过函数类型变量或包含有方法的类型实例反射出的 Value 对象,我们可以通过其 Call 方法调用该函数或类型的方法。函数或方法的参数以 reflect.Value 类型切片的形式提供,函数 / 方法的返回值也以 reflect.Value 类型切片的形式返回。不过务必保证 Value 参数的类型信息与原函数 / 方法的参数的类型相匹配,否则也会导致运行时 panic:

    1. // go-reflect/call_func_and_method.go
    2. var k float64 = 3.14
    3. ret = m.Call([]reflect.Value{reflect.ValueOf(i),
    4. reflect.ValueOf(k)}) // panic: reflect: Call using floa t64 as type int
    • 出口:通过 reflect.Value.Interface() 将 reflect.Value 对象恢复成一个 interface{} 类型变量值

    reflect.Value.Interface() 是 reflect.ValueOf() 的逆过程,通过 Interface 方法我们可以将 reflect.Value 对象恢复成一个 interface{} 类型变量值。这个离开反射世界的过程实质是将 reflect.Value 中的类型信息和值信息重新打包成一个 interface{} 的内部表示。之后,我们就可以像上图中展示的那样,通过类型断言 (type assertion) 得到一个反射前的类型变量值:

    1. // go-reflect/reflect_value_to_interface.go
    2. ... ...
    3. func main() {
    4. var i = 5
    5. val := reflect.ValueOf(i)
    6. r := val.Interface().(int)
    7. fmt.Println(r) // 5
    8. r = 6
    9. fmt.Println(i, r) // 5 6
    10. val = reflect.ValueOf(&i)
    11. q := val.Interface().(*int)
    12. fmt.Printf("%p, %p, %d\n", &i, q, *q) // 0xc0000b4008, 0xc0000b4008, 5
    13. *q = 7
    14. fmt.Println(i) // 7
    15. }

    注意对指针的使用.

    • 输出参数、interface{} 类型变量以及反射对象的可设置性 (Settable)

    在学习传统编程语言 (比如 C 语言) 的函数概念的时候,通常会有输入参数、输出参数的概念,当然 Go 语言也是支持这些概念的,比如下面例子:

    1. func myFunc(in int, out *int) {
    2. in = 1
    3. *out = in + 10
    4. }
    5. func main() {
    6. var n = 17
    7. var m = 23
    8. fmt.Printf("n=%d, m=%d\n", n, m) // n=17, m=23
    9. myFunc(n, &m)
    10. fmt.Printf("n=%d, m=%d\n", n, m) // n=17, m=11
    11. }

    对于以 interface{} 类型变量 i 作为形式参数的 reflect.ValueOf 和 reflect.TypeOf 函数来说,i 自身是被反射对象的 “复制品”,就像上面函数的输入参数那样。而新创建的反射对象又拷贝了 i 中所包含的值信息,因此当被反射的对象以值类型 (T) 传递给 reflect.ValueOf 时,在反射世界中对反射对象的值信息的修改不会对被反射对象产生影响,于是 Go 的设计者们认为这种修改毫无意义,并且禁止了这种行为,一旦发生这种行为,将会导致运行时 panic:

    1. var i = 17
    2. val := reflect.ValueOf(i)
    3. val.SetInt(27) // panic: reflect: reflect.flag.mustBeAssignable using unaddressable value

    reflect.Value 提供了 CanSet、CanAddr 以及 CanInterface 等方法可以帮助我们判断反射对象是否是可设置的、可寻址的以及可恢复为一个 interface{} 类型变量。我们来看一个具体的例子:

    1. // go-reflect/reflect_value_settable.go
    2. ... ...
    3. type Person struct {
    4. Name string
    5. age int
    6. }
    7. func main() {
    8. var n = 17
    9. fmt.Println("int:")
    10. val := reflect.ValueOf(n)
    11. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    12. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    13. fmt.Println("\n*int:")
    14. val = reflect.ValueOf(&n)
    15. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    16. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    17. val = reflect.ValueOf(&n).Elem()
    18. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    19. val.CanSet(), val.CanAddr(), val.CanInterface()) // true true true
    20. fmt.Println("\nslice:")
    21. var sl = []int{5, 6, 7}
    22. val = reflect.ValueOf(sl)
    23. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    24. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    25. val = val.Index(0)
    26. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    27. val.CanSet(), val.CanAddr(), val.CanInterface()) // true true true
    28. fmt.Println("\narray:")
    29. var arr = [3]int{5, 6, 7}
    30. val = reflect.ValueOf(arr)
    31. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    32. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    33. val = val.Index(0)
    34. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    35. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    36. fmt.Println("\nptr to array:")
    37. var pArr = &[3]int{5, 6, 7}
    38. val = reflect.ValueOf(pArr)
    39. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    40. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    41. val = val.Elem()
    42. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    43. val.CanSet(), val.CanAddr(), val.CanInterface()) // true true true
    44. val = val.Index(0)
    45. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    46. val.CanSet(), val.CanAddr(), val.CanInterface()) // true true true
    47. fmt.Println("\nstruct:")
    48. p := Person{"tony", 33}
    49. val = reflect.ValueOf(p)
    50. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    51. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    52. val1 := val.Field(0) // Name
    53. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    54. val1.CanSet(), val1.CanAddr(), val1.CanInterface()) // false false true
    55. val2 := val.Field(1) // age
    56. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    57. val2.CanSet(), val2.CanAddr(), val2.CanInterface()) // false false false
    58. fmt.Println("\nptr to struct:")
    59. pp := &Person{"tony", 33}
    60. val = reflect.ValueOf(pp)
    61. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    62. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    63. val = val.Elem()
    64. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    65. val.CanSet(), val.CanAddr(), val.CanInterface()) // true true true
    66. val1 = val.Field(0) // Name
    67. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    68. val1.CanSet(), val1.CanAddr(), val1.CanInterface()) // true true true
    69. val2 = val.Field(1) // age
    70. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    71. val2.CanSet(), val2.CanAddr(), val2.CanInterface()) // false true false
    72. fmt.Println("\ninterface:")
    73. var i interface{} = &Person{"tony", 33}
    74. val = reflect.ValueOf(i)
    75. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    76. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    77. val = val.Elem()
    78. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    79. val.CanSet(), val.CanAddr(), val.CanInterface()) // true true true
    80. fmt.Println("\nmap:")
    81. var m = map[string]int{
    82. "tony": 23,
    83. "jim": 34,
    84. }
    85. val = reflect.ValueOf(m)
    86. fmt.Printf("Settable = %v, CanAddr = %v, CanInterface = %v\n",
    87. val.CanSet(), val.CanAddr(), val.CanInterface()) // false false true
    88. val.SetMapIndex(reflect.ValueOf("tony"), reflect.ValueOf(12))
    89. fmt.Println(m) // map[jim:34 tony:12]
    90. }

    通过上述例子,我们看到当被反射的对象以值类型 (T) 传递给 reflect.ValueOf 时,所得到的反射对象 (Value) 是不可设置的和不可寻址的;当被反射的对象以指针类型 (*T或&T) 传递给 reflect.ValueOf 时,我们通过 reflect.Value 的 Elem 方法可以得到代表着该指针所指内存对象的 Value 反射对象,而这个反射对象则是可设置和可寻址的,

    相当于指针解引用到了原对象.

    对其进行修改 (比如利用 Value 的 SetInt 方法) 将会像函数的输出参数那样直接修改被反射对象所指向的内存空间的值;同时,当传入结构体或数组指针时,我们通过 Field 或 Index 方法得到的代表结构体字段或数组元素的 Value 反射对象也是可设置和可寻址的;如果结构体中某个字段是非导出字段,则该字段是可寻址但不是可设置的 (比如上面例子中的 age 字段)

    当被反射的对象的静态类型是接口类型时 (就像上面的 interface{} 类型变量 i),该被反射对象的动态类型决定了其进入反射世界后的可设置性。如果动态类型为 *T或&T 时,就像上面传给变量 i 的是 &Person{},那么通过 Elem 方法获得的反射对象就是可设置和可寻址的;map 类型被反射对象是一个特殊的存在,它的 key 和 value 都是不可寻址和不可设置的,但我们可以通过 Value 提供的 SetMapIndex 方法对 map 反射对象进行修改,这种修改会同步到被反射的 map 变量中。