gf
框架针对常用的数据格式编码解析,提供了非常强大灵活的功能,由 gparser
模块提供, 支持Go变量(interface)、Struct、JSON、XML、YAML/YML、TOML数据格式之间的相互转换,支持按照层级进行数据检索访问、支持运行时动态新增/修改/删除层级变量(并发安全)等特 性。 gparser
包使得对于未知数据结构、多维数组结构的访问、操作变得异常的简便。
需要说明的是,
gparser
模块底层基于gjson
模块实现,继承了gjson
包所有的特性。可以将gparser
模块当做gjson
模块的一个别名模块,防止json
这个名称对开发者造成的混淆。具体请参考 gjson (数据动态编解码)。
使用方式:
import "github.com/gogf/gf/encoding/gparser"
接口文档:
https://godoc.org/github.com/gogf/gf/encoding/gparser
简要说明:
Load
与LoadContent
方法支持根据文件及内容,生成gparser.Parser
对象;New
方法支持生成一个空的gparser.Parser
对象,常用用于动态数据生成;New
方法同时也支持按照给定的任意Go变量生成一个gparser.Parser
对象;Get*
相关方法支持按照层级检索数据,pattern
参数中使用英文".
"号区分层级关系;Set
方法支持按照层级新增/修改,给定的 变量类型支持任意类型;Remove
方法支持按照层级删除变量,只需要给定pattern
层级检索参数即可;To*
相关方法支持将gparser.Parser
对象生成为支持的数据格式字符串;VarTo*
相关方法支持将 任意的Go变量 直接转换为支持的数据格式字符串;
数据层级检索
示例1,读取JSON
data :=
`{
"users" : {
"count" : 100,
"list" : [
{"name" : "Ming", "score" : 60},
{"name" : "John", "score" : 99.5}
]
}
}`
if p, e := gparser.LoadContent([]byte(data), true); e != nil {
glog.Error(e)
} else {
fmt.Println("John Score:", p.GetFloat32("users.list.1.score"))
}
可以看到我们可以通过英文 .
号实现非常方便的层级访问,针对于数组列表,索引从 0
开始,我们也可以通过 .
号访问其对应的索引项数据。
示例2,读取XML
data :=
`<?xml version="1.0" encoding="UTF-8"?>
<note>
<to>Tove</to>
<from>Jani</from>
<heading>Reminder</heading>
<body>Don't forget me this weekend!</body>
</note>`
if p, e := gparser.LoadContent([]byte(data), true); e != nil {
glog.Error(e)
} else {
fmt.Println("Heading:", p.GetString("note.heading"))
}
LoadContent
方法的第二个参数指定内容的数据类型,可选值为( json,xml,yaml/yml,toml
)。其他两种数据类型可自行测试,这里不再赘述。
键名本身带有层级符号”.“的情况
当键名和层级在访问时存在pattern同名的情况,当然这并不是什么问题,以下是一个示例。
data :=
`{
"users" : {
"count" : 100
},
"users.count" : 101
}`
if p, e := gparser.LoadContent([]byte(data), true); e != nil {
glog.Error(e)
} else {
p.SetViolenceCheck(true)
fmt.Println("Users Count:", p.Get("users.count"))
}
运行之后打印出的结果为 101
。当键名存在”.“号时,检索优先级:键名->层级,因此并不会引起歧义。
再来看一个例子:
data :=
`{
"users" : {
"count" : {
"type1" : 1,
"type2" : 2
},
"count.type1" : 100
}
}`
if p, e := gparser.LoadContent([]byte(data), true); e != nil {
glog.Error(e)
} else {
p.SetViolenceCheck(true)
fmt.Println("Users Count:", p.Get("users.count.type1"))
fmt.Println("Users Count:", p.Get("users.count.type2"))
}
执行后,输出结果为:
100
2
看到了么, gparser
会按照给定 pattern
对层级进行自动探测,检索时按照键名优先的原则进行匹配,并不会出现歧义冲突。
运行时动态修改数据
data :=
`{
"users" : {
"count" : 100
}
}`
if p, e := gparser.LoadContent([]byte(data), true); e != nil {
glog.Error(e)
} else {
p.Set("users.count", 2)
p.Set("users.list", []string{"John", "小明"})
c, _ := p.ToJson()
fmt.Println(string(c))
}
修改 count
为 2
,并在 users
节点下新增增加 list
节点,节点类型为数组。 执行后输出结果为:
{"users":{"count":2,"list":["John","小明"]}}
gparser
包的数据运行时修改特性非常强大,在该特性的支持下,各种数据结构的编码/解析显得异常的灵活方便。
运行时动态删除变量
我们再来看一个删除变量的例子:
data :=
`<?xml version="1.0" encoding="UTF-8"?>
<article>
<count>10</count>
<list><title>gf article1</title><content>gf content1</content></list>
<list><title>gf article2</title><content>gf content2</content></list>
<list><title>gf article3</title><content>gf content3</content></list>
</article>`
if p, e := gparser.LoadContent([]byte(data), true); e != nil {
glog.Error(e)
} else {
p.Remove("article.list.0")
c, _ := p.ToJson()
fmt.Println(string(c))
}
以上程序输出结果为:
{"article":{"count":"10","list":[{"content":"gf content2","title":"gf article2"},{"content":"gf content3","title":"gf article3"}]}}
可以看到,使用 Remove
方法可以非常方便地根据 pattern
参数动态删除变量。在该示例中,我们删除了 article.list
数组的索引 0
数据项,并将 XML
转换为 JSON
数据格式返回。
动态生成指定格式的编码数据
我们来动态生成一个 XML
,先来一个简单一点的。
p := gparser.New(nil)
p.Set("name", "john")
p.Set("age", 18)
p.Set("scores", map[string]int{
"语文" : 100,
"数学" : 100,
"英语" : 100,
})
c, _ := p.ToXmlIndent("simple-xml")
fmt.Println(string(c))
执行后,输出结果为:
<simple-xml>
<age>18</age>
<name>john</name>
<scores>
<数学>100</数学>
<英语>100</英语>
<语文>100</语文>
</scores>
</simple-xml>
可以看到,我们直接使用 Set
方式便创建了一个 XML
数据格式,根本就不需要 struct
有木有?!想要 struct
?当然也可以,请看下面的示例。