一文带你弄懂Golang的反射

23 阅读11分钟

变量的内在机制

Go语言中的变量是分为两部分的:

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

什么是反射

反射是指在程序运行期间对程序本身进行访问和修改的能力。程序在编译时,变量被转换为内存地址,变量名不会被编译器写入到可执行部分。在运行程序时,程序无法获得自身的信息。

这里解释一下这段话:

  1. 对于没有反射机制的情况,程序运行时:
    • 知道内存里存了什么值(比如x=42)
    • 但不知道这个值对应的变量叫x
    • 也不知道x是int类型,属于哪个结构体,有没有方法等 这是为什么呢?看下面的解释:
  2. 对于变量name:="rose":
    • 编译器知道的:该变量的名字是name,类型是string
    • 运行时(无反射)知道的:内存某处有个字符串"rose",但是不知道它的名字是name
  3. 对于结构体User{ID:1}:
    • 编译器知道的:字段叫ID,类型是int
    • 运行时(无反射)知道的:内存里有个整数1,但不知道它属于User.ID
  4. 对于函数func Add(a,b int):
    • 编译器知道的:函数名是Add,参数是int
    • 运行时(无反射)知道的:能调用参数,但不能动态问:"你的函数名是什么,有几个参数"

为什么编译器不保留这些信息呢?

  • 为了性能和体积:
    • 可执行文件越小越好
    • 运行时越快越好
    • 大多数程序不需要知道自己字段叫什么 所以默认情况下,变量名,字段名等"调试/开发期信息"会被剥离,只保留机器能执行的指令和数据

但是上面说了大多数程序不需要知道变量名,也就是说存在某些场景需要知道变量的元信息,而上面说了反射是指在程序运行期间对程序本身进行访问和修改的能力,这也就是反射存在的意义--帮助我们在必要时获取变量的元信息并执行某些操作。

支持反射的语言可以在程序编译期间将变量的反射信息,如字段名称,类型信息,结构体信息等整合到可执行文件中,并给程序提供接口访问反射信息,这样就可以在程序运行期间获取类型的反射信息,并且有能力修改它们。这样虽然违背了编译器为了性能和体积的目的,但是这些需求是必须的,利远远大于弊。

在Go程序中,我们使用reflect包在运行时访问程序的反射信息。

reflect包

在GO语言的反射机制中,任何接口值都是由一个具体类型和具体类型的值两部分组成的。在Go语言中反射的相关功能由内置的reflect包提供,任意接口值在反射中都可以理解为由reflect.Type和reflect.Value两部分组成,并且reflect包提供了reflect.TypeOf()和reflect.ValueOf()两个函数,用于获取接口值的反射信息。

Typeof

在Go语言中,使用reflect.Typeof()函数可以获得任意值的类型对象(reflect.Type),程序通过类型对象可以访问任意值的类型信息

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

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

}

type name和type kind

在反射中关于类型还划分为两种:类型(Type)和种类(Kind)。因为在Go语言中我们可以使用type关键字构造很多自定义类型,而种类(Kind)就是指底层的类型,但在反射中,当需要区分指针,结构体等大品种的类型时,就会用到种类(Kind)。一句话总结:Type表示Go源代码中定义的完整类型名称(包括自定义类型),Kind表示该类型在底层属于哪一种“基本类别”

type myInt int64

func reflectType(x interface{}){
    t:=reflect.TypeOf(x)
    fmt.Printf("name:%v, kind:%v\n", t.Name(), t.Kind())
}

func main(){
    var a *float32  //指针
    var b myInt  //自定义类型
    var c rune   //类型别名
    reflectType(a) // name:, kind:ptr
    reflectType(b) // name:myInt kind:int64
    reflectType(c) // name:int32 kind:int32

    type person struct{
        name string
        age int
    }
    type book struct{
        title string
    }
    var d = person{
        name:"rose",
        age:18,
    }
    var e = book{"rose"}
    reflectType(d) // name:person kind:struct
    reflectType(e) // name:book kind:struct
}

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

在reflect包中定义的Kind类型如下:

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        // 底层指针
)

ValueOf

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

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

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

通过反射获得值

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
	// 将int类型的原始值转换为reflect.Value类型
	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)
}

isNil()和isValid()

isNil()
func (v Value)Isnil() bool

IsNil()报告v持有的值是否为nil。v持有的值的分类必须是通道,函数,接口,映射,指针,切片之一。否则IsNil函数会导致panic

isValid()
func (v Value) IsValid()  bool

IsValid()返回v是否持有一个值。如果v是Value零值会返回false,此时除了IsValid,String,Kind之外的方法都会导致panic

例子

IsNil()常用于判断指针是否为空;IsValid()常用于判定返回值是否有效

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

结构体反射

与结构体相关的方法

任意值通过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):根据方法名返回该类型方法集中的方法。

StructField类型

StructField类型用来描述结构体中的一个字段的信息,即每个字段对应一个StructField

StructField的定义如下:

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

    • 含义:字段的名称(不带包名)
    • 注意:
      1. 如果字段名首字母大写,表示它是导出的,可被其他包访问
      2. 如果首字母小写,则是非导出的,不可被其他包访问
  • PkgPath string

    • 含义:如果字段是非导出的,则此字段记录该字段所属的包路径,如果是导出字段,则为空字符串""
    • 作用:用于判断字段是否可从当前包外部访问
    • 只有非导出字段才有非空的值
  • Type Type

    • 含义:该字段的类型,是一个reflect.Type接口
    • 用途:可以进一步获取字段类型的种类(Kind()),大小,方法等。
  • Tag StructTag

    • 含义:字段的标签(tag),即反引号...中的内容
    • 类型:reflect.StructTag是一个string的别名,但提供了.Get(key)方法来解析键值对
    • 常见用途:JSON序列化,数据库映射,验证规则等。
type student struct {
    Name  string `json:"name"`
}
func main(){
    s := releflect.TypeOf(student{})
    field,_:=s.FieldByName("Name")
    fmt.Println(field.Tag.Get("json"))
}
  • Offset uintptr

    • 含义:该字段在结构体中的内存偏移量(以字节为单位),从结构体起始地址开始计算
    • 用途:底层操作,性能分析,unsafe操作时有用
    • 注意:受内存对齐影响,不一定等于前几个字段大小之和
  • Index []int

    • 含义:字段的索引路径,用于定位字段在嵌套或匿名嵌入结构体中的位置
    • 为什么是切片?
      1. 简单字段:[0],[1](0表示该字段是第0个字段,1表示该字段是第1个字段)
      2. 嵌套/提升字段:[1,0]表示先取第一个字段,再取其第0个字段
    • 示例:
type Address struct { City string }
type Person struct {
    Name    string
    Address        // 匿名嵌入
}
  • Name的Index=[0]

  • Address的Index=[1]

  • Address的City的Index=[1,0]

  • Anonymous bool

    • 含义:该字段是否是匿名字段
    • 匿名字段:没有显示名字,类型本身就是字段名(常用于组合/继承模拟)

结构体反射示例

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

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

func main() {
	stu1 := student{
		Name:  "小王子",
		Score: 90,
	}

	t := reflect.TypeOf(stu1)
	fmt.Println(t.Name(), t.Kind()) // student struct
	// 通过for循环遍历结构体的所有字段信息
	for i := 0; i < t.NumField(); 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"))
	}

	// 通过字段名获取指定结构体字段信息
	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"))
	}
}

不要滥用反射

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

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