详解Go语言如何解析带注释的json
一、背景和意义
标准的json格式是不带注释，但是有时候为了方便理解json中各字段的含义，需要支持带注释的json。例如在日常工作中常用的接口文档管理平台yapi在配置接口参数与接口返回、或者创建mock数据时，就支持配置带注释的json。本文给出用go语言解析带注释的json的示例。
二、go语言解析普通json
go语言官方自带的json库可以解析普通的json。例如，我们创建一个main.go文件，代码如下：
package main
import (
"encoding/json"
"fmt"
)
type user struct {
Name string
Age int
Address struct {
City string
Country string
}
}
func main() {
jsonStr := `{
"name": "ZhangSan",
"age": 11,
"address": {
"city": "Shanghai",
"country": "China"
}
}`
user := &user{}
err := json.Unmarshal([]byte(jsonStr), user)
if err != nil {
fmt.Printf("json解析失败：%+v", err)
} else {
fmt.Printf("json解析结果：%+v", user)
}
}
运行go run main.go命令，运行结果为：
json解析结果：&{Name:ZhangSan Age:11 Address:{City:Shanghai Country:China}}
但是假如我们在json中增加以// ... 或者/* ... */格式的注释：
package main
import (
"encoding/json"
"fmt"
)
type user struct {
Name string
Age int
Address struct {
City string
Country string
}
}
func main() {
jsonStr := `{
"name": "ZhangSan", // 姓名
"age": 11, // 年龄
/* 地址信息 开始 */
"address": {
"city": "Shanghai",
"country": "China"
}
/* 地址信息 结束 */
}`
user := &user{}
err := json.Unmarshal([]byte(jsonStr), user)
if err != nil {
fmt.Printf("json解析失败：%+v", err)
} else {
fmt.Printf("json解析结果：%+v", user)
}
}
然后执行命令go run main.go，可看到运行结果为：
json解析失败：invalid character '/' looking for beginning of object key string
三、go语言解析带注释json
使用github.com/titanous/json5库可以解析带注释的json
package main
import (
"fmt"
"github.com/titanous/json5"
)
type user struct {
Name string
Age int
HomePage string
Address struct {
City string
Country string
}
}
func main() {
jsonStr := `{
"name": "ZhangSan", // 姓名
"age": 11, // 年龄
/* 地址信息 开始 */
"address": {
"city": "Shanghai",
"country": "China"
}
/* 地址信息 结束 */
}`
user := &user{}
err := json5.Unmarshal([]byte(jsonStr), user)
if err != nil {
fmt.Printf("json解析失败：%+v", err)
} else {
fmt.Printf("json解析结果：%+v", user)
}
}
运行结果如下：
json解析结果：&{Name:ZhangSan Age:11 HomePage: Address:{City:Shanghai Country:China}}
四、其他特殊情况验证
按理来说，按理来说，// ...和/* ... */如果是出现在字符串中，那么他们不应该为注释处理，我们验证一下github.com/titanous/json5是否能够正确如果这种情况，将main.go文件修改为：
package main
import (
"fmt"
"github.com/titanous/json5"
)
type user struct {
Name string
Age int
HomePage string
Comment string
Address struct {
City string
Country string
}
}
func main() {
jsonStr := `{
"name": "ZhangSan", // 姓名
"age": 11, // 年龄
/* homePage字段的值中有"//"，但它不应该被作为注释处理 */
"homePage": "https://www.testpage.com/index.html",
"comment": "此处测试一下，/* 这里的注释是否能够正确解析 */",
/* 地址信息 开始 */
"address": {
"city": "Shanghai",
"country": "China"
}
/* 地址信息 结束 */
}`
user := &user{}
err := json5.Unmarshal([]byte(jsonStr), user)
if err != nil {
fmt.Printf("json解析失败：%+v", err)
} else {
fmt.Printf("json解析结果：%+v", user)
}
}
运行结果为：
json解析结果：&{Name:ZhangSan Age:11 HomePage:https://www.testpage.com/index.html Comment:此处测试一下，/* 这里的注释是 否能够正确解析 */ Address:{City:Shanghai Country:China}}
可以看到，github.com/titanous/json5对于这种特殊情况的处理也是完全正确的。
到此这篇关于详解Go语言如何解析带注释的json的文章就介绍到这了,更多相关Go解析带注释json内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
这篇文章主要为大家介绍了Go中Context使用源码解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-04-04
这篇文章主要介绍了Go语言中函数的参数传递与调用的基本方法,是golang入门学习中的基础知识,需要的朋友可以参考下2015-10-10
在日常开发中,比较版本号大小的情况是经常遇到的,这篇文章主要为大家详细介绍了如何使用Golang进行比较版本号大小,需要的小伙伴可以参考下2024-01-01
在Go编程中,处理日期和时间是一项常见任务,涉及到精确性和灵活性,本文将介绍一系列实用函数,它们充当time包的包装器,需要的可以参考下2024-01-01
这篇文章主要介绍了使用golang获取linux上文件的访问/创建/修改时间,非常不错，具有一定的参考借鉴价值，需要的朋友可以参考下2018-08-08
这篇文章主要介绍了Golang二进制反汇编问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教2023-11-11
建议使用goproxy.cn作为Go包镜像,因其速度快且缓存丰富,若遇下载问题可更换源,同时注意GitHub删除的包可能在goproxy.io中缓存2025-07-07
在Go语言中,变量的大小溢出后,`uint`类型会回绕到最小值,而`int`类型会回绕到最大值的相反数,例如,`uint8`溢出后会变成0,`int64`溢出后会变成最小的负数2024-12-12
这篇文章主要介绍了golang return省略用法说明，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2020-12-12
这篇文章主要给大家介绍了关于Golang中异常处理机制的相关资料,其实Go语言的异常捕获要比Python中简单的多,它没有Python中那么多复杂的异常类型及继承体系,需要的朋友可以参考下2021-06-06
最新评论