【轉載】Go語言基礎之反射

title: 【轉載】Go 語言基礎之反射
date: 2021-08-09 16:40:33
comment: false
toc: true
category:

Golang
tags:
轉載
Go
基礎
反射

本文轉載自：Go 語言基礎之反射 | 李文周的博客

本文介紹了 Go 語言反射的意義和基本使用。

變量的內在機制#

Go 語言中的變量是分為兩部分的:

類型信息：預先定義好的元信息。
值信息：程序運行過程中可動態變化的。

反射介紹#

反射是指在程序運行期對程序本身進行訪問和修改的能力。程序在編譯時，變量被轉換為內存地址，變量名不會被編譯器寫入到可執行部分。在運行程序時，程序無法獲取自身的信息。

支持反射的語言可以在程序編譯期將變量的反射信息，如字段名稱、類型信息、結構體信息等整合到可執行文件中，並給程序提供接口訪問反射信息，這樣就可以在程序運行期獲取類型的反射信息，並且有能力修改它們。

Go 程序在運行期使用 reflect 包訪問程序的反射信息。

在上一篇博客中我們介紹了空接口。空接口可以存儲任意類型的變量，那我們如何知道這個空接口保存的數據是什麼呢？反射就是在運行時動態的獲取一個變量的類型信息和值信息。

reflect 包#

在 Go 語言的反射機制中，任何接口值都由是一個具體類型和具體類型的值兩部分組成的 (我們在上一篇接口的博客中有介紹相關概念)。在 Go 語言中反射的相關功能由內置的 reflect 包提供，任意接口值在反射中都可以理解為由reflect.Type和reflect.Value兩部分組成，並且 reflect 包提供了reflect.TypeOf和reflect.ValueOf兩個函數來獲取任意對象的 Value 和 Type。

TypeOf#

在 Go 語言中，使用reflect.TypeOf()函數可以獲得任意值的類型對象（reflect.Type），程序通過類型對象可以訪問任意值的類型信息。

package main

import (
	"fmt"
	"reflect"
)

func reflectType(x interface{}) {
	v := reflect.TypeOf(x)
	fmt.Printf("type:%v\n", v)
}
func main() {
	var a float32 = 3.14
	reflectType(a) // type:float32
	var b int64 = 100
	reflectType(b) // type:int64
}

type name 和 type kind#

在反射中關於類型還劃分為兩種：類型（Type）和種類（Kind）。因為在 Go 語言中我們可以使用 type 关键字構造很多自定義類型，而種類（Kind）就是指底層的類型，但在反射中，當需要區分指針、結構體等大品種的類型時，就會用到種類（Kind）。舉個例子，我們定義了兩個指針類型和兩個結構體類型，通過反射查看它們的類型和種類。

package main

import (
	"fmt"
	"reflect"
)

type myInt int64

func reflectType(x interface{}) {
	t := reflect.TypeOf(x)
	fmt.Printf("type:%v kind:%v\n", t.Name(), t.Kind())
}

func main() {
	var a *float32 // 指針
	var b myInt    // 自定義類型
	var c rune     // 類型別名
	reflectType(a) // type: kind:ptr
	reflectType(b) // type:myInt kind:int64
	reflectType(c) // type:int32 kind:int32

	type person struct {
		name string
		age  int
	}
	type book struct{ title string }
	var d = person{
		name: "沙河小王子",
		age:  18,
	}
	var e = book{title: "《跟小王子學Go語言》"}
	reflectType(d) // type:person kind:struct
	reflectType(e) // type:book 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        // 底層指針
)

ValueOf#

reflect.ValueOf()返回的是reflect.Value類型，其中包含了原始值的值信息。reflect.Value與原始值之間可以互相轉換。

reflect.Value類型提供的獲取原始值的方法如下：

方法	說明
Interface() interface {}	將值以 interface {} 類型返回，可以通過類型斷言轉換為指定類型
Int() int64	將值以 int 類型返回，所有有符號整型均可以此方式返回
Uint() uint64	將值以 uint 類型返回，所有無符號整型均可以此方式返回
Float() float64	將值以雙精度（float64）類型返回，所有浮點數（float32、float64）均可以此方式返回
Bool() bool	將值以 bool 類型返回
Bytes() []bytes	將值以字節數組 [] bytes 類型返回
String() string	將值以字符串類型返回

通過反射獲取值#

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(10)
	fmt.Printf("type c :%T\n", c) // type c :reflect.Value
}

通過反射設置變量的值#

想要在函數中通過反射修改變量的值，需要注意函數參數傳遞的是值拷貝，必須傳遞變量地址才能修改變量值。而反射中使用專有的Elem()方法來獲取指針對應的值。

package main

import (
	"fmt"
	"reflect"
)

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

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())
	// nil值
	fmt.Println("nil IsValid:", reflect.ValueOf(nil).IsValid())
	// 實例化一個匿名結構體
	b := struct{}{}
	// 嘗試從結構體中查找"abc"字段
	fmt.Println("不存在的結構體成員:", reflect.ValueOf(b).FieldByName("abc").IsValid())
	// 嘗試從結構體中查找"abc"方法
	fmt.Println("不存在的結構體方法:", reflect.ValueOf(b).MethodByName("abc").IsValid())
	// map
	c := map[string]int{}
	// 嘗試從map中查找一個不存在的鍵
	fmt.Println("map中不存在的鍵：", reflect.ValueOf(c).MapIndex(reflect.ValueOf("娜扎")).IsValid())
}

結構體反射#

與結構體相關的方法#

任意值通過reflect.TypeOf()獲得反射對象信息後，如果它的類型是結構體，可以通過反射值對象（reflect.Type）的NumField()和Field()方法獲得結構體成員的詳細信息。

reflect.Type中與獲取結構體成員相關的方法如下表所示。

方法	說明
Field(i int) StructField	根據索引，返回索引對應的結構體字段的信息。
NumField() int	返回結構體成員字段數量。
FieldByName(name string) (StructField, bool)	根據給定字符串返回字符串對應的結構體字段的信息。
FieldByIndex(index []int) StructField	多層成員訪問時，根據 [] int 提供的每個結構體的字段索引，返回字段的信息。
FieldByNameFunc(match func(string) bool) (StructField,bool)	根據傳入的匹配函數匹配需要的字段。
NumMethod() int	返回該類型的方法集中方法的數目
Method(int) Method	返回該類型方法集中的第 i 個方法
MethodByName(string)(Method, bool)	根據方法名返回該類型方法集中的方法

StructField 類型#

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      // 是否匿名字段
}

結構體反射示例#

當我們使用反射得到一個結構體數據之後可以通過索引依次獲取其字段信息，也可以通過字段名去獲取指定的字段信息。

type student struct {
	Name  string `json:"name"`
	Score int    `json:"score"`
}

func main() {
	stu1 := student{
		Name:  "小王子",
		Score: 90,
	}

	t := reflect.TypeOf(stu1)
	fmt.Println(t.Name(), t.Kind()) // student 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"))
	}

	// 通過字段名獲取指定結構體字段信息
	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"))
	}
}

接下來編寫一個函數printMethod(s interface{})來遍歷打印 s 包含的方法。

// 給student添加兩個方法 Study和Sleep(注意首字母大寫)
func (s student) Study() string {
	msg := "好好學習，天天向上。"
	fmt.Println(msg)
	return msg
}

func (s student) Sleep() string {
	msg := "好好睡覺，快快長大。"
	fmt.Println(msg)
	return msg
}

func printMethod(x interface{}) {
	t := reflect.TypeOf(x)
	v := reflect.ValueOf(x)

	fmt.Println(t.NumMethod())
	for i := 0; i < v.NumMethod(); i++ {
		methodType := v.Method(i).Type()
		fmt.Printf("method name:%s\n", t.Method(i).Name)
		fmt.Printf("method:%s\n", methodType)
		// 通過反射調用方法傳遞的參數必須是 []reflect.Value 類型
		var args = []reflect.Value{}
		v.Method(i).Call(args)
	}
}

反射是把雙刃劍#

反射是一個強大並富有表現力的工具，能讓我們寫出更靈活的代碼。但是反射不應該被濫用，原因有以下三個。

基於反射的代碼是極其脆弱的，反射中的類型錯誤會在真正運行的時候才會引發 panic，那很可能是在代碼寫完的很長時間之後。
大量使用反射的代碼通常難以理解。
反射的性能低下，基於反射實現的代碼通常比正常代碼運行速度慢一到兩個數量級。

練習題#

編寫代碼利用反射實現一個 ini 文件的解析器程序。