Go后端开发 – 反射reflect && 结构体标签
文章目录
- Go后端开发 -- 反射reflect && 结构体标签
- 一、反射reflect
- 1.编程语言中反射的概念
- 2.interface 和反射
- 3.变量内置的pair结构
- 4.reflect的基本功能TypeOf和ValueOf
- 5.从relfect.Value中获取接口interface的信息
- 6.通过reflect.Value设置实际变量的值
- 7.通过reflect.ValueOf来进行方法的调用
- 8.Golang的反射reflect性能
- 9.reflect总结
- 10.reflect的基本原理
- 二、结构体标签
- 1.结构体标签的作用
- 2.得到结构体标签
- 3.结构体标签在json中的应用
一、反射reflect
1.编程语言中反射的概念
在计算机科学领域,反射是指一类应用,它们能够自描述和自控制。也就是说,这类应用通过采用某种机制来实现对自己行为的描述(self-representation)和监测(examination),并能根据自身行为的状态和结果,调整或修改应用所描述行为的状态和相关的语义。
每种语言的反射模型都不同,并且有些语言根本不支持反射。Golang语言实现了反射,反射机制就是在运行时动态的调用对象的方法和属性,官方自带的reflect包就是反射相关的,只要包含这个包就可以使用。
Golang的gRPC也是通过反射实现的。
2.interface 和反射
Golang关于类型设计的一些原则
-
变量包括(type, value)两部分
-
type 包括
static type
和concrete type
,简单来说static type
是你在编码是看见的类型(如int、string),concrete type
是runtime系统看见的类型 -
类型断言能否成功,取决于变量的
concrete type
,而不是static type
. 因此,一个 reader变量如果它的concrete type
也实现了write方法的话,它也可以被类型断言为writer.
-
反射就是找到当前
interface
变量的concrete type
具体类型,也可以得到当前变量的值 -
反射,就是建立在类型之上的,Golang的指定类型的变量的类型是静态的(也就是指定int、string这些的变量,它的type是
static type
),在创建变量的时候就已经确定,反射主要与Golang的interface
类型相关(它的type是concrete type
),只有interface
类型才有反射一说。
3.变量内置的pair结构
在Golang的实现中,每个interface
变量都有一个对应pair,pair中记录了实际变量的值和类型:(value, type)
- value是实际变量值,type是实际变量的类型。一个
interface{}
类型的变量包含了2个指针,一个指针指向值的类型【对应concrete type
】,另外一个指针指向实际的值【对应value】。
实例1:
package pair_goimport "fmt"func Pair() {var str string// pair<type:string, value:"lisi">str = "lisi"var allType interface{}// str的pair传递给allType了// pair<type:string, value:"lisi">allType = strvalue, ok := allType.(string)if ok {fmt.Println(value)}
}
- 上述实例中,变量str的pair为
pair<type:string, value:"lisi">
,将str赋值给interface{}
类型的变量allType,在赋值的同时,pair也会传递,因此allType的pair为pair<type:string, value:"lisi">
实例2:
package pair_goimport ("fmt""io""os"
)func Pair() {//以读写状态打开当前Linux终端//tty pair<tye:*os.File, value:"/dev/tty"文件描述符>tty, err := os.OpenFile("/dev/tty", os.O_RDWR, 0)if err != nil {fmt.Println("open file error", err)return}// r pair<tye: value: >var r io.Reader// r pair<tye:*os.File, value:"/dev/tty"文件描述符>r = tty// w pair<tye: value: >var w io.Writer// w pair<tye:*os.File, value:"/dev/tty"文件描述符>w = r.(io.Writer)w.Write([]byte("hello, this is a test!!\n"))
}
- 上述实例中,以读写状态打开当前Linux终端,变量tty的pair是
tty pair<tye:*os.File, value:"/dev/tty"文件描述符>
io.Reader
类型是interface
类型的,包含一个接口,将一个文件读到p指向的内存中,给r赋值tty后,此时r变量的pair是pair<tye:*os.File, value:"/dev/tty"文件描述符>
io.Writer
类型与io.Reader
类似,也是interface
类型,将r强转为io.Writer
类型并赋值给w,此时w的pair为pair<tye:*os.File, value:"/dev/tty"文件描述符>
- 以上实例说明一个变量在赋值的时候,pair也会传递给被赋值的变量,并且该pair是连续不变的
实例3:
- 两个interface类型都被同一个结构体类型重写,那么这两个interface类型是可以互相断言的,因为其具体的类型是一致的
package pair_goimport ("fmt"
)type Reader interface {ReadBook()
}type Writer interface {WriteBook()
}// 具体的类型
type Book struct {
}func (b *Book) ReadBook() {fmt.Println("Read a book")
}func (b *Book) WriteBook() {fmt.Println("Write a book")
}func Pair() {// b pair<type:*Book, value:Book{}地址>b := &Book{}// r pair<type:, value:>var r Reader// r pair<type:*Book, value:Book{}地址>r = br.ReadBook()// r pair<type:, value:>var w Writer// r pair<type:*Book, value:Book{}地址>w = r.(Writer) // 此处的断言为什么会成功,因为w r具体的type是一致的//因为Book重写了Reader和Writer,因此Reader和Writer都能指向Book对象,因此他们两个之间是能够互相断言的w.WriteBook()
}
- 上述实例中,Reader和Writer是两个interface类型,分别有一个接口ReadBook和WriteBook,Book结构体分别重写了这两个接口,因此Reader和Writer的对象都能够指向Book类型的对象
- 在Reader对象r指向了Book对象之后,Writer对象w可以通过
r.(Writer)
断言,是因为w和r具体的type是一致的,Book重写了Reader和Writer,因此Reader和Writer都能指向Book对象,因此他们两个之间是能够互相断言的
4.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.TypeOf: 直接给到了我们想要的type类型,如float64、int、各种pointer、struct 等等真实的类型
- reflect.ValueOf:直接给到了我们想要的具体的值,如1.2345这个具体数值,或者类似&{1 “Allen.Wu” 25} 这样的结构体struct的值
- 也就是说明反射可以将“接口类型变量”转换为“反射类型对象”,反射类型指的是reflect.Type和reflect.Value这两种
实例1:
package reflect_goimport ("fmt""reflect"
)func reflectNum(arg interface{}) {fmt.Println("type: ", reflect.TypeOf(arg))fmt.Println("value: ", reflect.ValueOf(arg))
}func Reflect() {var num1 float64 = 1.2345reflectNum(num1)
}
5.从relfect.Value中获取接口interface的信息
- 当执行
reflect.ValueOf(interface)
之后,就得到了一个类型为relfect.Value
变量,可以通过它本身的Interface()
方法获得接口变量的真实内容,然后可以通过类型判断进行转换,转换为原有真实类型。不过,我们可能是已知原有类型,也有可能是未知原有类型,因此,下面分两种情况进行说明。
- 已知原有类型【进行“强制转换”】
已知类型后转换为其对应的类型的做法如下,直接通过Interface方法然后强制转换,如下:
- Golang 对类型要求非常严格,类型一定要完全符合
realValue := value.Interface().(已知的类型)
实例1
package mainimport ("fmt""reflect"
)func main() {var num float64 = 1.2345pointer := reflect.ValueOf(&num)value := reflect.ValueOf(num)// 可以理解为“强制转换”,但是需要注意的时候,转换的时候,如果转换的类型不完全符合,则直接panic// Golang 对类型要求非常严格,类型一定要完全符合// 如下两个,一个是*float64,一个是float64,如果弄混,则会panicconvertPointer := pointer.Interface().(*float64) //返回的是*float64类型的变量convertValue := value.Interface().(float64) // 返回的是float64类型的变量convertInterface := value.Interface() // 返回的是Interface()类型的变量fmt.Printf("%T\n", convertPointer)fmt.Println(convertPointer)fmt.Printf("%T\n", convertValue)fmt.Println(convertValue)val, ok := convertInterface.(float64) //interface类型的变量可以断言if ok {fmt.Printf("convertInterface is %T type\n", val)}
}
- 上述实例获取了num变量的
relfect.Value
变量,可以通过value.Interface().(已知的类型)
方法进行强制类型转换 value.Interface().(已知的类型)
返回的值类型是具体的类型,value.Interface()
返回的是interface类型value.Interface().(已知的类型)
转换的时候,如果转换的类型不完全符合,则直接panic,类型要求非常严格!- 转换的时候,要区分是指针还是值
- 也就是说反射可以将“反射类型对象”再重新转换为“接口类型变量”
- 未知原有类型【遍历探测其Filed】
- 可以通过reflect包内的函数获取结构体的字段及方法
- 通过
type.NumField()
可以获取结构体字段的数量,type.Field(i)
可以获取第i个字段,进而获取字段的类型和字段名 - 通过
value.Field(i).Interface()
可以获取第i个字段的值 - 通过
type.NumMethod()
可以获取成员方法的数量,type.Method(i)
获取第i个成员方法,进而获取方法的类型和方法名 - 也就是说反射可以将“反射类型对象”再重新转换为“接口类型变量”
实例2:
package reflect_goimport ("fmt""reflect"
)type User struct {Name stringSex stringAge int
}func (usr User) Call() {fmt.Println("user os called..")fmt.Println(usr)
}func Reflect() {User1 := User{"zhangsan", "male", 16}DoFiledAndMethod(User1)
}func DoFiledAndMethod(input interface{}) {//获取typeinputType := reflect.TypeOf(input)fmt.Println("input type: ", inputType)//获取valueinputValue := reflect.ValueOf(input)fmt.Println("input value: ", inputValue)//通过type获取里面的字段//1.获取interface的reflect.Type,通过Type得到NumField,进行遍历//2.得到每个field,数据类型//3.通过field中有一个Interface()方法,得到对应的valuefor i := 0; i < inputType.NumField(); i++ {field := inputType.Field(i) //取出第i个字段value := inputValue.Field(i).Interface() //取出第i个字段的值fmt.Println(field.Name, field.Type, value)}//通过type获取里面的方法for i := 0; i < inputType.NumMethod(); i++ {m := inputType.Method(i)fmt.Println(m.Name, m.Type)}
}
6.通过reflect.Value设置实际变量的值
reflect.Value
是通过reflect.ValueOf(X)
获得的,只有当X是指针的时候,才可以通过reflec.Value
修改实际变量X的值,即:要修改反射类型的对象就一定要保证其值是“addressable”的。
实例:
package reflect_goimport ("fmt""reflect"
)type User struct {Name stringSex stringAge int
}func (usr User) Call() {fmt.Println("user os called..")fmt.Println(usr)
}func Reflect() {User1 := User{"zhangsan", "male", 16}ChangeValue(User1)
}func ChangeValue(input interface{}) {// 通过reflect.ValueOf获取num中的reflect.Value,注意,参数必须是指针才能修改其值pointer := reflect.ValueOf(&input)//Elem返回v持有的接口保管的值的Value封装,或者v持有的指针指向的值的Value封装。//如果v的Kind不是Interface或Ptr会panic;如果v持有的值为nil,会返回Value零值。newValue := pointer.Elem()fmt.Println("pointer: type of pointer: ", pointer.Type())fmt.Println("pointer: settability of pointer: ", pointer.CanSet())fmt.Println("newValue: type of pointer: ", newValue.Type())fmt.Println("newValue: settability of pointer: ", newValue.CanSet())//重新赋值u := User{"lisi", "male", 25}val := reflect.ValueOf(u)newValue.Set(val)fmt.Println("new value: ", input)
}
- 在上述实例中,使用
interface{}
通用接口接收User
类型的数据,pointer被赋值为reflect.ValueOf(&input)
,也就是input的指针的Value,只有通过reflect拿到其指针,才能够修改数据 reflect.Value.Elem()
表示获取原始值对应的反射对象,只有原始对象才能修改,当前反射对象是不能修改的,会返回v持有的接口保管的值的Value封装,或者v持有的指针指向的值的Value封装,如果v的类型不是interface
或者指针,则pointer.Elem()
会panic,我们通过Elem()
拿到了pointer指针指向的Value,可以通过该Value更改原数据的值- 也就是说如果要修改反射类型对象,其值必须是“addressable”【对应的要传入的是指针,同时要通过Elem方法获取原始值对应的反射对象】
newValue.CantSet()
表示是否可以重新设置其值,如果输出的是true则可修改,否则不能修改- 通过输出pointer和newValue变量的
Type()
和CanSet()
,可以看出:pointer的类型是*interface {}
,其值是不可以更改的;newValue的类型是interface {}
,其值是可以更改的; - 我们可以通过
Set()
方法更改实际变量的值,注意Set()
参数的类型需要是reflect.Value
,因此还需要将新的值通过reflect.ValueOf()
提取Value,再传入Set()
;如果实际变量是一般类型,可以通过SetInt()
、SetFloat()
方法直接更改 - 最终输出input变量的值,发现其被更改成功
7.通过reflect.ValueOf来进行方法的调用
这算是一个高级用法了,前面我们只说到对类型、变量的几种反射的用法,包括如何获取其值、其类型、如果重新设置新值。但是在工程应用中,另外一个常用并且属于高级的用法,就是通过reflect来进行方法【函数】的调用。比如我们要做框架工程的时候,需要可以随意扩展方法,或者说用户可以自定义方法,那么我们通过什么手段来扩展让用户能够自定义呢?关键点在于用户的自定义方法是未可知的,因此我们可以通过reflect来搞定
- 要通过反射来调用起对应的方法,必须要先通过
reflect.ValueOf(interface)
来获取到reflect.Value
,得到“反射类型对象”后才能做下一步处理 reflect.Value.MethodByName
:需要指定准确真实的方法名字,如果错误将直接panic,MethodByName返回一个函数值对应的reflect.Value
方法的名字。[]reflect.Value
,这个是最终需要调用的方法的参数,可以没有或者一个或者多个,根据实际参数来定。reflect.Value.Call()
这个方法,将最终调用真实的方法,参数务必保持一致,如果reflect.Value
的类型不是一个方法,那么将直接panic。- 本来可以用u.ReflectCallFuncXXX直接调用的,但是如果要通过反射,那么首先要将方法注册,也就是MethodByName,然后通过反射调用methodValue.Call
实例1:
package reflect_goimport ("fmt""reflect"
)type User struct {Name stringSex stringAge int
}func (usr User) ReflectCallFuncHasArgs(name string, age int) {fmt.Println("ReflectCallFuncHasArgs name:", name, "age", age)
}func (usr User) ReflectCallFuncNoArgs() {fmt.Println("ReflectCallFuncNoArgs")
}func Reflect() {User1 := User{"zhangsan", "male", 16}callFunc(User1)
}func callFunc(input interface{}) {//获取Value对象getValue := reflect.ValueOf(input)//有参调用//获取方法,一定要指定参数为正确的方法名method1 := getValue.MethodByName("ReflectCallFuncHasArgs")//参数列表args := []reflect.Value{reflect.ValueOf("xiaozhang"), reflect.ValueOf(18)}//调用method1.Call(args)//无参调用method2 := getValue.MethodByName("ReflectCallFuncNoArgs")//无参,也要传入空的argsargs = make([]reflect.Value, 0)//或者 args2 = []reflect.Value{}method2.Call(args)
}
- 上述实例中,args为参数列表,是
[]reflect.Value{}
类型的,需要传入该函数所需参数的reflect.Value
值,若函数无参,则args为空即可;
通过reflect.Type可以获取方法
package reflect_goimport ("fmt""reflect"
)type User struct {Name stringSex stringAge int
}func (usr User) ReflectCallFuncHasArgs(name string, age int) {fmt.Println("ReflectCallFuncHasArgs name:", name, "age", age)
}func (usr User) ReflectCallFuncNoArgs() {fmt.Println("ReflectCallFuncNoArgs")
}func Reflect() {User1 := User{"zhangsan", "male", 16}callFunc(User1)
}func callFunc(input interface{}) {//获取Value对象getType := reflect.TypeOf(input)//获取方法for i := 0; i < getType.NumMethod(); i++ {method := getType.Method(i)fmt.Println("name:", method.Name, "type:", method.Type)}
}
8.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循环,比如类型之类的.
9.reflect总结
上述详细说明了Golang的反射reflect的各种功能和用法,都附带有相应的示例,相信能够在工程应用中进行相应实践,总结一下就是:
- 反射可以大大提高程序的灵活性,使得interface{}有更大的发挥余地
- 反射必须结合interface才玩得转
- 变量的type要是concrete type的(也就是interface变量)才有反射一说
- 反射可以将“接口类型变量”转换为“反射类型对象”
- 反射使用
TypeOf
和ValueOf
函数从接口中获取目标对象信息
- 反射使用
- 反射可以将“反射类型对象”转换为“接口类型变量
reflect.value.Interface().(已知的类型)
- 遍历
reflect.Type
的Field获取其Field
- 反射可以修改反射类型对象,但是其值必须是“addressable”
- 想要利用反射修改对象状态,前提是
interface.data
是 settable,即 pointer-interface
- 想要利用反射修改对象状态,前提是
- 通过反射可以“动态”调用方法
- 因为Golang本身不支持模板,因此在以往需要使用模板的场景下往往就需要使用反射(reflect)来实现
10.reflect的基本原理
二、结构体标签
1.结构体标签的作用
结构体标签需要通过反射来实现;
- 结构体标签是定义在结构体元素之后的,通过``来标识,标签是key:value结构:
type Resume struct {Name string `info:"name" doc:"我的名字"`Sex string `info:"sex"`
}
- 结构体标签的主要作用是其他的包再倒入当前结构体属性的时候,来判断该属性对其他包的作用,起到说明的作用
2.得到结构体标签
- 首先通过
reflect.TypeOf(input).Elem()
来得到结构体的所有元素(注意:input的类型需要是interface{}
或者指针) - 再通过
type.Field(i).Tag.Get(key)
来获取标签的key对应的value
package struct_tagimport ("fmt""reflect"
)// Golang允许向结构体字段后面绑定标签,使用kv格式
// 主要作用是其他的包再倒入当前结构体属性的时候,来判断该属性对其他包的作用,起到说明的作用
type Resume struct {Name string `info:"name" doc:"我的名字"`Sex string `info:"sex"`
}func findTag(input interface{}) {//通过reflect来得到标签t := reflect.TypeOf(input).Elem() // 得到当前结构体的全部元素for i := 0; i < t.NumField(); i++ {tagInfo := t.Field(i).Tag.Get("info") // 通过标签的key找到标签的valuetagDoc := t.Field(i).Tag.Get("doc")fmt.Println("info:", tagInfo, "doc", tagDoc)}
}func StructTag() {var re ResumefindTag(&re)
}
3.结构体标签在json中的应用
- 可以使用
encoding/json
库中的方法将结构体对象转换为json文件格式 - 如果需要转换为json文件,则需要给结构体字段打上json标签
json.Marshal(movie1)
方法会将带json标签的结构体对象转换为json格式的字符串,格式为标签value:字段的值
json.Unmarshal(jsonStr, &my_movie)
方法会将json格式的字符串转换为相应的结构体类型,注意结构体需要传入的是对象的地址
package struct_tagimport ("encoding/json""fmt""reflect"
)// 可以使用encoding/json将数据转换为json文件格式
// 如果需要转换为json文件,则需要给结构体字段打上json标签
type Movie struct {Title string `json:"title"`Year int `json:"year"`Price int `json:"price"`Actors []string `json:"actors"`
}func ConvertToJson() {movie1 := Movie{"让子弹飞", 2009, 50, []string{"姜文,葛优,周润发"}}//编码的过程 struct --> jsonjsonStr, err := json.Marshal(movie1)if err != nil {fmt.Println("json marshal error", err)return}fmt.Printf("jsonStr = %s\n", jsonStr)//解码的过程 jsonStr --> structmy_movie := Movie{}err = json.Unmarshal(jsonStr, &my_movie)if err != nil {fmt.Println("json unmarshal error", err)return}fmt.Println(my_movie)
}