[TOC]

Golang的反射reflect深入理解和示例

【記錄于2018年2月】

編程語言中反射的概念

在計(jì)算機(jī)科學(xué)領(lǐng)域羔飞，反射是指一類應(yīng)用肺樟，它們能夠自描述和自控制。也就是說逻淌，這類應(yīng)用通過采用某種機(jī)制來實(shí)現(xiàn)對(duì)自己行為的描述（self-representation）和監(jiān)測(cè)（examination）么伯，并能根據(jù)自身行為的狀態(tài)和結(jié)果，調(diào)整或修改應(yīng)用所描述行為的狀態(tài)和相關(guān)的語義卡儒。

每種語言的反射模型都不同田柔，并且有些語言根本不支持反射。Golang語言實(shí)現(xiàn)了反射骨望，反射機(jī)制就是在運(yùn)行時(shí)動(dòng)態(tài)的調(diào)用對(duì)象的方法和屬性硬爆，官方自帶的reflect包就是反射相關(guān)的，只要包含這個(gè)包就可以使用锦募。

多插一句摆屯，Golang的gRPC也是通過反射實(shí)現(xiàn)的。

interface 和 反射

在講反射之前糠亩，先來看看Golang關(guān)于類型設(shè)計(jì)的一些原則

• 變量包括（type, value）兩部分

  • 理解這一點(diǎn)就知道為什么nil != nil了

• type 包括 static type和concrete type. 簡(jiǎn)單來說 static type是你在編碼是看見的類型(如int虐骑、string)，concrete type是runtime系統(tǒng)看見的類型

• 類型斷言能否成功赎线，取決于變量的concrete type廷没，而不是static type. 因此，一個(gè) reader變量如果它的concrete type也實(shí)現(xiàn)了write方法的話垂寥，它也可以被類型斷言為writer.

接下來要講的反射颠黎，就是建立在類型之上的，Golang的指定類型的變量的類型是靜態(tài)的（也就是指定int滞项、string這些的變量狭归，它的type是static type），在創(chuàng)建變量的時(shí)候就已經(jīng)確定文判，反射主要與Golang的interface類型相關(guān)（它的type是concrete type）过椎，只有interface類型才有反射一說。

在Golang的實(shí)現(xiàn)中戏仓，每個(gè)interface變量都有一個(gè)對(duì)應(yīng)pair疚宇，pair中記錄了實(shí)際變量的值和類型:

(value, type)

value是實(shí)際變量值，type是實(shí)際變量的類型赏殃。一個(gè)interface{}類型的變量包含了2個(gè)指針敷待，一個(gè)指針指向值的類型【對(duì)應(yīng)concrete type】，另外一個(gè)指針指向?qū)嶋H的值【對(duì)應(yīng)value】仁热。

例如榜揖，創(chuàng)建類型為*os.File的變量，然后將其賦給一個(gè)接口變量r：

tty, err := os.OpenFile("/dev/tty", os.O_RDWR, 0)

var r io.Reader
r = tty

接口變量r的pair中將記錄如下信息：(tty, *os.File)，這個(gè)pair在接口變量的連續(xù)賦值過程中是不變的举哟，將接口變量r賦給另一個(gè)接口變量w:

var w io.Writer
w = r.(io.Writer)

接口變量w的pair與r的pair相同钳幅，都是:(tty, *os.File)，即使w是空接口類型炎滞，pair也是不變的。

interface及其pair的存在诬乞，是Golang中實(shí)現(xiàn)反射的前提册赛，理解了pair，就更容易理解反射震嫉。反射就是用來檢測(cè)存儲(chǔ)在接口變量?jī)?nèi)部(值value森瘪；類型concrete type) pair對(duì)的一種機(jī)制。

Golang的反射reflect

reflect的基本功能TypeOf和ValueOf

既然反射就是用來檢測(cè)存儲(chǔ)在接口變量?jī)?nèi)部(值value票堵；類型concrete type) pair對(duì)的一種機(jī)制扼睬。那么在Golang的reflect反射包中有什么樣的方式可以讓我們直接獲取到變量?jī)?nèi)部的信息呢？ 它提供了兩種類型（或者說兩個(gè)方法）讓我們可以很容易的訪問接口變量?jī)?nèi)容悴势，分別是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用來獲取輸入?yún)?shù)接口中的數(shù)據(jù)的值，如果接口為空則返回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用來動(dòng)態(tài)獲取輸入?yún)?shù)接口中的值的類型特纤，如果接口為空則返回nil

reflect.TypeOf()是獲取pair中的type军俊，reflect.ValueOf()獲取pair中的value，示例如下：

package main

import (
    "fmt"
    "reflect"
)

func main() {
    var num float64 = 1.2345

    fmt.Println("type: ", reflect.TypeOf(num))
    fmt.Println("value: ", reflect.ValueOf(num))
}

運(yùn)行結(jié)果:
type:  float64
value:  1.2345

說明

1. reflect.TypeOf： 直接給到了我們想要的type類型捧存，如float64粪躬、int、各種pointer昔穴、struct 等等真實(shí)的類型

2. reflect.ValueOf：直接給到了我們想要的具體的值镰官，如1.2345這個(gè)具體數(shù)值，或者類似&{1 "Allen.Wu" 25} 這樣的結(jié)構(gòu)體struct的值

3. 也就是說明反射可以將“接口類型變量”轉(zhuǎn)換為“反射類型對(duì)象”吗货，反射類型指的是reflect.Type和reflect.Value這兩種

從relfect.Value中獲取接口interface的信息

當(dāng)執(zhí)行reflect.ValueOf(interface)之后泳唠，就得到了一個(gè)類型為”relfect.Value”變量，可以通過它本身的Interface()方法獲得接口變量的真實(shí)內(nèi)容卿操，然后可以通過類型判斷進(jìn)行轉(zhuǎn)換警检，轉(zhuǎn)換為原有真實(shí)類型。不過害淤，我們可能是已知原有類型扇雕，也有可能是未知原有類型，因此窥摄，下面分兩種情況進(jìn)行說明镶奉。

已知原有類型【進(jìn)行“強(qiáng)制轉(zhuǎn)換”】

已知類型后轉(zhuǎn)換為其對(duì)應(yīng)的類型的做法如下，直接通過Interface方法然后強(qiáng)制轉(zhuǎn)換，如下：

realValue := value.Interface().(已知的類型)

示例如下：

package main

import (
    "fmt"
    "reflect"
)

func main() {
    var num float64 = 1.2345

    pointer := reflect.ValueOf(&num)
    value := reflect.ValueOf(num)

    // 可以理解為“強(qiáng)制轉(zhuǎn)換”哨苛，但是需要注意的時(shí)候鸽凶，轉(zhuǎn)換的時(shí)候，如果轉(zhuǎn)換的類型不完全符合建峭，則直接panic
    // Golang 對(duì)類型要求非常嚴(yán)格玻侥，類型一定要完全符合
    // 如下兩個(gè)，一個(gè)是*float64亿蒸，一個(gè)是float64凑兰，如果弄混，則會(huì)panic
    convertPointer := pointer.Interface().(*float64)
    convertValue := value.Interface().(float64)

    fmt.Println(convertPointer)
    fmt.Println(convertValue)
}

運(yùn)行結(jié)果：
0xc42000e238
1.2345

說明

1. 轉(zhuǎn)換的時(shí)候边锁，如果轉(zhuǎn)換的類型不完全符合姑食，則直接panic，類型要求非常嚴(yán)格茅坛！
2. 轉(zhuǎn)換的時(shí)候音半，要區(qū)分是指針還是指
3. 也就是說反射可以將“反射類型對(duì)象”再重新轉(zhuǎn)換為“接口類型變量”

未知原有類型【遍歷探測(cè)其Filed】

很多情況下，我們可能并不知道其具體類型贡蓖，那么這個(gè)時(shí)候曹鸠，該如何做呢？需要我們進(jìn)行遍歷探測(cè)其Filed來得知斥铺，示例如下:

package main

import (
    "fmt"
    "reflect"
)

type User struct {
    Id   int
    Name string
    Age  int
}

func (u User) ReflectCallFunc() {
    fmt.Println("Allen.Wu ReflectCallFunc")
}

func main() {

    user := User{1, "Allen.Wu", 25}

    DoFiledAndMethod(user)

}

// 通過接口來獲取任意參數(shù)物延，然后一一揭曉
func DoFiledAndMethod(input interface{}) {

    getType := reflect.TypeOf(input)
    fmt.Println("get Type is :", getType.Name())

    getValue := reflect.ValueOf(input)
    fmt.Println("get all Fields is:", getValue)

    // 獲取方法字段
    // 1. 先獲取interface的reflect.Type，然后通過NumField進(jìn)行遍歷
    // 2. 再通過reflect.Type的Field獲取其Field
    // 3. 最后通過Field的Interface()得到對(duì)應(yīng)的value
    for i := 0; i < getType.NumField(); i++ {
        field := getType.Field(i)
        value := getValue.Field(i).Interface()
        fmt.Printf("%s: %v = %v\n", field.Name, field.Type, value)
    }

    // 獲取方法
    // 1. 先獲取interface的reflect.Type仅父，然后通過.NumMethod進(jìn)行遍歷
    for i := 0; i < getType.NumMethod(); i++ {
        m := getType.Method(i)
        fmt.Printf("%s: %v\n", m.Name, m.Type)
    }
}

運(yùn)行結(jié)果：
get Type is : User
get all Fields is: {1 Allen.Wu 25}
Id: int = 1
Name: string = Allen.Wu
Age: int = 25
ReflectCallFunc: func(main.User)

說明

通過運(yùn)行結(jié)果可以得知獲取未知類型的interface的具體變量及其類型的步驟為：

1. 先獲取interface的reflect.Type叛薯，然后通過NumField進(jìn)行遍歷
2. 再通過reflect.Type的Field獲取其Field
3. 最后通過Field的Interface()得到對(duì)應(yīng)的value

通過運(yùn)行結(jié)果可以得知獲取未知類型的interface的所屬方法（函數(shù)）的步驟為：

1. 先獲取interface的reflect.Type，然后通過NumMethod進(jìn)行遍歷
2. 再分別通過reflect.Type的Method獲取對(duì)應(yīng)的真實(shí)的方法（函數(shù)）
3. 最后對(duì)結(jié)果取其Name和Type得知具體的方法名
4. 也就是說反射可以將“反射類型對(duì)象”再重新轉(zhuǎn)換為“接口類型變量”
5. struct 或者 struct 的嵌套都是一樣的判斷處理方式

通過reflect.Value設(shè)置實(shí)際變量的值

reflect.Value是通過reflect.ValueOf(X)獲得的笙纤，只有當(dāng)X是指針的時(shí)候耗溜，才可以通過reflec.Value修改實(shí)際變量X的值，即：要修改反射類型的對(duì)象就一定要保證其值是“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抖拴，注意，參數(shù)必須是指針才能修改其值
    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的參數(shù)不是指針腥椒，會(huì)如何阿宅？
    pointer = reflect.ValueOf(num)
    //newValue = pointer.Elem() // 如果非指針，這里直接panic笼蛛，“panic: reflect: call of reflect.Value.Elem on float64 Value”
}

運(yùn)行結(jié)果：
old value of pointer: 1.2345
type of pointer: float64
settability of pointer: true
new value of pointer: 77

說明

1. 需要傳入的參數(shù)是* float64這個(gè)指針洒放，然后可以通過pointer.Elem()去獲取所指向的Value，注意一定要是指針滨砍。
2. 如果傳入的參數(shù)不是指針往湿，而是變量妖异，那么
   • 通過Elem獲取原始值對(duì)應(yīng)的對(duì)象則直接panic
   • 通過CanSet方法查詢是否可以設(shè)置返回false
3. newValue.CantSet()表示是否可以重新設(shè)置其值，如果輸出的是true則可修改领追，否則不能修改他膳，修改完之后再進(jìn)行打印發(fā)現(xiàn)真的已經(jīng)修改了。
4. reflect.Value.Elem() 表示獲取原始值對(duì)應(yīng)的反射對(duì)象绒窑，只有原始對(duì)象才能修改棕孙，當(dāng)前反射對(duì)象是不能修改的
5. 也就是說如果要修改反射類型對(duì)象，其值必須是“addressable”【對(duì)應(yīng)的要傳入的是指針些膨，同時(shí)要通過Elem方法獲取原始值對(duì)應(yīng)的反射對(duì)象】
6. struct 或者 struct 的嵌套都是一樣的判斷處理方式

通過reflect.ValueOf來進(jìn)行方法的調(diào)用

這算是一個(gè)高級(jí)用法了散罕，前面我們只說到對(duì)類型、變量的幾種反射的用法傀蓉，包括如何獲取其值、其類型职抡、如果重新設(shè)置新值葬燎。但是在工程應(yīng)用中，另外一個(gè)常用并且屬于高級(jí)的用法缚甩，就是通過reflect來進(jìn)行方法【函數(shù)】的調(diào)用谱净。比如我們要做框架工程的時(shí)候，需要可以隨意擴(kuò)展方法擅威，或者說用戶可以自定義方法，那么我們通過什么手段來擴(kuò)展讓用戶能夠自定義呢郊丛？關(guān)鍵點(diǎn)在于用戶的自定義方法是未可知的李请，因此我們可以通過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")
}

// 如何通過反射來進(jìn)行方法的調(diào)用？
// 本來可以用u.ReflectCallFuncXXX直接調(diào)用的厉熟，但是如果要通過反射导盅，那么首先要將方法注冊(cè)，也就是MethodByName揍瑟，然后通過反射調(diào)動(dòng)mv.Call

func main() {
    user := User{1, "Allen.Wu", 25}
    
    // 1. 要通過反射來調(diào)用起對(duì)應(yīng)的方法白翻，必須要先通過reflect.ValueOf(interface)來獲取到reflect.Value，得到“反射類型對(duì)象”后才能做下一步處理
    getValue := reflect.ValueOf(user)

    // 一定要指定參數(shù)為正確的方法名
    // 2. 先看看帶有參數(shù)的調(diào)用方法
    methodValue := getValue.MethodByName("ReflectCallFuncHasArgs")
    args := []reflect.Value{reflect.ValueOf("wudebao"), reflect.ValueOf(30)}
    methodValue.Call(args)

    // 一定要指定參數(shù)為正確的方法名
    // 3. 再看看無參數(shù)的調(diào)用方法
    methodValue = getValue.MethodByName("ReflectCallFuncNoArgs")
    args = make([]reflect.Value, 0)
    methodValue.Call(args)
}


運(yùn)行結(jié)果：
ReflectCallFuncHasArgs name:  wudebao , age: 30 and origal User.Name: Allen.Wu
ReflectCallFuncNoArgs

說明

1. 要通過反射來調(diào)用起對(duì)應(yīng)的方法绢片，必須要先通過reflect.ValueOf(interface)來獲取到reflect.Value滤馍，得到“反射類型對(duì)象”后才能做下一步處理

2. reflect.Value.MethodByName這.MethodByName，需要指定準(zhǔn)確真實(shí)的方法名字底循，如果錯(cuò)誤將直接panic巢株，MethodByName返回一個(gè)函數(shù)值對(duì)應(yīng)的reflect.Value方法的名字。

3. []reflect.Value熙涤，這個(gè)是最終需要調(diào)用的方法的參數(shù)纯续，可以沒有或者一個(gè)或者多個(gè)随珠，根據(jù)實(shí)際參數(shù)來定。

4. reflect.Value的 Call 這個(gè)方法猬错，這個(gè)方法將最終調(diào)用真實(shí)的方法窗看，參數(shù)務(wù)必保持一致，如果reflect.Value'Kind不是一個(gè)方法倦炒，那么將直接panic显沈。

5. 本來可以用u.ReflectCallFuncXXX直接調(diào)用的，但是如果要通過反射逢唤，那么首先要將方法注冊(cè)拉讯，也就是MethodByName，然后通過反射調(diào)用methodValue.Call

Golang的反射reflect性能

Golang的反射很慢鳖藕，這個(gè)和它的API設(shè)計(jì)有關(guān)魔慷。在 java 里面，我們一般使用反射都是這樣來弄的著恩。

Field field = clazz.getField("hello");
field.get(obj1);
field.get(obj2);

這個(gè)取得的反射對(duì)象類型是 java.lang.reflect.Field院尔。它是可以復(fù)用的。只要傳入不同的obj喉誊，就可以取得這個(gè)obj上對(duì)應(yīng)的 field邀摆。

但是Golang的反射不是這樣設(shè)計(jì)的:

type_ := reflect.TypeOf(obj)
field, _ := type_.FieldByName("hello")

這里取出來的 field 對(duì)象是 reflect.StructField 類型，但是它沒有辦法用來取得對(duì)應(yīng)對(duì)象上的值伍茄。如果要取值栋盹，得用另外一套對(duì)object，而不是type的反射

type_ := reflect.ValueOf(obj)
fieldValue := type_.FieldByName("hello")

這里取出來的 fieldValue 類型是 reflect.Value敷矫，它是一個(gè)具體的值例获，而不是一個(gè)可復(fù)用的反射對(duì)象了，每次反射都需要malloc這個(gè)reflect.Value結(jié)構(gòu)體曹仗，并且還涉及到GC躏敢。

小結(jié)

Golang reflect慢主要有兩個(gè)原因

1. 涉及到內(nèi)存分配以及后續(xù)的GC；

2. reflect實(shí)現(xiàn)里面有大量的枚舉整葡，也就是for循環(huán)件余，比如類型之類的。

總結(jié)

上述詳細(xì)說明了Golang的反射reflect的各種功能和用法遭居，都附帶有相應(yīng)的示例啼器，相信能夠在工程應(yīng)用中進(jìn)行相應(yīng)實(shí)踐，總結(jié)一下就是：

• 反射可以大大提高程序的靈活性俱萍，使得interface{}有更大的發(fā)揮余地

  • 反射必須結(jié)合interface才玩得轉(zhuǎn)
  • 變量的type要是concrete type的（也就是interface變量）才有反射一說

• 反射可以將“接口類型變量”轉(zhuǎn)換為“反射類型對(duì)象”

  • 反射使用 TypeOf 和 ValueOf 函數(shù)從接口中獲取目標(biāo)對(duì)象信息

• 反射可以將“反射類型對(duì)象”轉(zhuǎn)換為“接口類型變量

  • reflect.value.Interface().(已知的類型)
  • 遍歷reflect.Type的Field獲取其Field

• 反射可以修改反射類型對(duì)象端壳，但是其值必須是“addressable”

  • 想要利用反射修改對(duì)象狀態(tài)，前提是 interface.data 是 settable,即 pointer-interface

• 通過反射可以“動(dòng)態(tài)”調(diào)用方法

• 因?yàn)镚olang本身不支持模板枪蘑，因此在以往需要使用模板的場(chǎng)景下往往就需要使用反射(reflect)來實(shí)現(xiàn)

參考鏈接

• The Go Blog : 其實(shí)看官方說明就足以了损谦！

• 官方reflect-Kind

• Go語言的反射三定律

• Go基礎(chǔ)學(xué)習(xí)五之接口interface岖免、反射reflection

• 提高 golang 的反射性能