Golang中結構體映射mapstructure庫深入詳解
在數據傳遞時,需要先編解碼;常用的方式是JSON編解碼(參見《golang之JSON處理》)。但有時卻需要讀取部分字段後,才能知道具體類型,此時就可借助mapstructure庫瞭。
mapstructure庫
mapstructure可方便地實現map[string]interface{}
與struct
間的轉換;使用前,需要先導入庫:
go get github.com/mitchellh/mapstructure
字段標簽
默認情況下,mapstructure使用字段的名稱做匹配映射(即在map中以字段名為鍵值查找字段值);註意匹配時是忽略大小寫的。也可通過標簽來設定字段映射名稱:
type Person struct { Name string `mapstructure:"userName"` }
內嵌結構
go中結構體是可以任意嵌套的;嵌套後即認為擁有對應的字段。但是,默認情況下mapstructure隻處理當前結構定義的字段,若要自動處理內嵌字段需要添加標簽squash
:
type Student struct { Person `mapstructure:",squash"` Age int }
未映射字段
若源數據中有未映射的值(即結構體中無對應的字段),mapstructure默認會忽略它。可以在結構體中定義一個特殊字段(類型為map[string]interface{}
,且標簽要設置為mapstructure:",remain"
),來存放所有未能映射的字段中。
type Student struct { Name string Age int Other map[string]interface{} `mapstructure:",remain"` }
Metadata
mapstructure中可以使用Metadata收集一些解碼時會產生的有用信息。
// mapstructure.go type Metadata struct { Keys []string // 解碼成功的鍵 Unused []string // 源數據中存在,但目標結構中不存在的鍵 Unset []string // 未設定的(源數據中缺失的)鍵 }
為瞭獲取這些信息,需要使用DecodeMetadata來解碼:
var metadata mapstructure.Metadata
err := mapstructure.DecodeMetadata(m, &p, &metadata)
弱類型輸入
有時候,並不想對結構體字段類型和map[string]interface{}
的對應鍵值做強類型一致的校驗。這時可以使用WeakDecode/WeakDecodeMetadata方法,它們會嘗試做類型轉換:
- 佈爾轉字符串:true = “1”, false = “0”;
- 佈爾轉數字:true = 1, false = 0;
- 數字轉佈爾:true if value != 0;
- 字符串轉佈爾:可接受,
- 真:1, t, T, TRUE, true, True
- 假:0, f, F, FALSE, false, False
- 數字轉字符串:自動base10轉換;
- 負數轉為無符號數(上溢);
- 字符串轉數字:根據前綴(如0x等)轉換;
- 空數組與空map間互轉;
- 單個值轉為切片;
逆向轉換
除將map轉換為結構體外,mapstructure也可以將結構體反向解碼為map[string]interface{}
。在反向解碼時,我們可以為某些字段設置mapstructure:“,omitempty”,當這些字段為默認值時,就不會出現在map中:
p := &Student{ Name: "Mike", Age: 12, } var m map[string]interface{} mapstructure.Decode(p, &m)
解碼器
mapstructure提供瞭解碼器(Decoder),可靈活方便地控制解碼:
type DecoderConfig struct { // 若設定,則在任何解碼或類型轉換(設定瞭WeaklyTypedInput)前調用;對於設定瞭squash的內嵌字段,整體調用一次;若返回錯誤,則整個解碼失敗 DecodeHook DecodeHookFunc // 若設定,則源數據中存在未使用字段時,報錯 ErrorUnused bool // 若設定,則有字段未設定時,報錯 ErrorUnset bool // 若設定,則在設定字段前先清空(對於map等類型會先清理掉舊數據) ZeroFields bool // 若設定,支持若類型間的轉換 WeaklyTypedInput bool // Squash will squash embedded structs. Squash bool // Metadata is the struct that will contain extra metadata about // the decoding. If this is nil, then no metadata will be tracked. Metadata *Metadata // Result is a pointer to the struct that will contain the decoded // value. Result interface{} // The tag name that mapstructure reads for field names. This // defaults to "mapstructure" TagName string // IgnoreUntaggedFields ignores all struct fields without explicit // TagName, comparable to `mapstructure:"-"` as default behaviour. IgnoreUntaggedFields bool // MatchName is the function used to match the map key to the struct // field name or tag. Defaults to `strings.EqualFold`. This can be used // to implement case-sensitive tag values, support snake casing, etc. MatchName func(mapKey, fieldName string) bool }
一個支持弱類型轉換的示例:要獲取的結果放到config的result中
Name string Age int } func decoderConfig() { m := map[string]interface{}{ "name": 123, "age": "12", "job": "programmer", } var p Person var metadata mapstructure.Metadata decoder, err := mapstructure.NewDecoder(&mapstructure.DecoderConfig{ WeaklyTypedInput: true, Result: &p, Metadata: &metadata, }) if err != nil { log.Fatal(err) } err = decoder.Decode(m) if err == nil { log.Printf("Result: %#v", p) log.Printf("keys:%#v, unused:%#v\n", metadata.Keys, metadata.Unused) } else { log.Println("decode fail:", err) } }
示例
通過一個messageData結構,action會指示最終的data類型。接收到數據後,先解析出atcion,再根據action轉換為真實的類型。
因time.Time是一個結構體(json序列化時會轉換為時間字符串),mapstructure無法正確處理,所以推薦使用時間戳。
為瞭能正確解析內嵌的DataBasic,需要標記為squash。
import "github.com/mitchellh/mapstructure" type DataBasic struct { DataId string `json:"dataId"` UpdateTime int64 `json:"updateTime"` } type AddedData struct { DataBasic `mapstructure:",squash"` Tag string `json:"tag"` AddParams map[string]any `json:"addParams"` } type messageData struct { Action int `json:"action"` SeqId uint64 `json:"seqId"` Data any `json:"data"` } func decodeData() { add := &AddedData{ DataBasic: DataBasic{ DataId: "a2", UpdateTime: time.Now().UnixMilli(), }, Tag: "tag", AddParams: map[string]any{"dataId": "c2", "otherId": "t2"}, } data := &messageData{ Action: 1, Data: add, } js, err := json.Marshal(data) if err != nil { log.Printf("marshal fail: %v", err) return } got := &messageData{} err = json.Unmarshal(js, got) if err != nil { log.Printf("unmarshal fail: %v", err) return } param := new(AddedData) err = mapstructure.Decode(got.Data, param) if err != nil { log.Printf("unmarshal fail: %v", err) return } log.Printf("param: %+v", param) }
到此這篇關於Golang中結構體映射mapstructure庫深入詳解的文章就介紹到這瞭,更多相關Go mapstructure內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!
推薦閱讀:
- golang中json小談之字符串轉浮點數的操作
- 淺談golang類型斷言,失敗類型斷言返回值問題
- Go 語言 json解析框架與 gjson 詳解
- 詳解Golang如何實現節假日不打擾用戶
- Golang中interface{}轉為數組的操作