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

原文鏈接:https://juejin.im/post/5a75a4fb5188257a82110544

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

編程語言中反射的概念

在計算機科學領域,反射是指一類應用,它們能夠自描述和自控制。也就是說,這類應用通過採用某種機制來實現對自己行爲的描述(self-representation)和監測(examination),並能根據自身行爲的狀態和結果,調整或修改應用所描述行爲的狀態和相關的語義。

每種語言的反射模型都不同,並且有些語言根本不支持反射。Golang語言實現了反射,反射機制就是在運行時動態的調用對象的方法和屬性,官方自帶的reflect包就是反射相關的,只要包含這個包就可以使用。

多插一句,Golang的gRPC也是通過反射實現的。

interface 和 反射

在講反射之前,先來看看Golang關於類型設計的一些原則

  • 變量包括(type, value)兩部分
    • 理解這一點就知道爲什麼nil != nil了
  • 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,就更容易理解反射。反射就是用來檢測存儲在接口變量內部(值value;類型concrete type) pair對的一種機制。

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

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

運行結果:
type:  float64
value:  1.2345

說明

  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
說明
  1. 轉換的時候,如果轉換的類型不完全符合,則直接panic,類型要求非常嚴格!
  2. 轉換的時候,要區分是指針還是指
  3. 也就是說反射可以將“反射類型對象”再重新轉換爲“接口類型變量”

未知原有類型【遍歷探測其Filed】

很多情況下,我們可能並不知道其具體類型,那麼這個時候,該如何做呢?需要我們進行遍歷探測其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)

}

// 通過接口來獲取任意參數,然後一一揭曉
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進行遍歷
	// 2. 再通過reflect.Type的Field獲取其Field
	// 3. 最後通過Field的Interface()得到對應的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進行遍歷
	for i := 0; i < getType.NumMethod(); i++ {
		m := getType.Method(i)
		fmt.Printf("%s: %v\n", m.Name, m.Type)
	}
}

運行結果:
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)

說明

通過運行結果可以得知獲取未知類型的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. 也就是說反射可以將“反射類型對象”再重新轉換爲“接口類型變量”
  5. struct 或者 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
  3. newValue.CantSet()表示是否可以重新設置其值,如果輸出的是true則可修改,否則不能修改,修改完之後再進行打印發現真的已經修改了。
  4. reflect.Value.Elem() 表示獲取原始值對應的反射對象,只有原始對象才能修改,當前反射對象是不能修改的
  5. 也就是說如果要修改反射類型對象,其值必須是“addressable”【對應的要傳入的是指針,同時要通過Elem方法獲取原始值對應的反射對象】
  6. struct 或者 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)來實現

參考鏈接

轉載自:Golang的反射reflect深入理解和示例

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章