golang碎片整理之反射

2023-12-29 08:06:22

本文介绍go语言反射的意义和基本使用。

变量的内在机制

go语言中的变量是分为两部分的：

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

反射的介绍

反射是指在程序运行期对程序本身进行访问和修改的能力。程序在编译时，变量被转换为内存地址，变量名不会被编译器写入到可执行部分。在运行程序时，程序无法获取自身的信息。
支持反射的语言可以在程序编译期将变量的反射信息，如字段名称，类型信息、结构体信息等整合到可执行文件中，并给程序提供接口访问反射信息，这样就可以在程序运行期获取类型的反射信息，并且有能力修改它们。
Go程序在运行期使用reflect包访问程序的反射信息。
在上一篇博客中我们介绍了空接口。空接口可以存储任意类型的变量，那我们如何知道这个空接口保存的数据是什么呢？反射就是在运行时动态的获取一个变量的类型信息和值信息。

reflect包

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

TypeOf

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

func reflectType(x interface{}) {
    v := reflect.TypeOf(x)
    fmt.Printf("type:%v\n", v)
}
func main() {
    var a float32 = 3.14
    reflectType(a)
    var b int64 = 100
    reflectType(b)
}

type name 和 type kind

在反射中关于类型还划分为两种：类型和种类。因为在go语言中我们可以使用type关键字构造很多自定义的类型，而种类就是指底层的类型，但是在反射中，当需要分区指针、结构体等大品种的类型时，就会用到种类。举个例子，我们定义了两个指针类型和两个结构体类型，通过反射查看它们的类型和种类。

type myInt int64

func reflectType(x interface{}) {
    v := reflect.TypeOf(x)
    fmt.Printf("type:%v kind:%v\n", v.Name(), v.Kind())
}
func main() {
    var a *float32
    var b myInt
    var c rune
    reflectType(a)
    reflectType(b)
    reflectType(c)
    type person struct {
        name string
        age  int
    }
    type book struct {
        title string
    }
    var d = person{
        name: "币圈小王子",
        age:  18,
    }
    var e = book{title: "《跟小王子学go》"}
    reflectType(d)
    reflectType(e)
}

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.Value与原始值之间可以互相切换。
reflect.Value类型提供获取原始值的方法如下：

通过反射获取值

func reflectValue(x interface{}) {
    v := reflect.ValueOf(x)
    k := v.Kind()
    switch k {
    case reflect.Int64:
        fmt.Printf("type is int64,value is %d\n", int64(v.Int()))
    case reflect.Float32:
        fmt.Printf("type is float32, value is %f\n", float32(v.Float()))
    case reflect.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)
    reflectValue(b)
    c := reflect.ValueOf(10)
    fmt.Printf("type c:%T\n", c)
}

通过反射设置变量的值

想要在函数中通过反射修改变量的值，需要注意函数参数传递的是值拷贝，必须传递变量地址才能修改变量值。而反射中使用专有的Elem()方法来获取指针对应的值。

func reflectSetValue1(x interface{}) {
    v := reflect.ValueOf(x)
    if v.Kind() == reflect.Int64 {
        v.SetInt(200)
    }
}
func reflectSetValue2(x interface{}) {
    v := reflect.ValueOf(x)
    if v.Elem().Kind() == reflect.Int64 {
        v.Elem().SetInt(200)
    }
}
func main() {
    var a int64 = 100
    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零值会返回假，此时v除了IsValid、String、Kind之外的方法都会导致panic.

举个例子

IsNil（）常被用于判断指针是否为空；IsValid（）常被用于判断返回值是否有效。

func main() {
    var a *int
    fmt.Println("var a *int IsNil:", reflect.ValueOf(a).IsNil())
    fmt.Println("nil IsValid:", reflect.ValueOf(nil).IsValid())
    b := struct{}{}
    fmt.Println("不存在的结构体成员：", reflect.ValueOf(b).FieldByName("abc").IsValid())
    fmt.Println("不存在的结构体方法:", reflect.ValueOf(b).MethodByName("abc").IsValid())
    c := map[string]int{}
    fmt.Println("map中不存在的键：", reflect.ValueOf(c).MapIndex(reflect.ValueOf("娜扎")).IsValid())
}

结构体反射

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

StructField类型

StructField类型用来描述结构体中的一个字段的信息。
StructField的定义如下：

type StructField struct{
    Name string
    PkgPath string
    Type Type
    Tag StructTag
    Offset uintptr
    Index []int
    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())
    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"))
    }
}

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

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)
        var args = []reflect.Value{}
        v.Method(i).Call(args)
    }
}

码农公寓