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型別提供的獲取原始值的方法如下：

通過反射獲取值

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中與獲取結構體成員相關的的方法如下表所示，

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

反射是把雙刃劍

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

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

練習題

1. 撰寫代碼利用反射實作一個ini檔案的決議器程式，

標籤：Go

上一篇：Go語言基礎之并發

下一篇：Go語言基礎之介面