引入
先看官方Doc中Rob Pike给出的关于反射的定义:
Reflection in computing is the ability of a program to examine its own structure, particularly through types; it’s a form of metaprogramming. It’s also a great source of confusion.
(在计算机领域,反射是一种让程序——主要是通过类型——理解其自身结构的一种能力。它是元编程的组成之一,同时它也是一大引人困惑的难题。)
维基百科中的定义:
在计算机科学中,反射是指计算机程序在运行时(Run time)可以访问、检测和修改它本身状态或行为的一种能力。用比喻来说,反射就是程序在运行的时候能够“观察”并且修改自己的行为。
不同语言的反射模型不尽相同,有些语言还不支持反射。《Go 语言圣经》中是这样定义反射的:
Go 语言提供了一种机制在运行时更新变量和检查它们的值、调用它们的方法,但是在编译时并不知道这些变量的具体类型,这称为反射机制。
为什么要用反射
需要反射的 2 个常见场景:
- 有时你需要编写一个函数,但是并不知道传给你的参数类型是什么,可能是没约定好;也可能是传入的类型很多,这些类型并不能统一表示。这时反射就会用的上了。
- 有时候需要根据某些条件决定调用哪个函数,比如根据用户的输入来决定。这时就需要对函数和函数的参数进行反射,在运行期间动态地执行函数。
但是对于反射,还是有几点不太建议使用反射的理由:
- 与反射相关的代码,经常是难以阅读的。在软件工程中,代码可读性也是一个非常重要的指标。
- Go 语言作为一门静态语言,编码过程中,编译器能提前发现一些类型错误,但是对于反射代码是无能为力的。所以包含反射相关的代码,很可能会运行很久,才会出错,这时候经常是直接 panic,可能会造成严重的后果。
- 反射对性能影响还是比较大的,比正常代码运行速度慢一到两个数量级。所以,对于一个项目中处于运行效率关键位置的代码,尽量避免使用反射特性。
相关基础
反射是如何实现的?我们以前学习过 interface,它是 Go 语言实现抽象的一个非常强大的工具。当向接口变量赋予一个实体类型的时候,接口会存储实体的类型信息,反射就是通过接口的类型信息实现的,反射建立在类型的基础上。
Go 语言在 reflect 包里定义了各种类型,实现了反射的各种函数,通过它们可以在运行时检测类型的信息、改变类型的值。在进行更加详细的了解之前,我们需要重新温习一下Go语言相关的一些特性,所谓温故知新,从这些特性中了解其反射机制是如何使用的。
特点 | 说明 |
---|---|
go语言是静态类型语言。 | 编译时类型已经确定,比如对已基本数据类型的再定义后的类型,反射时候需要确认返回的是何种类型。 |
空接口interface{} | go的反射机制是要通过接口来进行的,而类似于Java的Object的空接口可以和任何类型进行交互,因此对基本数据类型等的反射也直接利用了这一特点 |
Go语言的类型: |
-
变量包括(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。
Go语言的反射就是建立在类型之上的,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】。
例如,创建类型为*os.File的变量,然后将其赋给一个接口变量r:
tty, err := os.OpenFile("/dev/tty", os.O_RDWR, 0)
var r io.Reader
r = tty
接口变量r的pair中将记录如下信息:(tty, *os.File),这个pair在接口变量的连续赋值过程中是不变的,将接口变量r赋给另一个接口变量w:
var w io.Writer
w = r.(io.Writer)
接口变量w的pair与r的pair相同,都是:(tty, *os.File),即使w是空接口类型,pair也是不变的。
interface及其pair的存在,是Golang中实现反射的前提,理解了pair,就更容易理解反射。反射就是用来检测存储在接口变量内部(值value;类型concrete type) pair对的一种机制。
所以我们要理解两个基本概念 Type 和 Value,它们也是 Go语言包中 reflect 空间里最重要的两个类型。
反射的使用
我们一般用到的包是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()是获取pair中的type,reflect.ValueOf()获取pair中的value。
首先需要把它转化成reflect对象(reflect.Type或者reflect.Value,根据不同的情况调用不同的函数。
t := reflect.TypeOf(i) //得到类型的元数据,通过t我们能获取类型定义里面的所有元素
v := reflect.ValueOf(i) //得到实际的值,通过v我们获取存储在里面的值,还可以去改变值
示例代码:
package main
import (
"fmt"
"reflect"
)
func main() {
//反射操作:通过反射,可以获取一个接口类型变量的 类型和数值
var x = 3.14
fmt.Println("type:", reflect.TypeOf(x)) //type: float64
fmt.Println("value:", reflect.ValueOf(x)) //value: 3.4
fmt.Println("-------------------")
//根据反射的值,来获取对应的类型和数值
v := reflect.ValueOf(x)
fmt.Println("kind is float64: ", v.Kind() == reflect.Float64)
fmt.Println("type : ", v.Type())
fmt.Println("value : ", v.Float())
}
运行结果:
type: float64
value: 3.14
-------------------
kind is float64: true
type : float64
value : 3.14
说明
- reflect.TypeOf: 直接给到了我们想要的type类型,如float64、int、各种pointer、struct 等等真实的类型
- reflect.ValueOf:直接给到了我们想要的具体的值,如1.2345这个具体数值,或者类似&{1 “Allen.Wu” 25} 这样的结构体struct的值
- 也就是说明反射可以将“接口类型变量”转换为“反射类型对象”,反射类型指的是reflect.Type和reflect.Value这两种
Type 和 Value 都包含了大量的方法,其中第一个有用的方法应该是 Kind,这个方法返回该类型的具体信息:Uint、Float64 等。Value 类型还包含了一系列类型方法,比如 Int(),用于返回对应的值。以下是Kind的种类:
// A Kind represents the specific kind of type that a Type represents.
// The zero Kind is not a valid kind.
type Kind uint
const (
Invalid Kind = iota
Bool
Int
Int8
Int16
Int32
Int64
Uint
Uint8
Uint16
Uint32
Uint64
Uintptr
Float32
Float64
Complex64
Complex128
Array
Chan
Func
Interface
Map
Ptr
Slice
String
Struct
UnsafePointer
)
从relfect.Value中获取接口interface的信息
当执行reflect.ValueOf(interface)之后,就得到了一个类型为”relfect.Value”变量,可以通过它本身的Interface()方法获得接口变量的真实内容,然后可以通过类型判断进行转换,转换为原有真实类型。不过,我们可能是已知原有类型,也有可能是未知原有类型,因此,下面分两种情况进行说明。
已知原有类型【进行“强制转换”】
已知类型后转换为其对应的类型的做法如下,直接通过Interface方法然后强制转换,如下:
realValue := value.Interface().(已知的类型)
示例代码:
package main
import (
"fmt"
"reflect"
)
func main() {
var num float64 = 1.2345
pointer := reflect.ValueOf(&num)
value := reflect.ValueOf(num)
// 可以理解为“强制转换”,但是需要注意的时候,转换的时候,如果转换的类型不完全符合,则直接panic
// Golang 对类型要求非常严格,类型一定要完全符合
// 如下两个,一个是*float64,一个是float64,如果弄混,则会panic
convertPointer := pointer.Interface().(*float64)
convertValue := value.Interface().(float64)
fmt.Println(convertPointer)
fmt.Println(convertValue)
}
运行结果:
0xc000098000
1.2345
说明
- 转换的时候,如果转换的类型不完全符合,则直接panic,类型要求非常严格!
- 转换的时候,要区分是指针类型还是非指针类型
- 也就是说反射可以将“反射类型对象”再重新转换为“接口类型变量”
未知原有类型【遍历探测其Filed】
很多情况下,我们可能并不知道其具体类型,那么这个时候,该如何做呢?需要我们进行遍历探测其Filed来得知,示例如下:
package main
import (
"fmt"
"reflect"
)
type Person struct {
Name string
Age int
Sex string
}
func (p Person) Say(msg string) {
fmt.Println("hello,", msg)
}
func (p Person) PrintInfo() {
fmt.Printf("姓名:%s,年龄:%d,性别:%s\n", p.Name, p.Age, p.Sex)
}
func main() {
p1 := Person{"王二狗", 30, "男"}
GetMessage(p1)
}
// GetMessage 获取input的信息
func GetMessage(input interface{}) {
getType := reflect.TypeOf(input) //先获取input的类型
fmt.Println("get Type is :", getType.Name()) //Person
fmt.Println("get Kind is :", getType.Kind()) //struct
getValue := reflect.ValueOf(input)
fmt.Println("get all Fields is :", getValue) //{王二狗 30 男}
//获取字段
/*
step1:先获取Type对象:reflect.Type,
NumField()
Field(index)
step2:通过Filed()获取每一个Filed字段
step3:Interface(),得到对应的Value
*/
for i := 0; i < getType.NumField(); i++ {
filed := getType.Field(i)
value := getValue.Field(i).Interface() //获取第一个数值
fmt.Printf("字段名称:%s,字段类型:%s,字段数值:%v\n", filed.Name, filed.Type, value)
}
//获取方法
for i := 0; i < getType.NumMethod(); i++ {
method := getType.Method(i)
fmt.Printf("方法名称:%s,方法类型:%v\n", method.Name, method.Type)
}
}
运行结果:
get Type is : Person
get Kind is : struct
get all Fields is : {王二狗 30 男}
字段名称:Name,字段类型:string,字段数值:王二狗
字段名称:Age,字段类型:int,字段数值:30
字段名称:Sex,字段类型:string,字段数值:男
方法名称:PrintInfo,方法类型:func(main.Person)
方法名称:Say,方法类型:func(main.Person, string)
说明
通过运行结果可以得知获取未知类型的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.ValueOf设置实际变量的值
reflect.Value是通过reflect.ValueOf(X)获得的,只有当X是指针的时候,才可以通过reflec.Value修改实际变量X的值,即:要修改反射类型的对象就一定要保证其值是“addressable”的。
这里需要一个方法:
func (v Value) Elem() Value
解释起来就是:Elem返回接口v包含的值或指针v指向的值。如果v的类型不是interface或ptr,它会恐慌。如果v为零,则返回零值。
如果你的变量是一个指针、map、slice、channel、Array。那么你可以使用reflect.Typeof(v).Elem()来确定包含的类型。
package main
import (
"reflect"
"fmt"
)
func main() {
//1.“接口类型变量”=>“反射类型对象”
var circle float64 = 6.28
var icir interface{}
icir = circle
fmt.Println("Reflect : circle.Value = ", reflect.ValueOf(icir)) //Reflect : circle.Value = 6.28
fmt.Println("Reflect : circle.Type = ", reflect.TypeOf(icir)) //Reflect : circle.Type = float64
// 2. “反射类型对象”=>“接口类型变量
v1 := reflect.ValueOf(icir)
fmt.Println(v1) //6.28
fmt.Println(v1.Interface()) //6.28
y := v1.Interface().(float64)
fmt.Println(y) //6.28
//v1.SetFloat(4.13) //panic: reflect: reflect.Value.SetFloat using unaddressable value
//fmt.Println(v1)
//3.修改
fmt.Println(v1.CanSet())//是否可以进行修改
v2 := reflect.ValueOf(&circle) // 传递指针才能修改
v4:=v2.Elem()// 传递指针才能修改,获取Elem()才能修改
fmt.Println(v4.CanSet()) //true
v4.SetFloat(3.14)
fmt.Println(circle) //3.14
}
运行结果:
Reflect : circle.Value = 6.28
Reflect : circle.Type = float64
6.28
6.28
6.28
false
true
3.14
说明
- 需要传入的参数是* float64这个指针,然后可以通过pointer.Elem()去获取所指向的Value,注意一定要是指针。
- 如果传入的参数不是指针,而是变量,那么
- 通过Elem获取原始值对应的对象则直接panic
- 通过CanSet方法查询是否可以设置返回false
- newValue.CantSet()表示是否可以重新设置其值,如果输出的是true则可修改,否则不能修改,修改完之后再进行打印发现真的已经修改了。
- reflect.Value.Elem() 表示获取原始值对应的反射对象,只有原始对象才能修改,当前反射对象是不能修改的
- 也就是说如果要修改反射类型对象,其值必须是“addressable”【对应的要传入的是指针,同时要通过Elem方法获取原始值对应的反射对象】
- struct 或者 struct 的嵌套都是一样的判断处理方式
通过reflect.ValueOf来进行方法的调用
这算是一个高级用法了,前面我们只说到对类型、变量的几种反射的用法,包括如何获取其值、其类型、如果重新设置新值。但是在工程应用中,另外一个常用并且属于高级的用法,就是通过reflect来进行方法【函数】的调用。比如我们要做框架工程的时候,需要可以随意扩展方法,或者说用户可以自定义方法,那么我们通过什么手段来扩展让用户能够自定义呢?关键点在于用户的自定义方法是未可知的,因此我们可以通过reflect来搞定。
示例代码
package main
import (
"fmt"
"reflect"
)
type Person struct {
Name string
Age int
Sex string
}
func (p Person) Say(msg string){
fmt.Println("hello,",msg)
}
func (p Person) PrintInfo(){
fmt.Printf("姓名:%s,年龄:%d,性别:%s\n",p.Name,p.Age,p.Sex)
}
func (p Person) Test(i,j int,s string){
fmt.Println(i,j,s)
}
func main() {
/*
通过反射来进行方法的调用
思路:
step1:接口变量-->对象反射对象:Value
step2:获取对应的方法对象:MethodByName()
step3:将方法对象进行调用:Call()
*/
p1 := Person{"Ruby",20,"男"}
value :=reflect.ValueOf(p1)
fmt.Printf("kind : %s, type:%s\n",value.Kind(),value.Type()) //kind : struct, type:main.Person
methodValue1 :=value.MethodByName("PrintInfo")
fmt.Printf("kind:%s,type:%s\n",methodValue1.Kind(),methodValue1.Type()) //kind:func,type:func()
//没有参数,进行调用
methodValue1.Call(nil) //没有参数,直接写nil
args1 := make([]reflect.Value,0) //或者创建一个空的切片也可以
methodValue1.Call(args1)
methodValue2:=value.MethodByName("Say")
fmt.Printf("kind:%s, type:%s\n",methodValue2.Kind(),methodValue2.Type()) //kind:func, type:func(string)
args2:=[]reflect.Value{reflect.ValueOf("反射机制")}
methodValue2.Call(args2)
methodValue3:=value.MethodByName("Test")
fmt.Printf("kind:%s,type:%s\n",methodValue3.Kind(),methodValue3.Type())//kind:func,type:func(int, int, string)
args3:=[]reflect.Value{reflect.ValueOf(100),reflect.ValueOf(200),reflect.ValueOf("Hello World")}
methodValue3.Call(args3)
}
运行结果:
kind : struct, type:main.Person
kind:func,type:func()
姓名:Ruby,年龄:20,性别:男
姓名:Ruby,年龄:20,性别:男
kind:func, type:func(string)
hello, 反射机制
kind:func,type:func(int, int, string)
100 200 Hello World
通过反射,调用函数
package main
import (
"fmt"
"reflect"
"strconv"
)
func main() {
//函数的反射
/*
思路:函数也是看做接口变量类型
step1:函数--->反射对象,Value
step2:kind-->func
step3:call()
*/
f1 := fun1
value := reflect.ValueOf(f1)
fmt.Printf("kind:%s, type :%s\n", value.Kind(), value.Type()) //kind:func, type :func()
value2 := reflect.ValueOf(fun2)
value3 := reflect.ValueOf(fun3)
fmt.Printf("kind:%s,type:%s\n", value2.Kind(), value2.Type()) //kind:func,type:func(int, string)
fmt.Printf("kind:%s,type:%s\n", value3.Kind(), value3.Type()) //kind:func,type:func(int, string) string
//通过反射调用函数
value.Call(nil)
value2.Call([]reflect.Value{reflect.ValueOf(1000), reflect.ValueOf("张三")})
resultValue := value3.Call([]reflect.Value{reflect.ValueOf(2000), reflect.ValueOf("Ruby")})
fmt.Printf("%T\n", resultValue) //[]reflect.Value
fmt.Println(len(resultValue)) //1
fmt.Printf("kind:%s,type:%s\n", resultValue[0].Kind(), resultValue[0].Type()) //kind:string,type:string
s := resultValue[0].Interface().(string)
fmt.Println(s)
fmt.Printf("%T\n", s)
}
func fun1() {
fmt.Println("我是函数fun1(),无参的...")
}
func fun2(i int, s string) {
fmt.Println("我是函数fun2(),有参的。。", i, s)
}
func fun3(i int, s string) string {
fmt.Println("我是函数fun3(),有参的,也有返回值。。", i, s)
return s + strconv.Itoa(i)
}
运行结果:
kind:func, type :func()
kind:func,type:func(int, string)
kind:func,type:func(int, string) string
我是函数fun1(),无参的...
我是函数fun2(),有参的。。 1000 张三
我是函数fun3(),有参的,也有返回值。。 2000 Ruby
[]reflect.Value
1
kind:string,type:string
Ruby2000
string
结构体
匿名结构体
package main
import (
"fmt"
"reflect"
)
type Animal struct {
Name string
Age int
}
type Cat struct {
Animal
Color string
}
// 获取匿名字段
func main() {
c1 := Cat{Animal{"猫咪", 1}, "白色"}
t1 := reflect.TypeOf(c1)
for i := 0; i < t1.NumField(); i++ {
fmt.Println(t1.Field(i))
/*
{Animal main.Animal 0 [0] true}
{Color string 24 [1] false}
*/
}
// FiledByIndex()的参数是一个切片,第一个数是Animal字段,第二个参数是Animal的第一个字段
f1 := t1.FieldByIndex([]int{0, 0})
f2 := t1.FieldByIndex([]int{0, 1})
fmt.Println(f1) //{Name string 0 [0] false}
fmt.Println(f2) //{Age int 16 [1] false}
v1 := reflect.ValueOf(c1)
fmt.Println(v1.Field(0)) //{猫咪 1}
fmt.Println(v1.FieldByIndex([]int{0, 0})) //猫咪
}
运行结果:
{Animal main.Animal 0 [0] true}
{Color string 24 [1] false}
{Name string 0 [0] false}
{Age int 16 [1] false}
{猫咪 1}
猫咪
通过反射,修改结构体的数据
示例代码:
package main
import (
"reflect"
"fmt"
)
type Student struct {
Name string
Age int
School string
}
func main() {
/*
修改内容
*/
s1:= Student{"王二狗",18,"清华大学"}
v1 := reflect.ValueOf(&s1)
if v1.Kind() ==reflect.Ptr && v1.Elem().CanSet(){
v1 = v1.Elem()
fmt.Println("可以修改。。")
}
f1:=v1.FieldByName("Name")
fmt.Println(f1.CanSet())
f1.SetString("王三狗")
f2:=v1.FieldByName("Age")
fmt.Println(f2.CanSet())
f2.SetInt(20)
fmt.Println(s1)
}
运行结果:
可以修改。。
true
true
{王三狗 20 清华大学}