教程集 > Golang编程 > golang教程 > 正文 Golang自定义结构体转map

Golang自定义结构体转map

发布时间：2022-12-09 编辑：jiaochengji.com

教程集为您提供Golang自定义结构体转map等资源，欢迎您收藏本站，我们将为您提供最新的Golang自定义结构体转map资源

在Golang中，如何将一个结构体转成map？本文介绍两种方法。第一种是是使用<code>json</code>包解析解码编码。第二种是使用反射，使用反射的效率比较高，代码在这里。如果觉得代码有用，可以给我的代码仓库一个star。

假设有下面的一个结构体

<pre><code class="hljs go" lang="go">func newUser() User { name := "user" MyGithub := GithubPage{ URL: "https://github.com/liangyaopei", Star: 1, } NoDive := StructNoDive{NoDive: 1} dateStr := "2020-07-21 12:00:00" date, _ := time.Parse(timeLayout, dateStr) profile := Profile{ Experience: "my experience", Date: date, } return User{ Name: name, Github: MyGithub, NoDive: NoDive, MyProfile: profile, } } type User struct { Name string `map:"name,omitempty"` // string Github GithubPage `map:"github,dive,omitempty"` // struct dive NoDive StructNoDive `map:"no_dive,omitempty"` // no dive struct MyProfile Profile `map:"my_profile,omitempty"` // struct implements its own method } type GithubPage struct { URL string `map:"url"` Star int `map:"star"` } type StructNoDive struct { NoDive int } type Profile struct { Experience string `map:"experience"` Date time.Time `map:"time"` } // its own toMap method func (p Profile) StructToMap() (key string, value interface{}) { return "time", p.Date.Format(timeLayout) } </code></pre><h2 class="heading">json包的marshal，unmarshal</h2>

先将结构体序列化成<code>[]byte</code>数组，再从<code>[]byte</code>数组序列化成结构体。

<pre><code class="hljs go" lang="go">data, _ := json.Marshal(&user) m := make(map[string]interface{}) json.Unmarshal(data, &m) </code></pre>

优势

<ul> <li>使用简单劣势</li> <li>效率比较慢</li> <li>不能支持一些定制的键，也不能支持一些定制的方法，例如将struct的域展开等。</li> </ul> <h2 class="heading">使用反射</h2>

本文实现了使用反射将结构体转成<code>map</code>的方法。通过标签(tag)和反射，将上文示例的<code>newUser()</code>返回的结果转化成下面的一个<code>map</code>。其中包含struct的域的展开，定制化struct的方法。

<pre><code class="hljs go" lang="go">map[string]interface{}{ "name": "user", "no_dive": StructNoDive{NoDive: 1}, // dive struct field "url": "https://github.com/liangyaopei", "star": 1, // customized method "time": "2020-07-21 12:00:00", } </code></pre><h3 class="heading">实现思路 & 源码解析</h3> <h4 class="heading">1.标签识别。</h4>

使用<code>readTag</code>方法读取域(field)的标签，如果没有标签，使用域的名字。然后读取tag中的选项。目前支持3个选项

<ul> <li>'-':忽略当前这个域</li> <li>'omitempty' : 当这个域的值为空，忽略这个域</li> <li>'dive' : 递归地遍历这个结构体，将所有字段作为键</li> </ul>

如果选中了一个选项，就讲这个域对应的二进制位置为1.。

<pre><code class="hljs go" lang="go">const ( OptIgnore = "-" OptOmitempty = "omitempty" OptDive = "dive" ) const ( flagIgnore = 1 << iota flagOmiEmpty flagDive ) func readTag(f reflect.StructField, tag string) (string, int) { val, ok := f.Tag.Lookup(tag) fieldTag := "" flag := 0 // no tag, use field name if !ok { return f.Name, flag } opts := strings.Split(val, ",") fieldTag = opts[0] for i := 1; i < len(opts); i { switch opts[i] { case OptIgnore: flag |= flagIgnore case OptOmitempty: flag |= flagOmiEmpty case OptDive: flag |= flagDive } } return fieldTag, flag } </code></pre><h4 class="heading">2.结构体的域(field)的遍历。</h4>

遍历结构体的每一个域(field)，判断field的类型(kind)。如果是<code>string</code>,<code>int</code>等的基本类型，直接取值，并且把标签中的值作为key。

<pre><code class="hljs go" lang="go">for i := 0; i < t.NumField(); i { ... switch fieldValue.Kind() { case reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int, reflect.Int64: res[tagVal] = fieldValue.Int() case reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint, reflect.Uint64: res[tagVal] = fieldValue.Uint() case reflect.Float32, reflect.Float64: res[tagVal] = fieldValue.Float() case reflect.String: res[tagVal] = fieldValue.String() case reflect.Bool: res[tagVal] = fieldValue.Bool() default: } } } </code></pre><h4 class="heading">3.内嵌结构体的转换</h4>

如果是结构体，先检查有没有实现传入参数的方法，如果实现了，就调用这个方法。如果没有实现，就递归地调用<code>StructToMap</code>方法，然后根据是否展开(<code>dive</code>)，来把返回结果写入res的map。

<pre><code class="hljs go" lang="go">for i := 0; i < t.NumField(); i { fieldType := t.Field(i) // ignore unexported field if fieldType.PkgPath != "" { continue } // read tag tagVal, flag := readTag(fieldType, tag) if flag&flagIgnore != 0 { continue } fieldValue := v.Field(i) if flag&flagOmiEmpty != 0 && fieldValue.IsZero() { continue } // ignore nil pointer in field if fieldValue.Kind() == reflect.Ptr && fieldValue.IsNil() { continue } if fieldValue.Kind() == reflect.Ptr { fieldValue = fieldValue.Elem() } // get kind switch fieldValue.Kind() { case reflect.Struct: _, ok := fieldValue.Type().MethodByName(methodName) if ok { key, value, err := callFunc(fieldValue, methodName) if err != nil { return nil, err } res[key] = value continue } // recursive deepRes, deepErr := StructToMap(fieldValue.Interface(), tag, methodName) if deepErr != nil { return nil, deepErr } if flag&flagDive != 0 { for k, v := range deepRes { res[k] = v } } else { res[tagVal] = deepRes } default: } } ... } // call function func callFunc(fv reflect.Value, methodName string) (string, interface{}, error) { methodRes := fv.MethodByName(methodName).Call([]reflect.Value{}) if len(methodRes) != methodResNum { return "", nil, fmt.Errorf("wrong method %s, should have 2 output: (string,interface{})", methodName) } if methodRes[0].Kind() != reflect.String { return "", nil, fmt.Errorf("wrong method %s, first output should be string", methodName) } key := methodRes[0].String() return key, methodRes[1], nil } </code></pre><h4 class="heading">4.array,slice类型的转换</h4>

如果是<code>array</code>,<code>slice</code>类型，类似地，检查有没有实现传入参数的方法，如果实现了，就调用这个方法。如果没有实现，将这个field的tag作为key，域的值作为value。

<pre><code class="hljs go" lang="go">switch fieldValue.Kind() { case reflect.Slice, reflect.Array: _, ok := fieldValue.Type().MethodByName(methodName) if ok { key, value, err := callFunc(fieldValue, methodName) if err != nil { return nil, err } res[key] = value continue } res[tagVal] = fieldValue .... } </code></pre><h4 class="heading">5.其他类型</h4>

对于其他类型，例如内嵌的<code>map</code>，直接将其返回结果的值。

<pre><code class="hljs go" lang="go">switch fieldValue.Kind() { ... case reflect.Map: res[tagVal] = fieldValue case reflect.Chan: res[tagVal] = fieldValue case reflect.Interface: res[tagVal] = fieldValue.Interface() default: } </code></pre>

<blockquote class="layui-elem-quote" style="width: 100%;overflow:hidden"> 作者： patirck
链接： https://juejin.im/post/6855129007193915400
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。
</blockquote>

到此这篇关于“Golang自定义结构体转map”的文章就介绍到这了,更多文章或继续浏览下面的相关文章，希望大家以后多多支持JQ教程网！

您可能感兴趣的文章：
golang Map进行键值自定义排序
 golang key map 所有_谨慎使用golang中的map
数据结构和算法(Golang实现)(4)简单入门Golang-结构体和方法
 golang key map 所有_golang系列——高级语法之map
golang 自定义Set 及使用
 golang中map的一些注意事项
 go语言结构体定义使用
 golang-类型变量
 golang 并发访问map遇到的问题
 Go之URL Query String 编码器和解码器

上一篇：Go 语言闭包详解下一篇：协程调度时机二：Channel读写

[关闭]

Golang自定义结构体转map

最近更新

浏览排行