Golang中結(jié)構(gòu)體映射mapstructure庫深入詳解
在數(shù)據(jù)傳遞時,需要先編解碼;常用的方式是JSON編解碼(參見《golang之JSON處理》)。但有時卻需要讀取部分字段后,才能知道具體類型,此時就可借助mapstructure庫了。
mapstructure庫
mapstructure可方便地實現(xiàn)map[string]interface{}
與struct
間的轉(zhuǎn)換;使用前,需要先導(dǎo)入庫:
go get github.com/mitchellh/mapstructure
字段標(biāo)簽
默認(rèn)情況下,mapstructure使用字段的名稱做匹配映射(即在map中以字段名為鍵值查找字段值);注意匹配時是忽略大小寫的。也可通過標(biāo)簽來設(shè)定字段映射名稱:
type Person struct { Name string `mapstructure:"userName"` }
內(nèi)嵌結(jié)構(gòu)
go中結(jié)構(gòu)體是可以任意嵌套的;嵌套后即認(rèn)為擁有對應(yīng)的字段。但是,默認(rèn)情況下mapstructure只處理當(dāng)前結(jié)構(gòu)定義的字段,若要自動處理內(nèi)嵌字段需要添加標(biāo)簽squash
:
type Student struct { Person `mapstructure:",squash"` Age int }
未映射字段
若源數(shù)據(jù)中有未映射的值(即結(jié)構(gòu)體中無對應(yīng)的字段),mapstructure默認(rèn)會忽略它??梢栽诮Y(jié)構(gòu)體中定義一個特殊字段(類型為map[string]interface{}
,且標(biāo)簽要設(shè)置為mapstructure:",remain"
),來存放所有未能映射的字段中。
type Student struct { Name string Age int Other map[string]interface{} `mapstructure:",remain"` }
Metadata
mapstructure中可以使用Metadata收集一些解碼時會產(chǎn)生的有用信息。
// mapstructure.go type Metadata struct { Keys []string // 解碼成功的鍵 Unused []string // 源數(shù)據(jù)中存在,但目標(biāo)結(jié)構(gòu)中不存在的鍵 Unset []string // 未設(shè)定的(源數(shù)據(jù)中缺失的)鍵 }
為了獲取這些信息,需要使用DecodeMetadata來解碼:
var metadata mapstructure.Metadata
err := mapstructure.DecodeMetadata(m, &p, &metadata)
弱類型輸入
有時候,并不想對結(jié)構(gòu)體字段類型和map[string]interface{}
的對應(yīng)鍵值做強類型一致的校驗。這時可以使用WeakDecode/WeakDecodeMetadata方法,它們會嘗試做類型轉(zhuǎn)換:
- 布爾轉(zhuǎn)字符串:true = “1”, false = “0”;
- 布爾轉(zhuǎn)數(shù)字:true = 1, false = 0;
- 數(shù)字轉(zhuǎn)布爾:true if value != 0;
- 字符串轉(zhuǎn)布爾:可接受,
- 真:1, t, T, TRUE, true, True
- 假:0, f, F, FALSE, false, False
- 數(shù)字轉(zhuǎn)字符串:自動base10轉(zhuǎn)換;
- 負(fù)數(shù)轉(zhuǎn)為無符號數(shù)(上溢);
- 字符串轉(zhuǎn)數(shù)字:根據(jù)前綴(如0x等)轉(zhuǎn)換;
- 空數(shù)組與空map間互轉(zhuǎn);
- 單個值轉(zhuǎn)為切片;
逆向轉(zhuǎn)換
除將map轉(zhuǎn)換為結(jié)構(gòu)體外,mapstructure也可以將結(jié)構(gòu)體反向解碼為map[string]interface{}
。在反向解碼時,我們可以為某些字段設(shè)置mapstructure:“,omitempty”,當(dāng)這些字段為默認(rèn)值時,就不會出現(xiàn)在map中:
p := &Student{ Name: "Mike", Age: 12, } var m map[string]interface{} mapstructure.Decode(p, &m)
解碼器
mapstructure提供了解碼器(Decoder),可靈活方便地控制解碼:
type DecoderConfig struct { // 若設(shè)定,則在任何解碼或類型轉(zhuǎn)換(設(shè)定了WeaklyTypedInput)前調(diào)用;對于設(shè)定了squash的內(nèi)嵌字段,整體調(diào)用一次;若返回錯誤,則整個解碼失敗 DecodeHook DecodeHookFunc // 若設(shè)定,則源數(shù)據(jù)中存在未使用字段時,報錯 ErrorUnused bool // 若設(shè)定,則有字段未設(shè)定時,報錯 ErrorUnset bool // 若設(shè)定,則在設(shè)定字段前先清空(對于map等類型會先清理掉舊數(shù)據(jù)) ZeroFields bool // 若設(shè)定,支持若類型間的轉(zhuǎn)換 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 }
一個支持弱類型轉(zhuǎn)換的示例:要獲取的結(jié)果放到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結(jié)構(gòu),action會指示最終的data類型。接收到數(shù)據(jù)后,先解析出atcion,再根據(jù)action轉(zhuǎn)換為真實的類型。
因time.Time是一個結(jié)構(gòu)體(json序列化時會轉(zhuǎn)換為時間字符串),mapstructure無法正確處理,所以推薦使用時間戳。
為了能正確解析內(nèi)嵌的DataBasic,需要標(biāo)記為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) }
到此這篇關(guān)于Golang中結(jié)構(gòu)體映射mapstructure庫深入詳解的文章就介紹到這了,更多相關(guān)Go mapstructure內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
使用Golang調(diào)用攝像頭并進(jìn)行圖像處理
近年來,攝像頭成為了我們生活中不可或缺的設(shè)備之一,從智能手機到安全監(jiān)控系統(tǒng),無處不在的攝像頭給我們帶來了便利和安全,在開發(fā)攝像頭相關(guān)的應(yīng)用程序時,選擇一種高效和易用的編程語言是非常重要的,本文將介紹如何使用Golang調(diào)用攝像頭并進(jìn)行圖像處理2023-11-11MacOS中 VSCode 安裝 GO 插件失敗問題的快速解決方法
這篇文章主要介紹了MacOS中 VSCode 安裝 GO 插件失敗問題的快速解決方法,本文給大家介紹的非常詳細(xì),對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-05-05Golang?HTTP服務(wù)超時控制實現(xiàn)原理分析
這篇文章主要介紹了Golang?HTTP服務(wù)超時控制實現(xiàn)原理,HTTP服務(wù)的超時控制是保障服務(wù)高可用性的重要措施之一,由于HTTP服務(wù)可能會遇到網(wǎng)絡(luò)延遲,資源瓶頸等問題,因此需要對請求進(jìn)行超時控制,以避免服務(wù)雪崩等問題,需要的朋友可以參考下2023-05-05