详解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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
内存数据库经我们经常用到，例如Redis，那么如何从零实现一个内存数据库呢，本文旨在介绍如何使用Golang编写一个KV内存数据库MossDB2023-03-03
这篇文章主要为大家介绍了Go中Context使用源码解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-04-04
这篇文章主要为大家介绍了从零封装Gin框架实现日志初始化及切割归档功能示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪2024-01-01
这篇文章主要介绍了Go语言操作redis数据库的方法,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下2022-07-07
interface是Go语言的基础特性之一, 可以理解为对一种类型的规范或者约束。他跟java、c++不同, Go语言实现接口不需要显示说明实现了哪个接口, 也没有继承或者子类或者implement关键字。只是通过约定的形式, 隐式的实现接口中的方法即可2021-06-06
这篇文章主要介绍了快速掌握Go语言正/反向代理的相关资料,需要的朋友可以参考下2022-11-11
这篇文章主要介绍了golang操作elasticsearch,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧2020-06-06
这篇文章主要为大家介绍了Go gRPC服务客户端流式RPC教程示例，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2022-06-06
这篇文章主要介绍了Go语言写入字符串到文件的方法,实例分析了Go语言操作字符串及文本的技巧,具有一定参考借鉴价值,需要的朋友可以参考下2015-02-02
这篇文章主要介绍了Golang极简入门教程（二）：方法和接口,本文同时讲解了错误、匿名域等内容,需要的朋友可以参考下2014-10-10
最新评论