Golang_9_反射

October 20, 2019 4 minutes read

Golang学习

Golang

九、反射

9.1 反射

9.1.1 变量的内在机制

Go语言中的变量分为两个部分

类型信息：预先定义好的元信息
值信息：运行过程中可动态变化

9.1.2 反射介绍

反射是指：在程序运行期对程序本身进行访问和修改的能力

程序在编译时，变量被转换为内存地址，变量名不会被编译器写入到可执行部分。在运行程序时，程序无法获取自身的信息。

支持反射的语言，可以在编译器将变量的反射信息，比如字段名称、类型信息、结构体信息等整合到可执行文件中，并给程序提供接口访问反射信息，这样就可以获取反射，并且有能力修改它们。

Go程序运行期间使用reflect包访问程序的反射信息

空接口可以存储任意类型的变量，反射就是在运行期间动态获取一个变量的类型信息和值信息

9.2 reflect包

接口值 = 一个具体类型 + 具体类型的值

接口值在反射中都由reflect.TypeOf和reflect.ValueOf两个函数来获取任意对象的Value和Type。

9.2.1 TypeOf

func reflectType(x interface{}) {
	v := reflect.TypeOf(x)
	fmt.Printf("type: %v\n", v)
}

func main() {
	var a float32 = 3.14 // type: float32
	reflectType(a)
	var b int64 = 100
	reflectType(b) // type: int64
}

type name和type kind

类型还分为两种，类型（Type）和种类（Kind）

类型（Type）：person类型，struct种类

种类（Kind）：底层的类型，当需要区分指针、结构体等大品种类型时，就会用到kind

package main
    
import (
    "fmt"
    "reflect"
)
    
func reflectType(x interface{}) {
    t := reflect.TypeOf(x)
    fmt.Printf("type: %v, kind: %v\n", t.Name(), t.Kind())
}
    
type myInt int64
    
func main() {
    var a *float32 // 指针
    var b myInt    // 自定义类型
    var c rune     // 类型别名
    reflectType(a) // type: , kind: ptr
    reflectType(b) // type: myInt, kind: int64
    reflectType(c) // type: int32, kind: int32
    
    type person struct {
        name string
        age  int
    }
    type book struct{ title string }
    var d = person{
        name: "Aris",
        age:  21,
    }
    
    var e = book{title: "Go语言学习笔记"}
    reflectType(d) // type: person, kind: struct
    reflectType(e) // type: book, kind: struct
}

Go语言的反射中像数组、切片、Map、指针等类型的变量，它们的.Name()都是返回空。

type Kind uint
const (
    Invalid Kind = iota  // 非法类型
    Bool                 // 布尔型
    Int                  // 有符号整型
    Int8                 // 有符号8位整型
    Int16                // 有符号16位整型
    Int32                // 有符号32位整型
    Int64                // 有符号64位整型
    Uint                 // 无符号整型
    Uint8                // 无符号8位整型
    Uint16               // 无符号16位整型
    Uint32               // 无符号32位整型
    Uint64               // 无符号64位整型
    Uintptr              // 指针
    Float32              // 单精度浮点数
    Float64              // 双精度浮点数
    Complex64            // 64位复数类型
    Complex128           // 128位复数类型
    
    Array                // 数组
    Chan                 // 通道
    Func                 // 函数
    Interface            // 接口
    Map                  // 映射
    Ptr                  // 指针
    Slice                // 切片
    String               // 字符串
    Struct               // 结构体
    UnsafePointer        // 底层指针
)

9.2.2 ValueOf

reflect.ValueOf()返回reflect.Value类型，其中包含了原始值的值信息。reflect.Value与原始值之间可以互相转换。

reflect.Value类型提供的获取原始值的方法如下：

方法	说明
Interface() interface {}	将值以 interface{} 类型返回，可以通过类型断言转换为指定类型
Int() int64	将值以 int 类型返回，所有有符号整型均可以此方式返回
Uint() uint64	将值以 uint 类型返回，所有无符号整型均可以此方式返回
Float() float64	将值以双精度（float64）类型返回，所有浮点数（float32、float64）均可以此方式返回
Bool() bool	将值以 bool 类型返回
Bytes() []bytes	将值以字节数组 []bytes 类型返回
String() string	将值以字符串类型返回

通过反射获取值

package main
    
import (
    "fmt"
    "reflect"
)
    
func reflectValue(x interface{}) {
    v := reflect.ValueOf(x)
    k := v.Kind()
    
    switch k {
    case reflect.Int64:
        // v.Int()从反射中获取整型的原始值
        // 通过int64()强制类型转换
        fmt.Printf("type is int64, value is %d\n", int64(v.Int()))
    case reflect.Float32:
        // v.Float()从反射中获取浮点型的原始值，然后通过float32()强制类型转换
        fmt.Printf("type is float32, value is %f\n", float32(v.Float()))
    case reflect.Float64:
        // v.Float()从反射中获取浮点型的原始值，然后通过float64()强制类型转换
        fmt.Printf("type is float64, value is %f\n", float64(v.Float()))
    }
}
    
func main() {
    var a float32 = 3.14
    var b int64 = 100
    reflectValue(a) // type is float32, value is 3.140000
    reflectValue(b) // type is int64, value is 100
    
    c := reflect.ValueOf(10)
    fmt.Printf("type c :%T\n", c) // type c :reflect.Value
}

通过反射设置变量的值

传递变量地址才能修改变量值，反射中专有方法 Elem()来获取指针对应的值

package main
    
import (
    "fmt"
    "reflect"
)
    
func reflectSetValue1(x interface{}) {
    v := reflect.ValueOf(x)
    
    if v.Kind() == reflect.Int64 {
        v.SetInt(200) // 修改的是副本，reflect包会引发panic
    }
}
    
func reflectSetValue2(x interface{}) {
    v := reflect.ValueOf(x)
    // 反射中使用 Elem() 方法获取指针对应的值
    if v.Elem().Kind() == reflect.Int64 {
        v.Elem().SetInt(200)
    }
}
    
func main() {
    var a int64 = 100
    // reflectSetValue1(a) //panic: reflect: reflect.Value.SetInt using unaddressable value
    reflectSetValue2(&a)
    fmt.Println(a) // 200
}

isNil()和isValid()

isNil()：报告v持有的值是否为nil。v持有的值的分类必须是通道、函数、接口、映射、指针、切片之一；否则IsNil函数会导致panic。
isValid()：返回v是否持有一个值。如果v是Value零值会返回假，此时v除了IsValid、String、Kind之外的方法都会导致panic。

例子：

IsNil()常被用于判断指针是否为空。

IsValid()常被用于判定返回值是否有效。

package main
    
import (
    "fmt"
    "reflect"
)
    
func main() {
    // *int类型空指针: var a *int IsNil:  true
    var a *int
    fmt.Println("var a *int IsNil: ", reflect.ValueOf(a).IsNil())
    
    // nil值: nil IsNil:  false
    fmt.Println("nil IsNil: ", reflect.ValueOf(nil).IsValid())
    
    // 实例化一个匿名结构体
    b := struct{}{}
    // 尝试从结构体中查找"abc"字段: 不存在的结构体成员: false
    fmt.Println("不存在的结构体成员:", reflect.ValueOf(b).FieldByName("abc").IsValid())
    // 尝试从结构体中查找"abc"方法: 不存在的结构体方法: false
    fmt.Println("不存在的结构体方法:", reflect.ValueOf(b).MethodByName("abc").IsValid())
    
    // map
    c := map[string]int{}
    // 尝试从map中寻找一个不存在的键: map中不存在的键： false
    fmt.Println("map中不存在的键：", reflect.ValueOf(c).MapIndex(reflect.ValueOf("Aris")).IsValid())
}

9.3 结构体反射

9.3.1 和结构体相关的方法

任意值通过reflect.TypeOf()获得反射对象信息后，如果它的类型是结构体，可以通过反射值对象（reflect.Type）的NumField()和Field()方法获得结构体成员的详细信息。

reflect.Type中与获取结构体成员相关的的方法如下表所示。

方法	说明
Field(i int) StructField	根据索引，返回索引对应的结构体字段的信息。
NumField() int	返回结构体成员字段数量。
FieldByName(name string) (StructField, bool)	根据给定字符串返回字符串对应的结构体字段的信息。
FieldByIndex(index []int) StructField	多层成员访问时，根据 []int 提供的每个结构体的字段索引，返回字段的信息。
FieldByNameFunc(match func(string) bool) (StructField,bool)	根据传入的匹配函数匹配需要的字段。
NumMethod() int	返回该类型的方法集中方法的数目
Method(int) Method	返回该类型方法集中的第i个方法
MethodByName(string)(Method, bool)	根据方法名返回该类型方法集中的方法

9.3.2 StructField类型

StructField类型用来描述结构体中的一个字段的信息。

StructField的定义如下：

type StructField struct {
    // Name是字段的名字。PkgPath是非导出字段的包路径，对导出字段该字段为""。
    // 参见http://golang.org/ref/spec#Uniqueness_of_identifiers
    Name    string
    PkgPath string
    Type      Type      // 字段的类型
    Tag       StructTag // 字段的标签
    Offset    uintptr   // 字段在结构体中的字节偏移量
    Index     []int     // 用于Type.FieldByIndex时的索引切片
    Anonymous bool      // 是否匿名字段
}

9.3.3 结构体反射示例

当我们使用反射得到一个结构体数据之后，可以通过索引依次获取其字段信息，也可以通过字段名去获取指定的字段信息。

package main

import (
	"fmt"
	"reflect"
)

type student struct {
	Name  string `json:"name"`
	Score int    `json:"score"`
}

func main() {
	stu1 := student{
		Name:  "Aris",
		Score: 90,
	}

	t := reflect.TypeOf(stu1)
	fmt.Println(t.Name(), t.Kind()) // student struct

	// 通过for循环遍历结构体的所有字段信息
	for i := 0; i < t.NumField(); i++ {
		// Field(i): 根据索引，返回索引对应的结构体字段的信息。
		field := t.Field(i)
		fmt.Printf("name:%s index:%d type:%v json tag:%v\n", field.Name, field.Index, field.Type, field.Tag.Get("json"))
		// name:Name index:[0] type:string json tag:name
		// name:Score index:[1] type:int json tag:score
	}
	fmt.Printf("\n")

	// 通过 字段名 获取 指定结构体字段信息
	if scoreField, ok := t.FieldByName("Score"); ok {
		fmt.Printf("name:%s index:%d type:%v json tag:%v\n", scoreField.Name, scoreField.Index, scoreField.Type, scoreField.Tag.Get("json"))
		// name:Score index:[1] type:int json tag:score
	}
}

编写一个函数printMethod(s interface{})来遍历打印s包含的方法。

package main

import (
	"fmt"
	"reflect"
)

type student struct {
	Name  string `json:"name"`
	Score int    `json:"score"`
}

func (s student) Study() string {
	msg := "好好学习，天天向上！"
	fmt.Println(msg)
	return msg
}

func (s student) Sleep() string {
	msg := "好好睡觉，天天长大！"
	fmt.Println(msg)
	return msg
}

func printMethod(x interface{}) {
	t := reflect.TypeOf(x)
	v := reflect.ValueOf(x)

	// 打印方法数目
	fmt.Println(t.NumMethod())

	for i := 0; i < v.NumMethod(); i++ {
		methodType := v.Method(i).Type()
		fmt.Printf("method name:%s\n", t.Method(i).Name)
		fmt.Printf("method:%s\n", methodType)
		// 通过反射调用方法传递的参数必须是 []reflect.Value 类型
		var args = []reflect.Value{}
		v.Method(i).Call(args)
	}
}

9.4 结构体是一把双刃剑

反射是一个强大并富有表现力的工具，能让我们写出更灵活的代码。但是反射不应该被滥用，原因有以下三个。

基于反射的代码是极其脆弱的，反射中的类型错误会在真正运行的时候才会引发panic，那很可能是在代码写完的很长时间之后。
大量使用反射的代码通常难以理解。
反射的性能低下，基于反射实现的代码通常比正常代码运行速度慢一到两个数量级。