详解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语言实现字符串切片赋值的两种方法，分别是在for循环的range中以及在函数的参数传递中实现，有需要的朋友们可以根据自己的需要选择使用。下面来一起看看吧。2016-10-10
Windows环境下vscode-go安装笔记(不支持32位)
这篇文章主要介绍了Windows环境下vscode-go安装笔记(不支持32位),需要的朋友可以参考下2017-02-02
一次偶然的机会，在 github 上看到有人用 Makefile，就尝试了一下，发现真的非常合适，Makefile 本身就是用来描述依赖的，可读性非常好，而且与强大的 shell 结合在一起，基本可以实现任何想要的功能2023-01-01
在使用 context 的时候遇到了开协程处理任务的情况，但是直接在协程里使用主线程的 context 会导致当主线程返回时协程任务也会因为 context cancel 而失败，本文提供了两种办法可以取消掉 context 里的 timeout 和 deadline，再设置一个新的 timeout 上去2023-03-03
Go语言的接口类型是一组方法定义的集合,它体现了多态性、高内聚和低耦合的设计思想,接口通过interface关键字定义,无需实现具体方法,任何实现了接口所有方法的类型即视为实现了该接口,感兴趣的朋友一起看看吧2024-09-09
这篇文章主要介绍了使用Golang实现加权负载均衡算法的实现代码,详细说明权重转发算法的实现，通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2021-09-09
在当今互联网时代,网站和服务商为了维护安全性和保护用户隐私,常常会对特定的IP地址进行封锁或限制,本文将介绍如何使用Golang实现HTTP代理来突破IP访问限制,需要的朋友可以参考下2023-10-10
作为一个go语言程序员,觉得自己有义务为go新手开一条更简单便捷的上手之路,下面这篇文章主要给大家介绍了关于升级go1.18的goland问题的相关资料,需要的朋友可以参考下2022-11-11
这篇文章主要介绍了解决Golang中goroutine执行速度的问题，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧2021-05-05
在Go语言中,字符串嵌套可以通过多种方式实现,包括使用双引号和转义字符、反引号、字符串拼接和格式化字符串,下面就来介绍一下,感兴趣的可以了解一下2025-03-03
最新评论