Golang 人性化 JSON 配置解析插件库 hjson 的使用

Hjson 是一种人性化的 JSON 格式，它允许注释、省略引号和逗号，使配置文件更易于阅读和编写。

Hjson 示例

{
  # 指定速率（单位：请求/秒）（因为注释很有帮助！）
  rate: 1000

  // 更喜欢 C 风格注释？
  /* 感觉老派？ */

  # 你注意到 rate 不需要引号了吗？
  hey: look ma, no quotes for strings either!

  # 最棒的是
  notice: []
  anything: ?

  # 是的，逗号是可选的！
}

安装

要在 Go 项目中使用 Hjson，首先添加导入：

import "github.com/hjson/hjson-go/v4"

然后运行 go mod tidy 下载依赖。

如果要安装命令行工具：

go install github.com/hjson/hjson-go/v4/hjson-cli@latest

作为 Go 库使用

基本用法

package main

import (
    "github.com/hjson/hjson-go/v4"
    "fmt"
)

func main() {
    // 解码 Hjson 数据到 Go 值
    sampleText := []byte(`
    {
        # 指定速率（单位：请求/秒）
        rate: 1000
        array:
        [
            foo
            bar
        ]
    }`)

    // 提供变量用于存储解码数据
    var dat map[string]interface{}

    // 使用默认选项解码并检查错误
    if err := hjson.Unmarshal(sampleText, &dat); err != nil {
        panic(err)
    }
    fmt.Println(dat)

    // 使用解码后的值需要类型断言
    rate := dat["rate"].(float64)
    fmt.Println(rate)

    array := dat["array"].([]interface{})
    str1 := array[0].(string)
    fmt.Println(str1)

    // 编码为 Hjson
    sampleMap := map[string]int{"apple": 5, "lettuce": 7}
    hjson, _ := hjson.Marshal(sampleMap)
    fmt.Println(string(hjson))
}

解码到 Go 结构体

package main

import (
    "github.com/hjson/hjson-go/v4"
    "fmt"
)

type Sample struct {
    Rate  int
    Array []string
}

type SampleAlias struct {
    Rett    int      `json:"rate"`
    Ashtray []string `json:"array"`
}

func main() {
    sampleText := []byte(`
    {
        # 指定速率（单位：请求/秒）
        rate: 1000
        array:
        [
            foo
            bar
        ]
    }`)

    // 解码到结构体
    var sample Sample
    hjson.Unmarshal(sampleText, &sample)

    fmt.Println(sample.Rate)
    fmt.Println(sample.Array)

    // 使用 json 标签解码
    var sampleAlias SampleAlias
    hjson.Unmarshal(sampleText, &sampleAlias)

    fmt.Println(sampleAlias.Rett)
    fmt.Println(sampleAlias.Ashtray)
}

结构体字段注释

package main

import (
    "github.com/hjson/hjson-go/v4"
    "fmt"
)

type foo struct {
    A string `json:"x" comment:"第一条注释"`
    B int32  `comment:"第二条注释\n看，换行"`
    C string
    D int32
}

func main() {
    a := foo{A: "hi!", B: 3, C: "some text", D: 5}
    buf, err := hjson.Marshal(a)
    if err != nil {
        fmt.Println(err)
    }

    fmt.Println(string(buf))
}

输出：

{
  # 第一条注释
  x: hi!

  # 第二条注释
  # 看，换行
  B: 3

  C: some text
  D: 5
}

读取和写入注释

package main

import (
    "fmt"
    "github.com/hjson/hjson-go/v4"
)

func main() {
    // 解码 Hjson 数据到 hjson.Node
    sampleText := []byte(`
    {
        # 指定速率（单位：请求/秒）
        rate: 1000
        array:
        [
            foo
            bar
        ]
    }`)

    var node hjson.Node
    if err := hjson.Unmarshal(sampleText, &node); err != nil {
        panic(err)
    }

    node.NK("array").Cm.Before = `        # 请指定一个数组
        `

    if _, _, err := node.NKC("subMap").SetKey("subVal", 1); err != nil {
        panic(err)
    }

    outBytes, err := hjson.Marshal(node)
    if err != nil {
        panic(err)
    }

    fmt.Println(string(outBytes))
}

命令行工具使用

# 将 JSON 转换为 Hjson
hjson-cli test.json > test.hjson

# 将 Hjson 转换为 JSON
hjson-cli -j test.hjson > test.json

命令行选项：

usage: hjson-cli [OPTIONS] [INPUT]
hjson 可用于在 JSON 和 Hjson 之间转换。

如果没有指定输入文件，将从标准输入读取。

选项：
  -bracesSameLine
      将大括号放在同一行
  -c  输出为 JSON
  -h  显示帮助
  -indentBy string
      缩进字符串（默认为 "  "）
  -j  输出为格式化 JSON
  -omitRootBraces
      省略根级别的大括号
  -preserveKeyOrder
      保持对象/映射中的键顺序
  -quoteAlways
      总是引用字符串值
  -v
      显示版本

Hjson 是一个强大的工具，可以使配置文件更易于阅读和维护，同时保持与标准 JSON 的兼容性。