Golang XML与JSON互转及路径查询插件库mxj的使用

mxj是一个Go语言库，用于在map[string]interface{}、XML和JSON之间进行编码/解码，并通过键或键路径（包括通配符）从map中提取/修改值。

安装

使用go.mod安装：

go get github.com/clbanning/mxj/v2@v2.7

导入包：

import "github.com/clbanning/mxj/v2"

基本功能

XML与map[string]interface{}互转

type Map map[string]interface{}

// 从XML创建Map值
mv, err := NewMapXml(xmlValue) // 解码
xmlValue, err := mv.Xml()      // 编码

// 从io.Reader读取XML创建Map
mv, err := NewMapXmlReader(xmlReader)         // 重复调用可处理流
mv, raw, err := NewMapXmlReaderRaw(xmlReader) // 'raw'是解码的原始XML

// 将Map写入XML Writer
err := mv.XmlWriter(xmlWriter)
raw, err := mv.XmlWriterRaw(xmlWriter) // 'raw'是写入的原始XML

// 格式化输出
xmlValue, err := mv.XmlIndent(prefix, indent, ...)
err := mv.XmlIndentWriter(xmlWriter, prefix, indent, ...)
raw, err := mv.XmlIndentWriterRaw(xmlWriter, prefix, indent, ...)

批量处理XML

err := HandleXmlReader(xmlReader, mapHandler(Map), errHandler(error))
err := HandleXmlReaderRaw(xmlReader, mapHandler(Map, []byte), errHandler(error, []byte))

结构体与Map互转

mv, err := NewMapStruct(structVal)  // 结构体转Map
err := mv.Struct(structPointer)     // Map转结构体

提取和修改Map值

// 获取键的所有路径
paths := mv.PathsForKey(key)

// 获取键的最短路径
path := mv.PathForKeyShortest(key)

// 获取键的值
values, err := mv.ValuesForKey(key, subkeys)
values, err := mv.ValuesForPath(path, subkeys)

// 更新键的值
count, err := mv.UpdateValuesForPath(newVal, path, subkeys)

// 获取所有叶子节点
leafnodes := mv.LeafNodes()
leafvalues := mv.LeafValues()

// 创建新Map
newMap, err := mv.NewMap("oldKey_1:newKey_1", "oldKey_2:newKey_2", ..., "oldKey_N:newKey_N")
newMap, err := mv.NewMap("oldKey1", "oldKey3", "oldKey5") // 'mv'的子集

完整示例

XML转JSON示例

package main

import (
	"encoding/json"
	"fmt"
	"github.com/clbanning/mxj/v2"
)

func main() {
	xmlData := []byte(`
		<person>
			<name>John Doe</name>
			<age>30</age>
			<address>
				<street>123 Main St</street>
				<city>Anytown</city>
			</address>
		</person>
	`)

	// 将XML转换为Map
	m, err := mxj.NewMapXml(xmlData)
	if err != nil {
		fmt.Println("Error converting XML to map:", err)
		return
	}

	// 将Map转换为JSON
	jsonData, err := json.MarshalIndent(m, "", "  ")
	if err != nil {
		fmt.Println("Error converting map to JSON:", err)
		return
	}

	fmt.Println("JSON output:")
	fmt.Println(string(jsonData))

	// 查询特定路径的值
	values, err := m.ValuesForPath("person.address.street")
	if err != nil {
		fmt.Println("Error getting value for path:", err)
		return
	}

	fmt.Println("\nStreet value:", values[0])
}

JSON转XML示例

package main

import (
	"fmt"
	"github.com/clbanning/mxj/v2"
)

func main() {
	jsonData := []byte(`
		{
			"person": {
				"name": "John Doe",
				"age": 30,
				"address": {
					"street": "123 Main St",
					"city": "Anytown"
				}
			}
		}
	`)

	// 将JSON转换为Map
	m, err := mxj.NewMapJson(jsonData)
	if err != nil {
		fmt.Println("Error converting JSON to map:", err)
		return
	}

	// 将Map转换为XML
	xmlData, err := m.XmlIndent("", "  ")
	if err != nil {
		fmt.Println("Error converting map to XML:", err)
		return
	}

	fmt.Println("XML output:")
	fmt.Println(string(xmlData))
}

XML解析约定

使用NewMapXml():

• 属性通过在属性标签前加连字符"-"解析到map[string]interface{}值
• 如果元素是简单元素且有属性，元素值在map[string]interface{}表示中使用键"#text"
• XML注释、指令和处理指令被忽略
• 如果调用了CoerceKeysToLower()，结果键将变为小写

使用NewMapXmlSeq():

• 属性解析到map["#attr"]map[<attr_label>]map[string]interface{}值
• 除根元素外，所有元素都有"#seq"键
• 注释、指令和处理指令使用"#comment"、"#directive"和"#procinst"键解组到Map中
• 保留命名空间语法

XML编码约定

• ‘nil’ Map值编码为<tag/>
• 不能保证编码的XML文档与解码的相同。如果需要保持元素序列，请使用NewMapXmlSeq()和mv.XmlSeq()