8小时速成golang（四）反射reflect 用于【判断类型，强制类型转换，反射解析结构体标签】 和 结构体【标签注释作用、结构体在json应用】

编程语言中反射的概念

在计算机科学领域，反射是指一类应用，它们能够自描述和自控制。

也就是说，这类应用通过采用某种机制来实现对自己行为的描述（self-representation）和监测（examination），

并能根据自身行为的状态和结果，调整 或 修改应用所描述行为的状态和相关的语义。

每种语言的反射模型都不同，并且有些语言根本不支持反射。

Golang语言实现了反射，反射机制就是在运行时动态的调用对象的方法和属性，官方自带的reflect包就是反射相关的，只要包含这个包就可以使用。

多插一句，Golang的gRPC也是通过反射实现的。

 

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.

反射，就是建立在类型之上的，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，就更容易理解反射。

 

9、反射

反射就是用来检测存储在接口变量内部(值value；类型concrete type) pair对的一种机制。

 pair实例1

package main
import "fmt"
func main() {

    var a string
    //pair<statictype:string, value:"aceld">
    a = "aceld"

    //pair<type:string, value:"aceld">
    var allType interface{}
    allType = a

    str, _ := allType.(string)
    fmt.Println(str)
}

 

 

pair 实例2

调用os标准库里的writer 和reader方法 但是pair都不会变

package main

import (
   "fmt"
   "io"
   "os"
)

func main() {
   //tty: pair<type:*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<type:  , value:>
   var r io.Reader
   //r: pair<type:*os.File, value:"/dev/tty"文件描述符>
   r = tty

   //w: pair<type:  , value:>
   var w io.Writer
   //w: pair<type:*os.File, value:"/dev/tty"文件描述符>
   w = r.(io.Writer)

   w.Write([]byte("HELLO THIS is A TEST!!!\n"))
}

 

 pair实例3

pair一致 type一致 断言就会一致 数据value也会一致

package main

import "fmt"

type Reader interface {
   ReadBook()
}

type Writer interface {
   WriteBook()
}

//具体类型
type Book struct {
}

func (this *Book) ReadBook() {
   fmt.Println("Read a Book")
}

func (this *Book) WriteBook() {
   fmt.Println("Write a Book")
}

func main() {
   //b: pair<type:Book, value:book{}地址>
   b := &Book{}

   //r: pair<type:, value:>
   var r Reader
   //r: pair<type:Book, value:book{}地址>
   r = b

   r.ReadBook()

   var w Writer
   //r: pair<type:Book, value:book{}地址>
   w = r.(Writer) //此处的断言为什么会成功？ 因为w r 具体的type是一致

   w.WriteBook()
}

Golang的反射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

 

 

 

package main

import (
    "fmt"
    "reflect"
)

func reflectNum(arg interface{}) {
    fmt.Println("type : ", reflect.TypeOf(arg))
    fmt.Println("value : ", reflect.ValueOf(arg))
}

func main() {
    var num float64 = 1.2345
    reflectNum(num)
}

结果

 

 

说明

1. reflect.TypeOf： 直接给到了我们想要的type类型，如float64、int、各种pointer、struct 等等真实的类型
2. reflect.ValueOf：直接给到了我们想要的具体的值，如1.2345这个具体数值，或者类似&{1 "Allen.Wu" 25} 这样的结构体struct的值
3. 也就是说明反射可以将“接口类型变量”转换为“反射类型对象”，反射类型指的是reflect.Type和reflect.Value这两种

从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)
}

运行结果：
0xc42000e238
1.2345

说明

通过运行结果可以得知获取未知类型的interface的具体变量及其类型的步骤为：

1先获取interface的reflect.Type，然后通过NumField进行遍历
2再通过reflect.Type的Field获取其Field
3最后通过Field的Interface()得到对应的value

通过运行结果可以得知获取未知类型的interface的所属方法（函数）的步骤为：

1先获取interface的reflect.Type，然后通过NumMethod进行遍历
2再分别通过reflect.Type的Method获取对应的真实的方法（函数）
3最后对结果取其Name和Type得知具体的方法名
4也就是说反射可以将“反射类型对象”再重新转换为“接口类型变量”
5struct 或者 struct 的嵌套都是一样的判断处理方式

 

 

通过reflect.Value设置实际变量的值

reflect.Value是通过reflect.ValueOf(X)获得的，只有当X是指针的时候，才可以通过reflec.Value修改实际变量X的值，即：要修改反射类型的对象就一定要保证其值是“addressable”的。

示例如下：

package main

import (
    "fmt"
    "reflect"
)

func main() {

    var num float64 = 1.2345
    fmt.Println("old value of pointer:", num)

    // 通过reflect.ValueOf获取num中的reflect.Value，注意，参数必须是指针才能修改其值
    pointer := reflect.ValueOf(&num)
    newValue := pointer.Elem()

    fmt.Println("type of pointer:", newValue.Type())
    fmt.Println("settability of pointer:", newValue.CanSet())

    // 重新赋值
    newValue.SetFloat(77)
    fmt.Println("new value of pointer:", num)

    ////////////////////
    // 如果reflect.ValueOf的参数不是指针，会如何？
    pointer = reflect.ValueOf(num)
    //newValue = pointer.Elem() // 如果非指针，这里直接panic，“panic: reflect: call of reflect.Value.Elem on float64 Value”
}

运行结果：
old value of pointer: 1.2345
type of pointer: float64
settability of pointer: true
new value of pointer: 77

说明

1需要传入的参数是* float64这个指针，然后可以通过pointer.Elem()去获取所指向的Value，注意一定要是指针。
2如果传入的参数不是指针，而是变量，那么
○通过Elem获取原始值对应的对象则直接panic
○通过CanSet方法查询是否可以设置返回false
3newValue.CantSet()表示是否可以重新设置其值，如果输出的是true则可修改，否则不能修改，修改完之后再进行打印发现真的已经修改了。
4reflect.Value.Elem() 表示获取原始值对应的反射对象，只有原始对象才能修改，当前反射对象是不能修改的
5也就是说如果要修改反射类型对象，其值必须是“addressable”【对应的要传入的是指针，同时要通过Elem方法获取原始值对应的反射对象】
6struct 或者 struct 的嵌套都是一样的判断处理方式

通过reflect.ValueOf来进行方法的调用

这算是一个高级用法了，前面我们只说到对类型、变量的几种反射的用法，包括如何获取其值、其类型、如果重新设置新值。但是在工程应用中，另外一个常用并且属于高级的用法，就是通过reflect来进行方法【函数】的调用。比如我们要做框架工程的时候，需要可以随意扩展方法，或者说用户可以自定义方法，那么我们通过什么手段来扩展让用户能够自定义呢？关键点在于用户的自定义方法是未可知的，因此我们可以通过reflect来搞定

示例如下：

package main

import (
    "fmt"
    "reflect"
)

type User struct {
    Id   int
    Name string
    Age  int
}

func (u User) ReflectCallFuncHasArgs(name string, age int) {
    fmt.Println("ReflectCallFuncHasArgs name: ", name, ", age:", age, "and origal User.Name:", u.Name)
}

func (u User) ReflectCallFuncNoArgs() {
    fmt.Println("ReflectCallFuncNoArgs")
}

// 如何通过反射来进行方法的调用？
// 本来可以用u.ReflectCallFuncXXX直接调用的，但是如果要通过反射，那么首先要将方法注册，也就是MethodByName，然后通过反射调动mv.Call

func main() {
    user := User{1, "Allen.Wu", 25}
    
    // 1. 要通过反射来调用起对应的方法，必须要先通过reflect.ValueOf(interface)来获取到reflect.Value，得到“反射类型对象”后才能做下一步处理
    getValue := reflect.ValueOf(user)

    // 一定要指定参数为正确的方法名
    // 2. 先看看带有参数的调用方法
    methodValue := getValue.MethodByName("ReflectCallFuncHasArgs")
    args := []reflect.Value{reflect.ValueOf("wudebao"), reflect.ValueOf(30)}
    methodValue.Call(args)

    // 一定要指定参数为正确的方法名
    // 3. 再看看无参数的调用方法
    methodValue = getValue.MethodByName("ReflectCallFuncNoArgs")
    args = make([]reflect.Value, 0)
    methodValue.Call(args)
}


运行结果：
ReflectCallFuncHasArgs name:  wudebao , age: 30 and origal User.Name: Allen.Wu
ReflectCallFuncNoArgs

 

说明

 

1. 要通过反射来调用起对应的方法，必须要先通过reflect.ValueOf(interface)来获取到reflect.Value，得到“反射类型对象”后才能做下一步处理
2. reflect.Value.MethodByName这.MethodByName，需要指定准确真实的方法名字，如果错误将直接panic，MethodByName返回一个函数值对应的reflect.Value方法的名字。
3. []reflect.Value，这个是最终需要调用的方法的参数，可以没有或者一个或者多个，根据实际参数来定。
4. reflect.Value的 Call 这个方法，这个方法将最终调用真实的方法，参数务必保持一致，如果reflect.Value'Kind不是一个方法，那么将直接panic。
5. 本来可以用u.ReflectCallFuncXXX直接调用的，但是如果要通过反射，那么首先要将方法注册，也就是MethodByName，然后通过反射调用methodValue.Call

 

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慢主要有两个原因

1. 涉及到内存分配以及后续的GC；
2. reflect实现里面有大量的枚举，也就是for循环，比如类型之类的.

总结

 

上述详细说明了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、结构体标签

一、反射解析结构体标签

1、结构体的定义，用键盘1旁边的` 

2、结构体的解析

反射得到Typeof，得到elem的元素集合t,t数量 然后得到key,后面就能得到value

 3、结构体的应用

json编解码

arm映射关系

 

package main

import (
    "fmt"
    "reflect"
)

type resume struct {
    Name string `json:"name" doc:"我的名字"`
}

func findDoc(stru interface{}) map[string]string {
//先用反射的Typeof方法找到当前有多少个多少种类型,并且用NumField知道里面有多少个元素即多少个ELem 然后打印出来
    t := reflect.TypeOf(stru).Elem()
    doc := make(map[string]string)

    for i := 0; i < t.NumField(); i++ {
        doc[t.Field(i).Tag.Get("json")] = t.Field(i).Tag.Get("doc")
    }

    return doc

}

func main() {
    var stru resume
    doc := findDoc(&stru)
    fmt.Printf("name字段为：%s\n", doc["name"])
}

 

 

 标签的作用是为了在其他包 导入这个属性对属性的说明，视图别名 等

 

二、结构体标签在json中的使用

import (
    "encoding/json"
    "fmt"
)

type Movie struct {
    Title  string   `json:"title"`
    Year   int      `json:"year"`
    Price  int      `json:"rmb"`
    Actors []string `json:"actors"`
}

func main() {
    movie := Movie{"喜剧之王", 2000, 10, []string{"xingye", "zhangbozhi"}}

    //编码的过程  结构体---> json
    jsonStr, err := json.Marshal(movie)
    if err != nil {
        fmt.Println("json marshal error", err)
        return
    }

    fmt.Printf("jsonStr = %s\n", jsonStr)

    //解码的过程 jsonstr ---> 结构体
    //jsonStr = {"title":"喜剧之王","year":2000,"rmb":10,"actors":["xingye","zhangbozhi"]}
    myMovie := Movie{}
    err = json.Unmarshal(jsonStr, &myMovie)
    if err != nil {
        fmt.Println("json unmarshal error ", err)
        return
    }

    fmt.Printf("%v\n", myMovie)
}

 

1. json.Marshal(person)：将数据结构转换为json字符串

type Student struct {
    Name  string `json:"name"`
    Age   int    `json:"age"`
    High  int    `json:"high"`
    Sex   string `json:"sex"`
    Class *Class `json:"class"`
}

type Class struct {
    ClassName string `json:"classname"`
    Grade     int    `json:"grade"`
}

func main() {
    //实例化一个数据结构，用于生成json字符串
    person := Student{
        Name: "张三",
        Age:  18,
        High: 182,
        Sex:  "男",
    }

    //指针变量
    class := new(Class)
    class.ClassName = "1班"
    class.Grade = 3
    person.Class = class

    //Marshal失败时err!=nil
    jsonbyte, err := json.Marshal(person)
    if err != nil {
        fmt.Println("生成json字符串错误")
    }
    //jsonbyte是[]byte类型，转化成string类型便于查看
    fmt.Println(string(jsonbyte))
}
//输出：
//{"name":"张三","age":18,"high":182,"sex":"男","class":{"classname":"1班","grade":3}}

 

2. json.Unmarshal(str, &stu)：将json字符串转换为数据结构

type Student struct {
    Name    interface{} `json:"personname"`
    Age     interface{} `json:"age"`
    High    interface{} `json:"high"`
    Sex     interface{} `json:"sex"`
    Class   interface{} `json:"class"`
    Message interface{} `json:"message"`
}

type Class struct {
    ClassName string `json:"classname"`
    Grade     int    `json:"grade"`
}

func main() {
    //json字符中的"引号，需用\进行转义，否则编译出错
    data := "{\"personname\":\"张三\",\"age\":18,\"high\":182,\"sex\":\"男\",\"class\":{\"classname\":\"1班\",\"grade\":3},\"message\":\"测试成功！\"}"
    //转换格式
    str := []byte(data)

    //Unmarshal的第一个参数是json字符串，第二个参数是接受json解析的数据结构。
    //第二个参数必须是指针，否则无法接收解析的数据，如stu仍为空对象Student{}
    //注：可以直接stu:=new(Student),此时的stu自身就是指针
    stu := Student{}
    err := json.Unmarshal(str, &stu)
    //解析失败会报错，如json字符串格式不对，缺"号，缺}等。
    if err != nil {
        fmt.Println(err)
    }
    fmt.Println(stu)
}
//输出：
//{张三 18 182 男 map[classname:1班 grade:3] 测试成功！}