目录

    • 一：介绍
    • 二：安装
    • 三：使用
      • 3.1: 简单使用案例
      • 3.2: 字段标签
      • 3.3: 结构体嵌套
      • 3.4: 统一存储未映射的值
      • 3.5: 逆向转换
      • 3.6: 收集绑定信息

一：介绍

  • 简言之： mapstructure是GO字典(map[string]interface{})和Go结构体之间转换的编解码工具。
  • 核心方法：mapstructure.Decode(input interface{}, output interface{})

二：安装

  • go get github/mitchellh/mapstructure
  • 源码地址：https://github/mitchellh/mapstructure
  • 官方文档地址：https://pkg.go.dev/github/mitchellh/mapstructure

三：使用

3.1: 简单使用案例

  • 案例：将一个JSON字符串解析为字典对象， 然后把字典绑定到一个结构体对象中。
    package main

import (
	"encoding/json"
	"fmt"
	"github/mitchellh/mapstructure"
	"log"
)

type Person struct {
	Name string
	Age  int
	Job  string
}

func main() {
	// 定义一个JSON字符串
	dataJson :=
		`{
		  "name":"renshanwen",
		  "age":18,
		  "job": "engineer"
		}`
	// 将JOSN字符串解析成字典
	var m map[string]interface{}
	err := json.Unmarshal([]byte(dataJson), &m)
	if err != nil {
		log.Fatal(err)
	}
	// 将结构体m，绑定到结构体对象p中
	var p Person
	mapstructure.Decode(m, &p)
	fmt.Printf("name is %s, age is %d, job is %s.", p.Name, p.Age, p.Job)
}
  • 输出结果：
    name is renshanwen, age is 18, job is engineer.

3.2: 字段标签

  • 字段标签作用：定义Go字典和GO结构体字段映射关系。
  • 默认：mapstructure使用结构体中字段的名称(大小写不敏感)做这个映射，
  • 案例：例如我们的结构体有一个Name字段，mapstructure解码时会在map[string]interface{}中查找键名name。
  • 指定关系映射：
    package main

import (
	"encoding/json"
	"fmt"
	"github/mitchellh/mapstructure"
	"log"
)

type Person struct {
	Name string `mapstructure:"user_name"`
	Age  int    `mapstructure:"user_age"`
	Job  string `mapstructure:"user_job"`
}

func main() {
	// 定义一个JSON字符串
	dataJson :=
		`{
		  "user_name":"renshanwen",
		  "user_age":18,
		  "user_job": "engineer"
		}`
	// 将JOSN字符串解析成结构体
	var m map[string]interface{}
	err := json.Unmarshal([]byte(dataJson), &m)
	if err != nil {
		log.Fatal(err)
	}
	// 将结构体m，绑定到结构体对象p中
	var p Person
	mapstructure.Decode(m, &p)
	fmt.Printf("name is %s, age is %d, job is %s.", p.Name, p.Age, p.Job)
}

3.3: 结构体嵌套

  • 如果入参JSON结构比较复杂， 可以定义多重结构体， mapstructure会自动帮助我们解析。
    package main

import (
	"encoding/json"
	"fmt"
	"github/mitchellh/mapstructure"
	"log"
)

type Person struct {
	Name string `mapstructure:"user_name"`
	Age  int    `mapstructure:"user_age"`
	Job  string `mapstructure:"user_job"`
}

// Worker 结构体嵌套
type Worker struct {
	Person Person
	Work   string `mapstructure:"user_work"`
}

func main() {
	// 定义一个JSON字符串
	dataJson := `{
					"person":{
						"user_name":"renshanwen",
						"user_age":18,
						"user_job":"engineer"
					},
					"user_work":"code"
				}`
	// 将JOSN字符串解析成结构体
	var m map[string]interface{}
	err := json.Unmarshal([]byte(dataJson), &m)
	if err != nil {
		log.Fatal(err)
	}
	// 将结构体m，绑定到结构体对象w中
	var w Worker
	mapstructure.Decode(m, &w)
	fmt.Printf("name is %s, age is %d, job is %s ,work is %s.", w.Person.Name, w.Person.Age, w.Person.Job, w.Work)
}

3.4: 统一存储未映射的值

  • 可以定义一个字段，接收全部没有映射的字段。
  • 案例：
    package main

import (
	"encoding/json"
	"fmt"
	"github/mitchellh/mapstructure"
	"log"
)

type Person struct {
	Name string `mapstructure:"user_name"`
	Age  int    `mapstructure:"user_age"`
	Job  string `mapstructure:"user_job"`
}

// Worker 结构体嵌套
type Worker struct {
	Person Person
	Work   string                 `mapstructure:"user_work"`
	Other  map[string]interface{} `mapstructure:",remain"` // 未解析字段默认分配到这里
}

func main() {
	// 定义一个JSON字符串
	dataJson := `{
					"person":{
						"user_name":"renshanwen",
						"user_age":18,
						"user_job":"engineer"
					},
					"user_work":"code",
					"user_mather": "mather",
					"user_baby": "baby"
				}`
	// 将JOSN字符串解析成结构体
	var m map[string]interface{}
	err := json.Unmarshal([]byte(dataJson), &m)
	if err != nil {
		log.Fatal(err)
	}
	// 将结构体m，绑定到结构体对象w中
	var w Worker
	mapstructure.Decode(m, &w)
	fmt.Printf("name is %s, age is %d, job is %s ,work is %s other is %s.", w.Person.Name, w.Person.Age, w.Person.Job, w.Work, w.Other)
}
  • 结果：
    name is renshanwen, age is 18, job is engineer ,work is code other is map[user_baby:baby user_mather:mather].

3.5: 逆向转换

  • 结构体—>字典
  • 在反向解码时，我们可以为某些字段设置mapstructure:“,omitempty”。这样当这些字段为默认值时，就不会出现在结构的map[string]interface{}。
    package main

import (
	"encoding/json"
	"fmt"
	"github/mitchellh/mapstructure"
)

type Person struct {
	Name string `mapstructure:"user_name"`
	Age  int    `mapstructure:"user_age"`
	Job  string `mapstructure:"user_job,omitempty"` // ,omitempty表示如果结构体对象没有，则不会解析到字典中。
}

// Worker 结构体嵌套
type Worker struct {
	Person Person
	Work   string                 `mapstructure:"user_work"`
	Other  map[string]interface{} `mapstructure:",remain"` // 未解析字段默认分配到这里
}

func main() {
	// 定义一个JSON字符串
	worker := &Worker{
		Work: "code",
	}
	worker.Person.Name = "renshanwen"
	worker.Person.Age = 18

	var m map[string]interface{}
	mapstructure.Decode(worker, &m)

	data, _ := json.Marshal(m)
	fmt.Println(string(data))
	// {"Other":null,"Person":{"user_age":18,"user_name":"renshanwen"},"user_work":"code"}
}

3.6: 收集绑定信息

  • 可以使用mapstructure.Metadata, 存储绑定信息情况。
  • Keys： 绑定成功的
  • Unused：没有绑定上的
  • Unset：缺失的
    package main

import (
	"fmt"
	"github/mitchellh/mapstructure"
)

type Person struct {
	Name string `mapstructure:"user_name"`
	Age  int    `mapstructure:"user_age"`
	Job  string `mapstructure:"user_job,omitempty"` // ,omitempty表示如果结构体对象没有，则不会解析到字典中。
}

func main() {
	m := map[string]interface{}{
		"user_name": "renshanwen",
		"age":       18,
		"job":       "engineer",
	}
	var p Person
	var metadata mapstructure.Metadata
	mapstructure.DecodeMetadata(m, &p, &metadata)
	fmt.Printf("keys:%#v unused:%#v Unset:%#v \n", metadata.Keys, metadata.Unused, metadata.Unset)
	// 	keys:[]string{"user_name"} unused:[]string{"age", "job"} Unset:[]string{"user_age", "user_job"} 
}