十三、反射
13.1、介绍
● 反射是指在程序运行期对程序本身进行访问和修改的能力。程序在编译时,变量被转换为内存地址,变量名不会被编译器写入到可执行部分。在运行程序时,程序无法获取自身的信息。
● 支持反射的语言可以在程序编译期将变量的反射信息,如字段名称、类型信息、结构体信息等整合到可执行文件中,并给程序提供接口访问反射信息,这样就可以在程序运行期获取类型的反射信息,并且有能力修改它们。
● Go程序在运行期使用reflect包访问程序的反射信息。反射就是在运行时动态的获取一个变星的类型信息和值信息。
13.2、reflect包
● 在Go语言的反射机制中,任何接口值都由是一个具体类型和具体类型的值两部分组成的。在Go语言中反射的相关功能由内置的reflect包提供,任意接口值在反射中都可以理解为由**reflect.Type()**和 reflect .Value()两部分组成,并且reflect包提供了reflect.TypeOf()和reflect.ValueOf() 两个函数来获取任意对象的Value和Type。
13.2.1、TypeOf
在Go语言中,使用reflect.Type0f()函数可以获得任意值的类型对象(reflet.Type),程序通过类型对象可以访问任意值的类型信息。
func reflectType(x interface{}) {
v := reflect.TypeOf(x)
fmt.Printf("type:%v\n", v)
}
func main() {
var a float32 = 111.111
reflectType(a) //type:float32
var b int64 = 2222
reflectType(b) //type:int64
c :=true
reflectType(c) //type:bool
}
13.2.2、type name和type kind
在反射中关于类型还划分为两种: 类型(Type) 和 种类 (Kind)。 因为在Go语言中我们可以使用type关键字构造很多自定义类型,而种类(Kind)就是指底层的类型,但在反射中,当需要区分指针、结构体等大品种的类型时,就会用到 种类(Kind)。举个例子,定义了两个指针类型和两个结构体类型,通过反射查看它们的 类型 和 种类。
func reflectType(x interface{}) {
v := reflect.TypeOf(x)
fmt.Printf("type:%v\t kind:%v\n", v.Name(), v.Kind())
}
type myInt int64
type Dog struct {
name string
}
func main() {
var a float32 = 111.111
reflectType(a) //type:float32 kind:float32
var aa *float32
reflectType(aa) //type: kind:ptr
var b myInt = 2222
reflectType(b) //type:myInt kind:int64
c := true
reflectType(c) //type:bool kind:bool
var d rune
reflectType(d) //type:int32 kind:int32
e := Dog{"哈士奇"}
reflectType(e) //type:Dog 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 // 底层指针
)
13.2.3、ValueOf
reflect.Value0f()返回的是reflect.Value类型,其中包含了原始值的值信息。reflect.Value() 与原始值之间可以互相转换。
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(18)
fmt.Printf("type c :%T\n", c) // type c :reflect.Value
}
13.3、通过反射设置变量的值
想要在函数中通过反射修改变量的值,需要注意函数参数传递的是值拷贝,必须传递变量地址才能修改变量值。而反射中使用专有的**Elem()**方法来获取指针对应的值。
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
}
13.4、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() {
// *int类型空指针
var a *int
fmt.Println("var a *int IsNil:", reflect.ValueOf(a).IsNil())//var a *int IsNil: true
// nil值
fmt.Println("nil IsValid:", reflect.ValueOf(nil).IsValid())//nil IsValid: false
// 实例化一个匿名结构体
b := struct{}{}
// 尝试从结构体中查找"abc"字段
fmt.Println("不存在的结构体成员:", reflect.ValueOf(b).FieldByName("abc").IsValid())//不存在的结构体成员: false
// 尝试从结构体中查找"abc"方法
fmt.Println("不存在的结构体方法:", reflect.ValueOf(b).MethodByName("abc").IsValid())//不存在的结构体方法: false
// map
c := map[string]int{}
// 尝试从map中查找一个不存在的键
fmt.Println("map中不存在的键:", reflect.ValueOf(c).MapIndex(reflect.ValueOf("娜扎")).IsValid())//map中不存在的键: false
}
13.5、结构体反射
13.5.1、与结构体相关的方法
任意值通过reflect.TypeOf()获得反射对象信息后,如果它的类型是结构体,可以通过反射值对象(reflect.Type)的NumField() 和Field() 方法获得结构体成员的详细信息。
reflect.Type中与获取结构体成员相关的的方法:
13.5.2、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 // 是否匿名字段
}
13.5.3、结构体反射举例
使用反射得到一个结构体数据之后可以通过索引依次获取其字段信息,也可以通过字段名去获取指定的字段信息。
type students struct {
Name string `json:"name"`
Score int `json:"score"`
}
func main() {
stu1 := students{
Name: "小王子",
Score: 90,
}
t := reflect.TypeOf(stu1)
fmt.Println(t.Name(), t.Kind()) // students 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"))
}
//name:Name index:[0] type:string json tag:name
//name:Score index:[1] type:int json tag:score
// 通过字段名获取指定结构体字段信息
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
}
}
type students struct {
Name string `json:"name" myTag:"姓名"`
Score int `json:"score" myTag:"分数"`
}
func main() {
stu1 := students{
Name: "小王子",
Score: 90,
}
t := reflect.TypeOf(stu1)
fmt.Println(t.Name(), t.Kind()) // students 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("myTag"))
}
//name:Name index:[0] type:string json tag:姓名
//name:Score index:[1] type:int json tag:分数
// 通过字段名获取指定结构体字段信息
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
}
}
13.6、总结
反射是一个强大并富有表现力的工具,能让我们写出更灵活的代码。但是反射不应该被滥用,原因有以下三个:
● 基于反射的代码是极其脆弱的,反射中的类型错误会在真正运行的时候才会引发panic,那很可能是在代码写完的很长时间之后。
● 大量使用反射的代码通常难以理解。
● 反射的性能低下,基于反射实现的代码通常比正常代码运行速度慢一到两个数量级。
13.7、反射案例
代码
package main
import (
"errors"
"fmt"
"io/ioutil"
"reflect"
"strconv"
"strings"
)
// Mysq1Config MySQL配置结构体
type MysqlConfig struct {
Address string `ini:"address"`
Port int `ini:"port"`
Username string `ini:"username""`
Password string `ini:"password"`
}
type RedisConfig struct {
Host string `ini:"host"`
Port int `ini:"port"`
Database string `ini:"database""`
Password string `ini:"password"`
Test bool `ini:"test"`
}
type Config struct {
MysqlConfig `ini:"mysql"`
RedisConfig `ini:"redis"`
}
func loadIni(iniName string, data interface{}) (err error) {
// 0.参数的校验
// 0.1传进来的data参数必须是指针类型(因为需要在函数中对其赋值)
t := reflect.TypeOf(data)
if t.Kind() != reflect.Ptr {
err = errors.New("data 不是一个 指针类型")
return
}
// 0.2传进来的data参数必须是结构体类型指针(因为配置文件中各种键值对需要赋值给结构体的字段)
if t.Elem().Kind() != reflect.Struct {
err = errors.New("data 不是一个 结构体类型")
return
}
// 1.读文件得到字节类型数据
b, err := ioutil.ReadFile(iniName)
if err != nil {
return err
}
//string(b) //将字节类型转换成字符串
lineSlice := strings.Split(string(b), "\r\n")
// 2.一行一行得读数据
var structName string
for idx, line := range lineSlice {
//去掉首尾空格
line := strings.TrimSpace(line)
// 2.1 如果是注释 或者空行 就跳过
if strings.HasPrefix(line, "#") || strings.HasPrefix(line, ";") || len(line) == 0 {
continue
}
// 2.2如果是[开头的就表示是节(section)
if strings.HasPrefix(line, "[") {
if line[0] != '[' || line[len(line)-1] != ']' {
err = fmt.Errorf("行:%d 发生错误 ", idx+1)
return
}
//把这一行首尾的[]去掉,取到中间的内容把首尾的空格去掉拿到内容
sectionName := strings.TrimSpace(line[1 : len(line)-1])
if len(sectionName) == 0 {
err = fmt.Errorf("行:%d 发生错误 ", idx+1)
return
}
// 根据字符串sectionName去data里面根据反射找到对应的结构体
//v := reflect.ValueOf(data)
for i := 0; i < t.Elem().NumField(); i++ {
field := t.Elem().Field(i)
if sectionName == field.Tag.Get("ini") {
//说明找到了对应的嵌套结构体,把字段名记下来
structName = field.Name
}
}
} else {
// 2.3、如果不是[开头就是 = 分割的键值对
// 2.3.1、以等号分割这一行,等号左边是key,等号右边是value
if strings.Index(line, "=") == -1 || strings.HasPrefix(line, "=") {
err = fmt.Errorf("行:%d 有语法错误", idx+1)
return
}
index := strings.Index(line, "=")
key := strings.TrimSpace(line[:index])
value := strings.TrimSpace(line[index+1:])
// 2.3.2、根据structName 去data 里面把对应的嵌套結构体给取出来
v := reflect.ValueOf(data)
sValue := v.Elem().FieldByName(structName) // 拿到嵌套结构体的值信息
sType := sValue.Type() //拿到嵌套结构体的类型信息
if sType.Kind() != reflect.Struct {
err = fmt.Errorf("data中的%s字段应该是结构体", structName)
return
}
var fieldName string
var fileType reflect.StructField
// 2.3.3、遍历嵌套结构体的每一 个字段,判断tag是不是等于key
for i := 0; i < sValue.NumField(); i++ {
filed := sType.Field(i) // tag信息是存储在类型信息中的
fileType = filed
if filed.Tag.Get("ini") == key {
//找到对应的字段
fieldName = filed.Name
break
}
}
// 2.3.4、如果key = tag, 给这个字段赋值
// 2.3.4.1、根据fieldName 去取出这个字段
fileObj := sValue.FieldByName(fieldName)
if len(fieldName) == 0 {
//在结构体中找不到对应的字符
continue
}
// 2.3.4.2、对其赋值
switch fileType.Type.Kind() {
case reflect.String:
fileObj.SetString(value)
case reflect.Int, reflect.Int16, reflect.Int8, reflect.Int64, reflect.Int32:
//将字符串转换为数字
parseInt, err := strconv.ParseInt(value, 10, 64)
if err != nil {
err = fmt.Errorf("第:%d行有类型错误", idx+1)
return err
}
fileObj.SetInt(parseInt)
case reflect.Bool:
parseBool, err := strconv.ParseBool(value)
if err != nil {
err = fmt.Errorf("第:%d行有类型错误", idx+1)
return err
}
fileObj.SetBool(parseBool)
case reflect.Float64,reflect.Float32:
parseFloat, err := strconv.ParseFloat(value,64)
if err != nil {
err = fmt.Errorf("第:%d行有类型错误", idx+1)
return err
}
fileObj.SetFloat(parseFloat)
}
}
}
return nil
}
func main() {
var con Config
err := loadIni("./config.ini", &con)
if err != nil {
fmt.Println("配置文件加载失败:", err)
return
}
fmt.Printf("%#v\n",con.MysqlConfig)
fmt.Printf("%#v",con.RedisConfig)
}
配置文件config.ini
# mysql
[mysql]
address = 127.0.0.1
port=3306
username=root
password=123456
; redis
[redis]
host = 127.0.0.1
port=6379
database=0
password=123
test=true