详解Go语言如何解析带注释的json

更新时间：2024年03月25日 08:24:28 作者：qinyuan15

标准的json格式是不带注释，但是有时候为了方便理解json中各字段的含义，需要支持带注释的json，这篇文章主要介绍了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内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Goland 断点调试Debug的操作
这篇文章主要介绍了Goland 断点调试Debug的操作方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-04-04
Go语言中init函数特点、用途和注意事项详解
go语言中有一个非常神奇的函数init,它可以在所有程序执行开始前被执行,并且每个package下面可以存在多个init函数,这篇文章主要给大家介绍了关于Go语言中init函数特点、用途和注意事项的相关资料,需要的朋友可以参考下
2023-07-07
go基础语法50问及方法详解
这篇文章主要为大家介绍了go基础语法50问及方法详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-01-01
go语言的四数相加等于指定数算法
这篇文章主要介绍了go语言的四数相加等于指定数算法的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-04-04
详解minio分布式文件存储
MinIO 是一款基于 Go 语言的高性能、可扩展、云原生支持、操作简单、开源的分布式对象存储产品,这篇文章主要介绍了minio分布式文件存储,需要的朋友可以参考下
2023-10-10
Go语言标准库之strconv的使用
本文主要介绍了Go语言标准库之strconv的使用，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2023-03-03
Go使用select切换协程入门详解
这篇文章主要为大家介绍了Go使用select切换协程入门详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-08-08
golang中命令行库cobra的使用方法示例
这篇文章主要给大家介绍了关于golang中命令行库cobra的使用方法，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2018-08-08
Golang接口型函数使用小结
接口函数指的是用函数实现接口，这样在调用的时候就会非常简便，这种方式适用于只有一个函数的接口，这里以迭代一个map为例，演示这一实现的技巧，对Golang接口型函数使用知识感兴趣的朋友一起看看吧
2022-06-06
Go语言TCP从原理到代码实现详解
这篇文章主要为大家介绍了Go语言TCP从原理到代码实现详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2022-08-08