reflect

by 夏泽民 Sep 11, 2019

对自己行为的描述（self-representation）和监测（examination），并能根据自身行为的状态和结果，调整或修改应用所描述行为的状态和相关的语义
每种语言的反射模型都不同，并且有些语言根本不支持反射。Golang语言实现了反射，反射机制就是在运行时动态的调用对象的方法和属性，官方自带的reflect包就是反射相关的，只要包含这个包就可以使用。

多插一句，Golang的gRPC也是通过反射实现的。

Golang关于类型设计的一些原则

变量包括（type, value）两部分

理解这一点就知道为什么nil != nil了

type 包括 static type和concrete type. 简单来说 static type是你在编码是看见的类型(如int、string)，concrete type是runtime系统看见的类型

类型断言能否成功，取决于变量的concrete type，而不是static type. 因此，一个 reader变量如果它的concrete type也实现了write方法的话，它也可以被类型断言为writer.

反射，就是建立在类型之上的，Golang的指定类型的变量的类型是静态的（也就是指定int、string这些的变量，它的type是static type），在创建变量的时候就已经确定，反射主要与Golang的interface类型相关（它的type是concrete type），只有interface类型才有反射一说。
在Golang的实现中，每个interface变量都有一个对应pair，pair中记录了实际变量的值和类型:
(value, type)

value是实际变量值，type是实际变量的类型。一个interface{}类型的变量包含了2个指针，一个指针指向值的类型【对应concrete type】，另外一个指针指向实际的值【对应value】。

nterface及其pair的存在，是Golang中实现反射的前提，理解了pair，就更容易理解反射。反射就是用来检测存储在接口变量内部(值value；类型concrete type) pair对的一种机制。

reflect的基本功能TypeOf和ValueOf
既然反射就是用来检测存储在接口变量内部(值value；类型concrete type) pair对的一种机制。那么在Golang的reflect反射包中有什么样的方式可以让我们直接获取到变量内部的信息呢？它提供了两种类型（或者说两个方法）让我们可以很容易的访问接口变量内容，分别是reflect.ValueOf() 和 reflect.TypeOf()

// ValueOf returns a new Value initialized to the concrete value
// stored in the interface i. ValueOf(nil) returns the zero
func ValueOf(i interface{}) Value {…}

翻译一下：ValueOf用来获取输入参数接口中的数据的值，如果接口为空则返回0

// TypeOf returns the reflection Type that represents the dynamic type of i.
// If i is a nil interface value, TypeOf returns nil.
func TypeOf(i interface{}) Type {…}

翻译一下：TypeOf用来动态获取输入参数接口中的值的类型，如果接口为空则返回nil

reflect.TypeOf：直接给到了我们想要的type类型，如float64、int、各种pointer、struct 等等真实的类型

reflect.ValueOf：直接给到了我们想要的具体的值，如1.2345这个具体数值，或者类似&{1 “Allen.Wu” 25} 这样的结构体struct的值

也就是说明反射可以将“接口类型变量”转换为“反射类型对象”，反射类型指的是reflect.Type和reflect.Value这两种

从relfect.Value中获取接口interface的信息
当执行reflect.ValueOf(interface)之后，就得到了一个类型为”relfect.Value”变量，可以通过它本身的Interface()方法获得接口变量的真实内容，然后可以通过类型判断进行转换，转换为原有真实类型。不过，我们可能是已知原有类型，也有可能是未知原有类型

已知原有类型【进行“强制转换”】
已知类型后转换为其对应的类型的做法如下，直接通过Interface方法然后强制转换，如下：

realValue := value.Interface().(已知的类型)

说明
转换的时候，如果转换的类型不完全符合，则直接panic，类型要求非常严格！
转换的时候，要区分是指针还是指
也就是说反射可以将“反射类型对象”再重新转换为“接口类型变量”

// 通过接口来获取任意参数，然后一一揭晓
func DoFiledAndMethod(input interface{}) {

getType := reflect.TypeOf(input)

fmt.Println("get Type is :", getType.Name())

getValue := reflect.ValueOf(input)

fmt.Println("get all Fields is:", getValue)

// 获取方法字段

// 1. 先获取interface的reflect.Type，然后通过NumField进行遍历

// 2. 再通过reflect.Type的Field获取其Field

// 3. 最后通过Field的Interface()得到对应的value

for i := 0; i < getType.NumField(); i++ {

	field := getType.Field(i)

	value := getValue.Field(i).Interface()

	fmt.Printf("%s: %v = %v\n", field.Name, field.Type, value)

}

// 获取方法

// 1. 先获取interface的reflect.Type，然后通过.NumMethod进行遍历

for i := 0; i < getType.NumMethod(); i++ {

	m := getType.Method(i)

	fmt.Printf("%s: %v\n", m.Name, m.Type)

} }

通过运行结果可以得知获取未知类型的interface的具体变量及其类型的步骤为：

先获取interface的reflect.Type，然后通过NumField进行遍历
再通过reflect.Type的Field获取其Field
最后通过Field的Interface()得到对应的value

通过运行结果可以得知获取未知类型的interface的所属方法（函数）的步骤为：

先获取interface的reflect.Type，然后通过NumMethod进行遍历
再分别通过reflect.Type的Method获取对应的真实的方法（函数）
最后对结果取其Name和Type得知具体的方法名
也就是说反射可以将“反射类型对象”再重新转换为“接口类型变量”
struct 或者 struct 的嵌套都是一样的判断处理方式

通过reflect.Value设置实际变量的值
reflect.Value是通过reflect.ValueOf(X)获得的，只有当X是指针的时候，才可以通过reflec.Value修改实际变量X的值，即：要修改反射类型的对象就一定要保证其值是“addressable”的。

说明

需要传入的参数是* float64这个指针，然后可以通过pointer.Elem()去获取所指向的Value，注意一定要是指针。
如果传入的参数不是指针，而是变量，那么

通过Elem获取原始值对应的对象则直接panic
通过CanSet方法查询是否可以设置返回false

newValue.CantSet()表示是否可以重新设置其值，如果输出的是true则可修改，否则不能修改，修改完之后再进行打印发现真的已经修改了。
reflect.Value.Elem() 表示获取原始值对应的反射对象，只有原始对象才能修改，当前反射对象是不能修改的
也就是说如果要修改反射类型对象，其值必须是“addressable”【对应的要传入的是指针，同时要通过Elem方法获取原始值对应的反射对象】
struct 或者 struct 的嵌套都是一样的判断处理方式

通过reflect.ValueOf来进行方法的调用
这算是一个高级用法了，前面我们只说到对类型、变量的几种反射的用法，包括如何获取其值、其类型、如果重新设置新值。但是在工程应用中，另外一个常用并且属于高级的用法，就是通过reflect来进行方法【函数】的调用。比如我们要做框架工程的时候，需要可以随意扩展方法，或者说用户可以自定义方法，那么我们通过什么手段来扩展让用户能够自定义呢？关键点在于用户的自定义方法是未可知的，因此我们可以通过reflect来搞定

// 如何通过反射来进行方法的调用？
// 本来可以用u.ReflectCallFuncXXX直接调用的，但是如果要通过反射，那么首先要将方法注册，也就是MethodByName，然后通过反射调动mv.Call

func main() {
user := User{1, “Allen.Wu”, 25}

// 1. 要通过反射来调用起对应的方法，必须要先通过reflect.ValueOf(interface)来获取到reflect.Value，得到“反射类型对象”后才能做下一步处理

getValue := reflect.ValueOf(user)

// 一定要指定参数为正确的方法名

// 2. 先看看带有参数的调用方法

methodValue := getValue.MethodByName("ReflectCallFuncHasArgs")

args := []reflect.Value{reflect.ValueOf("wudebao"), reflect.ValueOf(30)}

methodValue.Call(args)

// 一定要指定参数为正确的方法名

// 3. 再看看无参数的调用方法

methodValue = getValue.MethodByName("ReflectCallFuncNoArgs")

args = make([]reflect.Value, 0)

methodValue.Call(args) }

说明

要通过反射来调用起对应的方法，必须要先通过reflect.ValueOf(interface)来获取到reflect.Value，得到“反射类型对象”后才能做下一步处理

reflect.Value.MethodByName这.MethodByName，需要指定准确真实的方法名字，如果错误将直接panic，MethodByName返回一个函数值对应的reflect.Value方法的名字。

[]reflect.Value，这个是最终需要调用的方法的参数，可以没有或者一个或者多个，根据实际参数来定。

reflect.Value的 Call 这个方法，这个方法将最终调用真实的方法，参数务必保持一致，如果reflect.Value’Kind不是一个方法，那么将直接panic。

本来可以用u.ReflectCallFuncXXX直接调用的，但是如果要通过反射，那么首先要将方法注册，也就是MethodByName，然后通过反射调用methodValue.Call

Golang的反射reflect性能
Golang的反射很慢，这个和它的API设计有关。在 java 里面，我们一般使用反射都是这样来弄的。
Field field = clazz.getField(“hello”);
field.get(obj1);
field.get(obj2);
复制代码这个取得的反射对象类型是 java.lang.reflect.Field。它是可以复用的。只要传入不同的obj，就可以取得这个obj上对应的 field。
但是Golang的反射不是这样设计的:
type_ := reflect.TypeOf(obj)
field, _ := type_.FieldByName(“hello”)
复制代码这里取出来的 field 对象是 reflect.StructField 类型，但是它没有办法用来取得对应对象上的值。如果要取值，得用另外一套对object，而不是type的反射
type_ := reflect.ValueOf(obj)
fieldValue := type_.FieldByName(“hello”)
复制代码这里取出来的 fieldValue 类型是 reflect.Value，它是一个具体的值，而不是一个可复用的反射对象了，每次反射都需要malloc这个reflect.Value结构体，并且还涉及到GC。
小结
Golang reflect慢主要有两个原因

涉及到内存分配以及后续的GC；

reflect实现里面有大量的枚举，也就是for循环，比如类型之类的。

反射可以大大提高程序的灵活性，使得interface{}有更大的发挥余地

反射必须结合interface才玩得转
变量的type要是concrete type的（也就是interface变量）才有反射一说

反射可以将“接口类型变量”转换为“反射类型对象”

反射使用 TypeOf 和 ValueOf 函数从接口中获取目标对象信息

反射可以将“反射类型对象”转换为“接口类型变量

reflect.value.Interface().(已知的类型)
遍历reflect.Type的Field获取其Field

反射可以修改反射类型对象，但是其值必须是“addressable”

想要利用反射修改对象状态，前提是 interface.data 是 settable,即 pointer-interface

通过反射可以“动态”调用方法

因为Golang本身不支持模板，因此在以往需要使用模板的场景下往往就需要使用反射(reflect)来实现

https://blog.golang.org/laws-of-reflection

#反射第一定律：反射可以将“接口类型变量”转换为“反射类型对象”。
注：这里反射类型指 reflect.Type 和 reflect.Value。

反射提供了一种机制，允许程序在运行时检查接口变量内部存储的 (value, type) 对。在最开始，我们先了解下 reflect 包的两种类型：Type 和 Value。这两种类型使访问接口内的数据成为可能。它们对应两个简单的方法，分别是 reflect.TypeOf 和 reflect.ValueOf，分别用来读取接口变量的 reflect.Type 和 reflect.Value 部分。当然，从 reflect.Value 也很容易获取到 reflect.Type。

型 reflect.Type 和 reflect.Value 都有很多方法，我们可以检查和使用它们。这里我们举几个例子。类型 reflect.Value 有一个方法 Type()，它会返回一个 reflect.Type 类型的对象。Type和 Value都有一个名为 Kind 的方法，它会返回一个常量，表示底层数据的类型，常见值有：Uint、Float64、Slice等。Value类型也有一些类似于Int、Float的方法，用来提取底层的数据。Int方法用来提取 int64, Float方法用来提取 float64

#反射第二定律：反射可以将“反射类型对象”转换为“接口类型变量”。
和物理学中的反射类似，Go语言中的反射也能创造自己反面类型的对象。

根据一个 reflect.Value 类型的变量，我们可以使用 Interface 方法恢复其接口类型的值。事实上，这个方法会把 type 和 value 信息打包并填充到一个接口变量中，然后返回。其函数声明如下：
// Interface returns v’s value as an interface{}.
func (v Value) Interface() interface{}

标准库中的 fmt.Println 和 fmt.Printf 等函数都接收空接口变量作为参数，fmt 包内部会对接口变量进行拆包（前面的例子中，我们也做过类似的操作）。因此，fmt 包的打印函数在打印 reflect.Value 类型变量的数据时，只需要把 Interface 方法的结果传给格式化打印程序：

fmt.Println(v.Interface())
你可能会问：问什么不直接打印 v ，比如 fmt.Println(v)？答案是 v 的类型是 reflect.Value，我们需要的是它存储的具体值。由于底层的值是一个 float64，我们可以格式化打印：
fmt.Printf(“value is %7.1e\n”, v.Interface())

#反射第三定律：如果要修改“反射类型对象”，其值必须是“可写的”（settable）。

reflect.Type 和 reflect.Value 会混淆正在执行的程序，但是它做的事情正是编程语言做的事情。你只需要记住：只要反射对象要修改它们表示的对象，就必须获取它们表示的对象的地址。

结构体（struct）
在前面的例子中，变量 v 本身并不是指针，它只是从指针衍生而来。把反射应用到结构体时，常用的方式是使用反射修改一个结构体的某些字段。只要拥有结构体的地址，我们就可以修改它的字段。

接口是一个或多个方法签名的集合
只要某个类型拥有该接口的所有方法签名，即算实现该接口，无需显示声明了哪个接口，这称为 Structural Typing
接口只有方法声明，没有实现，没有数据字段
接口可以匿名嵌入其他接口，或嵌入到结构中
将对象赋值给接口时，会发生拷贝，而接口内部存储的是指向这个复制品的指针，既无法修改复制品的状态，也无法获取指针
只有当接口存储的类型和对象都为nil时，接口才等于nil
接口调用不会做receiver的自动转换
接口同样支持匿名字段方法
接口也可实现类似OOP中的多态
空接口可以作为任何类型数据的容器

什么时候应该用 reflect
为了降低多写代码造成的bug率，做更好的归约和抽象。
为了灵活、好用、方便，做动态解析、调用和处理。
为了代码好看、易读、提高开发效率，补足与动态语言之间的一些差别

reflect 核心
TypeOf(i interface{}) Type
重点看这个返回值，它是一个接口，主要实现它的是 struct rtype，这个也是 go 类型系统的核心，和 runtime/type.go struct _type 一致

type Type interface {
// 变量的内存对齐，返回 rtype.align
Align() int

// struct 字段的内存对齐，返回 rtype.fieldAlign

FieldAlign() int

// 根据传入的 i，返回方法实例，表示类型的第 i 个方法

Method(int) Method

// 根据名字返回方法实例，这个比较常用

MethodByName(string) (Method, bool)

// 返回类型方法集中可导出的方法的数量

NumMethod() int

// 只返回类型名，不含包名

Name() string

// 返回导入路径，即 import 路径

PkgPath() string

// 返回 rtype.size 即类型大小，单位是字节数

Size() uintptr

// 返回类型名字，实际就是 PkgPath() + Name()

String() string

// 返回 rtype.kind，描述一种基础类型

Kind() Kind

// 检查当前类型有没有实现接口 u

Implements(u Type) bool

// 检查当前类型能不能赋值给接口 u

AssignableTo(u Type) bool

// 检查当前类型能不能转换成接口 u 类型

ConvertibleTo(u Type) bool

// 检查当前类型能不能做比较运算，其实就是看这个类型底层有没有绑定 typeAlg 的 equal 方法。

// 打住！不要去搜 typeAlg 是什么，不然你会陷进去的！先把本文看完。

Comparable() bool

// 返回类型的位大小，但不是所有类型都能调这个方法，不能调的会 panic

Bits() int

// 返回 channel 类型的方向，如果不是 channel，会 panic

ChanDir() ChanDir

// 返回函数类型的最后一个参数是不是可变数量的，"..." 就这样的，同样，如果不是函数类型，会 panic

IsVariadic() bool

// 返回所包含元素的类型，只有 Array, Chan, Map, Ptr, Slice 这些才能调，其他类型会 panic。

// 这不是废话吗。。其他类型也没有包含元素一说。

Elem() Type

// 返回 struct 类型的第 i 个字段，不是 struct 会 panic，i 越界也会 panic

Field(i int) StructField

// 跟上边一样，不过是嵌套调用的，比如 [1, 2] 就是说返回当前 struct 的第1个struct 的第2个字段，适用于 struct 本身嵌套的类型

FieldByIndex(index []int) StructField

// 按名字找 struct 字段，第二个返回值 ok 表示有没有

FieldByName(name string) (StructField, bool)

// 按函数名找 struct 字段，因为 struct 里也可能有类型是 func 的嘛

FieldByNameFunc(match func(string) bool) (StructField, bool)

// 返回函数第 i 个参数的类型，不是 func 会 panic

In(i int) Type

// 返回 map 的 key 的类型，不是 map 会 panic

Key() Type

// 返回 array 的长度，不是 array 会 panic

Len() int

// 返回 struct 字段数量，不是 struct 会 panic

NumField() int

// 返回函数的参数数量，不是 func 会 panic

NumIn() int

// 返回函数的返回值数量，不是 func 会 panic

NumOut() int

// 返回函数第 i 个返回值的类型，不是 func 会 panic

Out(i int) Type }

ValueOf(i interface{}) Value
先看看定义吧，就这么点东西。

type Value struct {
// 反射出来此值的类型，rtype 是啥往上看，但可别弄错了，这 typ 是未导出的，从外部调不到 Type 接口的方法
typ *rtype

// 数据形式的指针值

ptr unsafe.Pointer

// 保存元数据

flag }

/ 前提 v 是一个 func，然后调用 v，并传入 in 参数，第一个参数是 in[0]，第二个是 in[1]，以此类推
func (v Value) Call(in []Value) []Value

// 返回 v 的接口值或者指针
func (v Value) Elem() Value

// 前提 v 是一个 struct，返回第 i 个字段，这个主要用于遍历
func (v Value) Field(i int) Value

// 前提 v 是一个 struct，根据字段名直接定位返回
func (v Value) FieldByName(name string) Value

// 前提 v 是 Array, Slice, String 之一，返回第 i 个元素，主要也是用于遍历，注意不能越界
func (v Value) Index(i int) Value

// 判断 v 是不是 nil，只有 chan, func, interface, map, pointer, slice 可以用，其他类型会 panic
func (v Value) IsNil() bool

// 判断 v 是否合法，如果返回 false，那么除了 String() 以外的其他方法调用都会 panic，事前检查是必要的
func (v Value) IsValid() bool

// 前提 v 是个 map，返回对应 value
func (v Value) MapIndex(key Value)

// 前提 v 是个 map，返回所有 key 组成的一个 slice
func (v Value) MapKeys() []Value

// 前提 v 是个 struct，返回字段个数
func (v Value) NumField() int

// 赋值
func (v Value) Set(x Value)

// 类型
func (v Value) Type() Type

reflect 场景实践
动态调用函数（无参数）
type T struct {}

func main() {
name := “Do”
t := &T{}
reflect.ValueOf(t).MethodByName(name).Call(nil)
}

func (t *T) Do() {
fmt.Println(“hello”)
}
动态调用函数（有参数）
type T struct{}

func main() {
name := “Do”
t := &T{}
a := reflect.ValueOf(1111)
b := reflect.ValueOf(“world”)
in := []reflect.Value{a, b}
reflect.ValueOf(t).MethodByName(name).Call(in)
}

func (t *T) Do(a int, b string) {
fmt.Println(“hello” + b, a)
}

处理返回值中的错误
返回值也是 Value 类型，对于错误，可以转为 interface 之后断言

type T struct{}

func main() {
name := “Do”
t := &T{}
ret := reflect.ValueOf(t).MethodByName(name).Call(nil)
fmt.Printf(“strValue: %[1]v\nerrValue: %[2]v\nstrType: %[1]T\nerrType: %[2]T”, ret[0], ret[1].Interface().(error))
}

func (t *T) Do() (string, error) {
return “hello”, errors.New(“new error”)
}
struct tag 解析
type T struct {
A int json:"aaa" test:"testaaa"
B string json:"bbb" test:"testbbb"
}

func main() {
t := T{
A: 123,
B: “hello”,
}
tt := reflect.TypeOf(t)
for i := 0; i < tt.NumField(); i++ {
field := tt.Field(i)
if json, ok := field.Tag.Lookup(“json”); ok {
fmt.Println(json)
}
test := field.Tag.Get(“test”)
fmt.Println(test)
}
}
类型转换和赋值
type T struct {
A int newT:"AA"
B string newT:"BB"
}

type newT struct {
AA int
BB string
}

func main() {
t := T{
A: 123,
B: “hello”,
}
tt := reflect.TypeOf(t)
tv := reflect.ValueOf(t)

newT := &newT{}

newTValue := reflect.ValueOf(newT)

for i := 0; i < tt.NumField(); i++ {

    field := tt.Field(i)

    newTTag := field.Tag.Get("newT")

    tValue := tv.Field(i)

    newTValue.Elem().FieldByName(newTTag).Set(tValue)

}

fmt.Println(newT) } 通过 kind（）处理不同分支 func main() {

a := 1

t := reflect.TypeOf(a)

switch t.Kind() {

case reflect.Int:

    fmt.Println("int")

case reflect.String:

    fmt.Println("string")

} }

判断实例是否实现了某接口
type IT interface {
test1()
}

type T struct {
A string
}

func (t *T) test1() {}

func main() {
t := &T{}
ITF := reflect.TypeOf((*IT)(nil)).Elem()
tv := reflect.TypeOf(t)
fmt.Println(tv.Implements(ITF))
}

Category golang