Create a new instance of a struct from its type in go

前言

為了讓程式更有彈性, 在某些情況下會需要在 runtime 的時候建立 struct 的實例, 透過使用 Go Lang 內建的 reflect 套件, 就可以輕鬆地動態產生實例並且賦值

以實作一個Copy的函式為例

 func Copy(i interface{}) interface{}{
    objType := reflect.TypeOf(i)
    objVal := reflect.ValueOf(i)
    newObjValPtr := reflect.New(objType) 
    newObjValPtr.Elem().Set(objVal)

    return newObjValPtr.Elem().Interface()
}

首先呼叫reflect.TypeOf取得某個型態的相關結構資訊

objType := reflect.TypeOf(i)

Note

以Go Lang的設計原則來說, 每個變數都會有一組資訊用來記錄值以及型態的資訊
(value, type )

接著呼叫reflect.ValueOf傳回一個 Value 的實例
(Value 是定義在 reflect 套件裡的結構, 提供了一些方法可以取得實際的值)

objVal := reflect.ValueOf(i)

接下來傳遞型態資訊給reflect.New來產生一個空的 Value 實例

newObjValPtr := reflect.New(objType)

實際上 reflect.New 並不是直接回傳空的 Value 實例, 而是回傳一個實際值為指向空 Value 的指標的 Value 實例

若要對這個空 Value 賦值, 必須使用.Elem取得 newObjValPtr 的實際值指向的本體後, 才能以.Set賦值

newObjValPtr.Elem().Set(objVal)

Note

Value的值若是一個指標, 必須透過 Elem() 方法才能取得目標值

最後再用.Interface以 Interface{}的形態輸出

newObjValPtr.Elem().Interface()

實驗1.

func Main(){
  page := Paging{
    Offset: 1,
    Size: 10,
  }

  newPage := Copy(page)
  fmt.Println(newPage) // {10, 1}
}

實驗2.

func Main(){
  page := &Paging{
    Offset: 1,
    Size: 10,
  }

  newPage := Copy(page)
  fmt.Println(newPage) // &{10, 1}
}

若 Copy 傳入的參數是個結構變數但卻要返回一個指標的結構變數
可以在輸出時呼叫.Addr來獲得指標

newObjValPtr.Elem().Addr().Interface()

實驗3.

func Main(){
  page := Paging{
    Offset: 1,
    Size: 10,
  }

  newPage := Copy(page)
  fmt.Println(newPage) // &{10, 1}
}

總結

relfect 是個非常好用的工具,  方便我們可以在 runtime 時即時探知變數的型態與實際值, 如此一來就能動態的建立實例以及賦值, 唯一的缺點是 relfect 事實上會影響到程式執行的 Performance, 這是我們在實務上必須注意的事情