一文搞懂JSON和HJSON

JSON 和 HJSON 都是用于数据序列化的格式，但它们在语法灵活性、可读性以及应用场景上有所不同。

定义与背景

JSON，全称为JavaScript Object Notation，是一种轻量级的数据交换格式。它基于ECMAScript的一个子集，采用完全独立于语言的文本格式来存储和表示数据。易于人阅读和编写，同时也易于机器解析和生成。

HJSON，HJSON是Human JSON的简称，旨在提高JSON的可读性和易用性。它通过引入一些语法糖和更宽松的格式规则，使得数据表示更加直观和人性化。

主要差异

可读性

JSON：语法严格，要求键值对必须使用双引号括起来，且不支持注释。这可能导致在某些情况下，JSON文件变得难以阅读和维护。

HJSON：允许使用单引号括起字符串（尽管双引号仍然有效），支持注释，且对格式要求更加宽松。这些特性使得HJSON文件更加易于阅读和理解。

语法严格性

JSON：语法非常严格，任何不符合规范的字符或结构都会导致解析错误。

HJSON：语法相对宽松，允许一些不符合标准JSON规范的写法，但仍然能够正确解析为标准的JSON对象。

兼容性

JSON：由于其严格的语法和广泛的应用，JSON已成为数据交换的标准格式之一，被大多数编程语言和工具所支持。

HJSON：虽然HJSON提高了可读性，但由于其不是标准JSON的严格子集，因此可能在一些只支持标准JSON的场合下无法使用。不过，HJSON工具通常提供了将HJSON转换为标准JSON的功能，以确保兼容性。

总的来说，JSON 语法严格，不允许包含注释，所有数据都必须是纯粹的键值。而HJSON是 JSON 的一种扩展，目的是提高可读性和编辑友好性。支持多行字符串和其他放宽的语法，更符合人们书写配置文件的习惯。

应用场景

以下是一个简单的JSON和HJSON示例：

JSON示例：

json 复制代码

{
  "name": "Alice",
  "age": 30,
  "skills": ["JavaScript", "Python", "Java"]
}

HJSON示例：

hjson 复制代码

{
  name: 'Alice',  // 可以使用单引号，且支持注释
  age: 30,
  skills: [  // 数组元素可以换行表示，提高可读性
    "JavaScript",
    "Python",
    "Java"
  ]
}

在上面的示例中，HJSON使用了单引号括起字符串，并添加了注释，使得数据表示更加直观和易于理解。同时，HJSON中的数组元素可以换行表示，进一步提高了可读性。然而，这些特性在标准JSON中是不被允许的。从应用场景考虑：

JSON适用场景

1）数据交换：广泛用于 API、前后端通信、配置文件等场景，因为其严格标准保证了跨语言的通用性和可靠的解析。

2）存储和日志：适用于需要严格格式和易于验证的数据存储和日志系统。

3）标准化需求：在系统间数据交换时，JSON 是普遍采用的标准格式，确保一致性和兼容性。

HJSON适用场景

1）配置文件：因为支持注释和更灵活的语法，HJSON 更适合作为人类编写和维护的配置文件格式。开发者可以在配置中添加注释、使用多行字符串等。

2）可读性要求高：适用于需要经常人工编辑、阅读的场景，使配置更直观易懂。

3）开发和调试时：HJSON 的宽松语法可以加快编写配置和调试的效率。

使用过程中的注意事项

对于 JSON

1）语法严格，编写 JSON 时必须严格遵守规范，否则解析器会报错。例如，不要遗漏引号、冒号、逗号等，不能包含注释。

2）工具支持，多数编程语言都内置或有成熟库支持 JSON 解析和生成，使用这些库可以减少手动解析错误的风险。

对于 HJSON

1）依赖专门库，由于 HJSON 不是所有语言原生支持的格式，需要使用专门的 HJSON 解析/生成库。因此在选择 HJSON 时，要确保开发环境有相应的工具支持。

2）兼容性考虑，HJSON 格式比 JSON 更灵活，但如果数据需要与只支持 JSON 的系统交互，可能需要在发送或保存之前将 HJSON 转换成严格的 JSON。

3）性能差异，由于 HJSON 解析器需要处理更多的语法变种，解析速度可能比原生 JSON 略低（一般影响不大，但在高性能场景下需注意）。

Go语言解析HJSON格式文件

Go语言的标准库中没有直接支持HJSON解析的功能，但可以使用一些第三方库来实现HJSON的读取和解析。比如 hjson-go 库。

1）安装 hjson-go 库：

sh 复制代码

go get github.com/hjson/hjson-go

2）编写代码读取和解析 HJSON 文件：

go 复制代码

package main

import (
   "encoding/json"
   "fmt"
   "io/ioutil"
   "log"

   "github.com/hjson/hjson-go"
)

func main() {
   // 读取 HJSON 文件
   data, err := ioutil.ReadFile("config.hjson")
   if err != nil {
       log.Fatalf("Error reading file: %v", err)
   }

   // 解析 HJSON 数据
   var result interface{}
   err = hjson.Unmarshal(data, &result)
   if err != nil {
       log.Fatalf("Error parsing HJSON: %v", err)
   }

   // 如果需要，可以将解析后的数据转换为 JSON 格式以便于查看
   jsonData, err := json.MarshalIndent(result, "", "  ")
   if err != nil {
      log.Fatalf("Error marshaling to JSON: %v", err)
   }

   // 打印解析后的 JSON 数据
   fmt.Println(string(jsonData))
}

3）创建一个 HJSON 文件：

创建一个名为 config.hjson 的文件，并添加一些示例数据：

hjson 复制代码

{
  server: {
    port: 8080
    name: "My Server"
  }
  database: {
    user: "admin"
    password: "secret"
    host: "localhost"
       port: 5432
    }
}

4）运行：

sh 复制代码

 go run main.go

输出：

json 复制代码

{
  "server": {
    "port": 8080,
    "name": "My Server"
  },
  "database": {
    "user": "admin",
    "password": "secret",
    "host": "localhost",
    "port": 5432
  }
}

小总结

JSON和HJSON在数据表示方面都有其独特的优势。JSON以其严格的语法和广泛的应用而著称，成为数据交换的标准格式之一。而HJSON则通过提高可读性和易用性，使得数据表示更加直观和人性化。在选择使用哪种格式时，需要根据具体的应用场景和需求进行权衡。