Golang 中反射的應用實例詳解
引言
首先來一段簡單的代碼邏輯熱身，下面的代碼大傢覺得應該會打印什麼呢？
type OKR struct {
id int
content string
}
func getOkrDetail(ctx context.Context, okrId int) (*OKR, *okrErr.OkrErr) {
return &OKR{id: okrId, content: fmt.Sprint(rand.Int63())}, nil
}
func getOkrDetailV2(ctx context.Context, okrId int) (*OKR, okrErr.OkrError) {
if okrId == 2{
return nil, okrErr.OKRNotFoundError
}
return &OKR{id: okrId, content: fmt.Sprint(rand.Int63())}, nil
}
func paperOkrId(ctx context.Context) (int, error){
return 1, nil
}
func Test001(ctx context.Context) () {
var okr *OKR
okrId, err := paperOkrId(ctx)
if err != nil{
fmt.Println("#### 111 ####")
}
okr, err = getOkrDetail(ctx, okrId)
if err != nil {
fmt.Println("#### 222 ####")
}
okr, err = getOkrDetailV2(ctx, okrId)
if err != nil {
fmt.Println("#### 333 ####")
}
okr, err = getOkrDetailV2(ctx, okrId + 1)
if err != nil {
fmt.Println("#### 444 ####")
}
fmt.Println("#### 555 ####")
fmt.Printf("%v", okr)
}
func main() {
Test001(context.Background())
}
Golang類型設計原則
在講反射之前，先來看看 Golang 關於類型設計的一些原則
- 在 Golang 中變量包括（type, value）兩部分
- 理解這一點就能解決上面的簡單問題瞭
- type 包括 static type 和 concrete type. 簡單來說 static type 是你在編碼是看見的類型(如 int、string)，concrete type 是 runtime 系統看見的類型。類型斷言能否成功，取決於變量的 concrete type，而不是 static type.
接下來要說的反射，就是能夠在運行時更新變量和檢查變量的值、調用變量的方法和變量支持的內在操作，而不需要在編譯時就知道這些變量的具體類型。這種機制被稱為反射。Golang 的基礎類型是靜態的（也就是指定 int、string 這些的變量，它的 type 是 static type），在創建變量的時候就已經確定，反射主要與 Golang 的 interface 類型相關（它的 type 是 concrete type），隻有運行時 interface 類型才有反射一說。
Golang 中為什麼要使用反射/什麼場景可以（應該）使用反射
當程序運行時， 我們獲取到一個 interface 變量， 程序應該如何知道當前變量的類型，和當前變量的值呢？
當然我們可以有預先定義好的指定類型， 但是如果有一個場景是我們需要編寫一個函數，能夠處理一類共性邏輯的場景，但是輸入類型很多，或者根本不知道接收參數的類型是什麼，或者可能是沒約定好；
也可能是傳入的類型很多，這些類型並不能統一表示。
這時反射就會用的上瞭，典型的例子如：json.Marshal。
再比如說有時候需要根據某些條件決定調用哪個函數，比如根據用戶的輸入來決定。這時就需要對函數和函數的參數進行反射，在運行期間動態地執行函數。
舉例場景：
比如我們需要將一個 struct 執行某種操作（用格式化打印代替），這種場景下我們有多種方式可以實現，比較簡單的方式是：switch case
func Sprint(x interface{}) string {
type stringer interface {
String() string
}
switch x := x.(type) {
case stringer:
return x.String()
case string:
return x
case int:
return strconv.Itoa(x)
// int16, uint32...
case bool:
if x {
return "true"
}
return "false"
default:
return "wrong parameter type"
}
}
type permissionType int64
但是這種簡單的方法存在一個問題， 當增加一個場景時，比如需要對 slice 支持，則需要在增加一個分支，這種增加是無窮無盡的，每當我需要支持一種類型，哪怕是自定義類型， 本質上是 int64 也仍然需要增加一個分支。
反射的基本用法
在 Golang 中為我們提供瞭兩個方法，分別是 reflect.ValueOf 和 reflect.TypeOf，見名知意這兩個方法分別能幫我們獲取到對象的值和類型。Valueof 返回的是 Reflect.Value 對象，是一個 struct,而 typeof 返回的是 Reflect.Type 是一個接口。我們隻需要簡單的使用這兩個進行組合就可以完成多種功能。
type GetOkrDetailResp struct {
OkrId int64
UInfo *UserInfo
ObjList []*ObjInfo
}
type ObjInfo struct {
ObjId int64
Content string
}
type UserInfo struct {
Name string
Age int
IsLeader bool
Salary float64
privateFiled int
}
// 利用反射創建struct
func NewUserInfoByReflect(req interface{})*UserInfo{
if req == nil{
return nil
}
reqType :=reflect.TypeOf(req)
if reqType.Kind() == reflect.Ptr{
reqType = reqType.Elem()
}
return reflect.New(reqType).Interface().(*UserInfo)
}
// 修改struct 字段值
func ModifyOkrDetailRespData(req interface{}) {
reqValue :=reflect.ValueOf(req).Elem()
fmt.Println(reqValue.CanSet())
uType := reqValue.FieldByName("UInfo").Type().Elem()
fmt.Println(uType)
uInfo := reflect.New(uType)
reqValue.FieldByName("UInfo").Set(uInfo)
}
// 讀取 struct 字段值，並根據條件進行過濾
func FilterOkrRespData(reqData interface{}, objId int64){
// 首先獲取req中obj slice 的value
for i := 0 ; i < reflect.ValueOf(reqData).Elem().NumField(); i++{
fieldValue := reflect.ValueOf(reqData).Elem().Field(i)
if fieldValue.Kind() != reflect.Slice{
continue
}
fieldType := fieldValue.Type() // []*ObjInfo
sliceType := fieldType.Elem() // *ObjInfo
slicePtr := reflect.New(reflect.SliceOf(sliceType)) // 創建一個指向 slice 的指針
slice := slicePtr.Elem()
slice.Set(reflect.MakeSlice(reflect.SliceOf(sliceType), 0, 0)) // 將這個指針指向新創建slice
// 過濾所有objId == 當前objId 的struct
for i := 0 ;i < fieldValue.Len(); i++{
if fieldValue.Index(i).Elem().FieldByName("ObjId").Int() != objId {
continue
}
slice = reflect.Append(slice, fieldValue.Index(i))
}
// 將resp 的當前字段設置為過濾後的slice
fieldValue.Set(slice)
}
}
func Test003(){
// 利用反射創建一個新的對象
var uInfo *UserInfo
uInfo = NewUserInfoByReflect(uInfo)
uInfo = NewUserInfoByReflect((*UserInfo)(nil))
// 修改resp 返回值裡面的 user info 字段（初始化）
reqData1 := new(GetOkrDetailResp)
fmt.Println(reqData1.UInfo)
ModifyOkrDetailRespData(reqData1)
fmt.Println(reqData1.UInfo)
// 構建請求參數
reqData := &GetOkrDetailResp{OkrId: 123}
for i := 0; i < 10; i++{
reqData.ObjList = append(reqData.ObjList, &ObjInfo{ObjId: int64(i), Content: fmt.Sprint(i)})
}
// 輸出過濾前結果
fmt.Println(reqData)
// 對respData進行過濾操作
FilterOkrRespData(reqData, 6)
// 輸出過濾後結果
fmt.Println(reqData)
}
反射的性能分析與優缺點
大傢都或多或少聽說過反射性能偏低，使用反射要比正常調用要低幾倍到數十倍，不知道大傢有沒有思考過反射性能都低在哪些方面，我先做一個簡單分析，通過反射在獲取或者修改值內容時，多瞭幾次內存引用，多繞瞭幾次彎，肯定沒有直接調用某個值來的迅速，這個是反射帶來的固定性能損失，還有一方面的性能損失在於，結構體類型字段比較多時，要進行遍歷匹配才能獲取對應的內容。
下面就根據反射具體示例來分析性能：
測試反射結構體初始化
// 測試結構體初始化的反射性能
func Benchmark_Reflect_New(b *testing.B) {
var tf *TestReflectField
t := reflect.TypeOf(TestReflectField{})
for i := 0; i < b.N; i++ {
tf = reflect.New(t).Interface().(*TestReflectField)
}
_ = tf
}
// 測試結構體初始化的性能
func Benchmark_New(b *testing.B) {
var tf *TestReflectField
for i := 0; i < b.N; i++ {
tf = new(TestReflectField)
}
_ = tf
}
運行結果：
可以看出，利用反射初始化結構體和直接使用創建 new 結構體是有性能差距的，但是差距不大，不到一倍的性能損耗，看起來對於性能來說損耗不是很大，可以接受。
測試結構體字段讀取/賦值
// --------- ------------ 字段讀 ----------- ----------- -----------
// 測試反射讀取結構體字段值的性能
func Benchmark_Reflect_GetField(b *testing.B) {
var tf = new(TestReflectField)
var r int64
temp := reflect.ValueOf(tf).Elem()
for i := 0; i < b.N; i++ {
r = temp.Field(1).Int()
}
_ = tf
_ = r
}
// 測試反射讀取結構體字段值的性能
func Benchmark_Reflect_GetFieldByName(b *testing.B) {
var tf = new(TestReflectField)
temp := reflect.ValueOf(tf).Elem()
var r int64
for i := 0; i < b.N; i++ {
r = temp.FieldByName("Age").Int()
}
_ = tf
_ = r
}
// 測試結構體字段讀取數據的性能
func Benchmark_GetField(b *testing.B) {
var tf = new(TestReflectField)
tf.Age = 1995
var r int
for i := 0; i < b.N; i++ {
r = tf.Age
}
_ = tf
_ = r
}
// --------- ------------ 字段寫 ----------- ----------- -----------
// 測試反射設置結構體字段的性能
func Benchmark_Reflect_Field(b *testing.B) {
var tf = new(TestReflectField)
temp := reflect.ValueOf(tf).Elem()
for i := 0; i < b.N; i++ {
temp.Field(1).SetInt(int64(25))
}
_ = tf
}
// 測試反射設置結構體字段的性能
func Benchmark_Reflect_FieldByName(b *testing.B) {
var tf = new(TestReflectField)
temp := reflect.ValueOf(tf).Elem()
for i := 0; i < b.N; i++ {
temp.FieldByName("Age").SetInt(int64(25))
}
_ = tf
}
// 測試結構體字段設置的性能
func Benchmark_Field(b *testing.B) {
var tf = new(TestReflectField)
for i := 0; i < b.N; i++ {
tf.Age = i
}
_ = tf
}
測試結果：
從上面可以看出，通過反射進行 struct 字段讀取耗時是直接讀取耗時的百倍。直接對實例變量進行賦值每次 0.5 ns，性能是通過反射操作實例指定位置字段的10 倍左右。
使用 FieldByName("Age") 方法性能比使用 Field(1) 方法性能要低十倍左右，看代碼的話我們會發現，FieldByName 是通過遍歷匹配所有的字段，然後比對字段名稱，來查詢其在結構體中的位置，然後通過位置進行賦值，所以性能要比直接使用 Field(index) 低上很多。
建議：
- 如果不是必要盡量不要使用反射進行操作， 使用反射時要評估好引入反射對接口性能的影響。
- 減少使用 FieldByName 方法。在需要使用反射進行成員變量訪問的時候，盡可能的使用成員的序號。如果隻知道成員變量的名稱的時候，看具體代碼的使用場景，如果可以在啟動階段或在頻繁訪問前，通過 TypeOf() 、Type.FieldByName() 和 StructField.Index 得到成員的序號。註意這裡需要的是使用的是 reflect.Type 而不是 reflect.Value，通過 reflect.Value 是得不到字段名稱的。
測試結構體方法調用
// 測試通過結構體訪問方法性能
func BenchmarkMethod(b *testing.B) {
t := &TestReflectField{}
for i := 0; i < b.N; i++ {
t.Func0()
}
}
// 測試通過序號反射訪問無參數方法性能
func BenchmarkReflectMethod(b *testing.B) {
v := reflect.ValueOf(&TestReflectField{})
for i := 0; i < b.N; i++ {
v.Method(0).Call(nil)
}
}
// 測試通過名稱反射訪問無參數方法性能
func BenchmarkReflectMethodByName(b *testing.B) {
v := reflect.ValueOf(&TestReflectField{})
for i := 0; i < b.N; i++ {
v.MethodByName("Func0").Call(nil)
}
}
// 測試通過反射訪問有參數方法性能
func BenchmarkReflectMethod_WithArgs(b *testing.B) {
v := reflect.ValueOf(&TestReflectField{})
for i := 0; i < b.N; i++ {
v.Method(1).Call([]reflect.Value{reflect.ValueOf(i)})
}
}
// 測試通過反射訪問結構體參數方法性能
func BenchmarkReflectMethod_WithArgs_Mul(b *testing.B) {
v := reflect.ValueOf(&TestReflectField{})
for i := 0; i < b.N; i++ {
v.Method(2).Call([]reflect.Value{reflect.ValueOf(TestReflectField{})})
}
}
// 測試通過反射訪問接口參數方法性能
func BenchmarkReflectMethod_WithArgs_Interface(b *testing.B) {
v := reflect.ValueOf(&TestReflectField{})
for i := 0; i < b.N; i++ {
var tf TestInterface = &TestReflectField{}
v.Method(3).Call([]reflect.Value{reflect.ValueOf(tf)})
}
}
// 測試訪問多參數方法性能
func BenchmarkMethod_WithManyArgs(b *testing.B) {
s := &TestReflectField{}
for i := 0; i < b.N; i++ {
s.Func4(i, i, i, i, i, i)
}
}
// 測試通過反射訪問多參數方法性能
func BenchmarkReflectMethod_WithManyArgs(b *testing.B) {
v := reflect.ValueOf(&TestReflectField{})
va := make([]reflect.Value, 0)
for i := 1; i <= 6; i++ {
va = append(va, reflect.ValueOf(i))
}
for i := 0; i < b.N; i++ {
v.Method(4).Call(va)
}
}
// 測試訪問有返回值的方法性能
func BenchmarkMethod_WithResp(b *testing.B) {
s := &TestReflectField{}
for i := 0; i < b.N; i++ {
_ = s.Func5()
}
}
// 測試通過反射訪問有返回值的方法性能
func BenchmarkReflectMethod_WithResp(b *testing.B) {
v := reflect.ValueOf(&TestReflectField{})
for i := 0; i < b.N; i++ {
_ = v.Method(5).Call(nil)[0].Int()
}
}
這個測試結果同上面的分析相同
優缺點
優點：
- 反射提高瞭程序的靈活性和擴展性，降低耦合性，提高自適應能力。
- 合理利用反射可以減少重復代碼
缺點：
- 與反射相關的代碼，經常是難以閱讀的。在軟件工程中，代碼可讀性也是一個非常重要的指標。
- Go 語言作為一門靜態語言，編碼過程中，編譯器能提前發現一些類型錯誤，但是對於反射代碼是無能為力的。所以包含反射相關的代碼，很可能會運行很久，才會出錯，這時候經常是直接 panic，可能會造成嚴重的後果。
- 反射對性能影響還是比較大的，比正常代碼運行速度慢一到兩個數量級。所以，對於一個項目中處於運行效率關鍵位置的代碼，盡量避免使用反射特性。
反射在 okr 中的簡單應用
func OkrBaseMW(next endpoint.EndPoint) endpoint.EndPoint {
return func(ctx context.Context, req interface{}) (resp interface{}, err error) {
if req == nil {
return next(ctx, req)
}
requestValue := reflect.ValueOf(req)
// 若req為指針，則轉換為非指針值
if requestValue.Type().Kind() == reflect.Ptr {
requestValue = requestValue.Elem()
}
// 若req的值不是一個struct，則不註入
if requestValue.Type().Kind() != reflect.Struct {
return next(ctx, req)
}
if requestValue.IsValid() {
okrBaseValue := requestValue.FieldByName("OkrBase")
if okrBaseValue.IsValid() && okrBaseValue.Type().Kind() == reflect.Ptr {
okrBase, ok := okrBaseValue.Interface().(*okrx.OkrBase)
if ok {
ctx = contextWithUserInfo(ctx, okrBase)
ctx = contextWithLocaleInfo(ctx, okrBase)
ctx = contextWithUserAgent(ctx, okrBase)
ctx = contextWithCsrfToken(ctx, okrBase)
ctx = contextWithReferer(ctx, okrBase)
ctx = contextWithXForwardedFor(ctx, okrBase)
ctx = contextWithHost(ctx, okrBase)
ctx = contextWithURI(ctx, okrBase)
ctx = contextWithSession(ctx, okrBase)
}
}
}
return next(ctx, req)
}
}
結論
使用反射必定會導致性能下降，但是反射是一個強有力的工具，可以解決我們平時的很多問題，比如數據庫映射、數據序列化、代碼生成場景。
在使用反射的時候，我們需要避免一些性能過低的操作，例如使用 FieldByName() 和MethodByName() 方法，如果必須使用這些方法的時候，我們可以預先通過字段名或者方法名獲取到對應的字段序號，然後使用性能較高的反射操作，以此提升使用反射的性能。
以上就是Golang 中反射的應用實例詳解的詳細內容，更多關於Golang 反射應用的資料請關註WalkonNet其它相關文章！
推薦閱讀：
- Go語言基礎反射示例詳解
- go語言通過反射創建結構體、賦值、並調用對應的操作
- golang 實現兩個結構體復制字段
- Golang反射獲取變量類型和值的方法詳解
- Golang語言學習拿捏Go反射示例教程