背景

从理论上讲，JSON 很容易让人阅读和编写。在实践中，JSON 给了我们很多犯错误的机会，甚至没有意识到。

Hjson 是 JSON 的语法扩展。这并不是替换 JSON 或将其合并到 JSON 规范本身的提议。

它的目的是像方便程序员理解和使用，在将 JSON 数据传递到机器之前易于读取和编辑。

JSON的历史

JSON（JavaScript Object Notation）是一种轻量级的数据交换格式。易于人阅读和编写，可以在多种语言之间进行数据交换。同时也易于机器解析和生成。

它基于JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999的一个子集。

JSON 源于对实时服务器到浏览器会话通信协议的需求，无需使用 Flash 或 Java 小程序等浏览器插件，这是 2000 年代初期使用的主要方法。

JSON是Douglas Crockford在2001年开始推广使用的数据格式。

2005 年 12 月，Yahoo!开始以 JSON 形式提供一些 Web 服务。

Hjson 有什么用？

逗号（COMMAS）

再也不会因为缺少逗号而出现语法错误，只要把每个键值对写在新的一行中即可。

{
  first: 1
  second: 2
}

注释（COMMENTS）

Hjson支持使用单行注释：# 和 //, 和多行注释 /**/。

{
  # 单行注释

  // 行注释

  /* 块样式注释
     ...... */

  # Everything you do in comments,
  # stays in comments ;-}
}

键值（key）

对象的key可以不使用双引号来指定，这使得它们更容易阅读。

{
  # 指定请求数/秒的速率
  rate: 1000
}

无引号字符串（QUOTELESS STRINGS）

对象的value如果是单行的字符串，也可以不添加引号

{
  JSON: "a string"

  Hjson: a string

  # 注意，无需转义：
  RegEx: \s+
}

多行（MULTILINE）

可以书写多行字符串，方便阅读，使用三引号来表示：

{
  md:
    '''
    第一行.
    第二行.
      该行缩进两个空格.
    '''
}

标点符号，空格和退格符（PUNCTUATORS, SPACES AND ESCAPES）

JSON 和 Hjson 使用字符{}[],:作为标点符号来定义数据的结构。

标点符号和空格不能用在无引号的键中，也不能用作无引号字符串的第一个字符。在这种情况下,我们就需要使用引号来表示含有标点符号的字符串。

反斜杠仅用作带引号的字符串中的转义字符。

{
  "key name": "{ sample }"
  "{}": " spaces at the start/end "
  this: is OK though: {}[],:
}

Hjson：一个C#实现

Hjson的C#实现是基于System.Json，支持的框架/运行时包括.NET Core、.NET 4.x 和 Mono。

百度网盘：https://pan.baidu.com/s/1NF0_wdFmiHeUn77FMRS0yA?pwd=86qj

Hjson的用法

你可以：

• 直接使用上面的库
• 或只是将 Hjson 转换为 JSON 并将其与您最喜欢的 JSON 库一起使用。

转化

// 将 Hjson 转换为 JSON
var jsonString = HjsonValue.Load(filePath).ToString();

// 将 JSON 转换为 Hjson
var hjsonString = JsonValue.Load("test.json").ToString(Stringify.Hjson);

读取

var jsonObject = HjsonValue.Load(filePath).Qo();

HjsonValue.Load() 将接受 Hjson 和 JSON。您可以使用 JsonValue.Load() 仅接受 JSON 输入。

Object示例

var jsonObject = HjsonValue.Parse("{\"name\":\"hugo\",\"age\":5}").Qo();
string name = jsonObject.Qs("name");
int age = jsonObject.Qi("age");
// 您可能更喜欢获取任何字符串值
string age2 = jsonObject.Qstr("age");

// 或遍历对象成员
foreach (var item in jsonObject)
{
  Console.WriteLine("{0}: {1}", item.Key, item.Value);
}

数组示例

var jsonArray = HjsonValue.Parse("[\"hugo\",5]").Qa();
string first = jsonArray[0];

// 或遍历数组
foreach (var item in jsonArray)
  Console.WriteLine(item.ToValue());

嵌套示例

var nested = HjsonValue.Parse("{\"partner\":{\"name\":\"John\",\"age\":23}}").Qo();
string name = nested.Qo("partner").Qs("name", "default");
int age = nested.Qo("partner").Qi("age", 77);
string gender = nested.Qo("partner").Qs("gender", "unknown");

新建Json对象

var jsonObject = new JsonObject
{
  { "name", "John" },
  { "age", 23 },
};
// -> { "name": "John", "age", 23 }

JsonArray jsonArray = new JsonArray()
{
  "John",
  23,
};
// -> [ "John", 23 ]

修改

jsonObject["name"] = "Hugo";
jsonObject.Remove("age");

持续化写入文件

HjsonValue.Save(jsonObject, "file.hjson"); // 作为 Hjson
HjsonValue.Save(jsonObject, "file.json"); // 作为 JSON

ToString()

jsonObject.ToString(Stringify.Hjson); // Hjson输出
jsonObject.ToString(Stringify.Formatted); // 格式化 JSON 输出
jsonObject.ToString(Stringify.Plain); // JSON 输出
jsonObject.ToString(); // Plain 默认

整体效果