JSON 是一种轻量级数据交换格式。它可以表示数据、字符串、有序的值序列以及名称/值对的集合。
是一个 C++ 库,允许操作 JSON 值,包括字符串之间的序列化和反序列化。它还可以在反序列化/序列化步骤中保留现有注释,使其成为存储用户输入文件的方便格式。
JsonCpp 目前在 github 上托管。
官方网址:https://github.com/open-source-parsers/jsoncpp
在 ubuntu 系统既可以通过命令行安装也可以使用界面进行安装。
- 命令行安装:
- 使用软件包管理器进行安装,启动 Synaptic 软件,搜索 关键字,在过滤出来的条目中点击 libjsoncpp-dev 然后选择 “Mark for Installation”:
扩展阅读:Synaptic 软件的介绍及安装使用教程可参考: Ubuntu 软件包管理利器 - 新立得 (Synaptic)
如果需要在嵌入式系统使用 JsonCpp 可以参考《交叉编译 JsonCpp 库》一文,利用交叉编译器编译出 JsonCpp 头文件及静态/动态库文件。
头文件中包含了 , , 这三个重要的类。
按照国际惯例,每一项技术的学习都可以从 “Hello World” 开始,以下面的 json 字符串为例:
使用 和 读取 content 的值:
在 ubuntu 系统上编译:
运行结果:
在源码第 9~10 行,定义了两个对象 和 :
在源码第 11~12 行,调用 接口尝试解析 json 字符串 ,当 满足 json 格式之后,调用 的 操作符将 “content” 的值取出来,然后再进行类型转换,取出实际的类型数据:
关于类型数据的转换在接下来的章节进行详细说明。
JsonCpp 支持的值类型总共有 8 种:
可以参考 头文件中定义的 。在 类中提供了 用于获取值类型(ValueType), 定义如下:
如果需要进行类型判断, 已经提供了完备的类型判断接口供调用:
其中这里有两个接口比较特殊,一个是 另一个是 。
先对 进行说明,字面意思就是“是否为数字”,实际上在 类的实现中等同于 ,因此这两个函数是等效的,实现代码如下:
在使用过程中可以直接用 代替 ,反之亦然。
的作用主要是对浮点型数据的值进行了严格限制,如果类型为 int 或者 uint,该接口直接返回真值。如果类型为 double,因为 maxUInt64( = 2 64 − 1 =2^{64}-1 =264−1)不能精确表示为 double,因此 double(maxUInt64)将四舍五入为 2 64 2^{64} 264。因此,我们要求该值严格小于限制。
当需要进行类型转换时, 已经提供了常用的类型转换接口供调用:
接口用于判断 json 字符串中是否存在某个键值,函数原型:
判断 “content” 是否为 json 的键:
结合类型判断接口,如果需要确定 json 中是否存在 “content” 键值,并且 “content” 的值为 string 类型,可以加入这样的判断条件:
对象存储了 json 的 列表,原型是一个字符串的矢量数组:
可以通过 接口获取,示例代码如下:
如果需要将 json 的内容全部遍历出来,可以使用递归的方式来达成。
- 从最外层开始进入
- 如果是 Object 类型,利用 接口遍历所有的 值
- 如果在遍历过程中遇到 Object/Array 类型,则递归从步骤 1 开始
- 如果是普通类型,直接打印
示例代码如下,其中 递归执行:
体现在用法上就是直接将 作为参数代入函数接口:
JsonCpp 提供了多种方式来读取数组,可以利用下标进行读取,可以使用 iterator 进行读取,也可以直接使用 C++11 特性进行读取。下面是一个简单例子:
使用下标方式进行读取:
使用 或者 进行读取:
使用 C++11 特性(最简单):
如果数组是 ObjectValue 类型,比如说类似这种:
则数组的读取代码类似于:
JsonCpp 提供 类用于写 json 数据。还是从最简单的例子开始,然后逐步展开。比如利用 JsonCpp 创建如下 json 文件:
使用 创建 json 字符串然后转换成 std::string 类型并输出:
在 ubuntu 系统上编译:
运行结果:
源码第 6 行定义出 对象,作为 json 的根节点(root node):
源码第 7 行定义 Key/Value 键值对,以此类推,在节点下的基本类型均可使用 操作符进行添加,如:
源码第 8 行利用 提供的转换接口可将 json 进行格式化,函数原型为:
如果需要添加嵌套的 json 子节点,可以定义一个 对象来装载内部的 Key/Value 键值对,然后将该对象赋值给 json 的父节点:
如果嵌套的节点内容较简单,不想重新定义一个新的 变量也可以采用另一种写法:
以上两种写法最终产生的 json 内容都是一样的,如下所示:
接口用于添加 json 数组类型,凡事宜从最简单的地方入手,一步一步深入:
生成的 json 内容如下:
如果数组内的数据是 ObjectValue 类型,可以定义一个 对象来装载内部的 Key/Value 键值对,然后将该对象添加到数组中:
生成的 json 内容如下:
根据使用场合不同,需要将 json 内容转换为格式化或非格式化字符串,比如为了可视化的输出一般选择格式化 json 字符串,而在网络传输过程中,会尽量选择使用非格式化的字符串来达到减少传输数据量的目的。
在这一小节的介绍中,更多的是说明标准 C++ 的文件流操作,因为上文已经通过格式化与非格式化将 json 字符串导出成一个标准 C++ 的字符串 std::string,接下来直接将 std::string 写入到文件中即可。示例代码:
源码第 6 行定义输出文件流对象 ofs:
源码第 7~11 行尝试打开文件,如果文件无法打开,使用 查看具体失败原因。
源码 12 行将 json 内容通过流方式写入文件中。
在文件写入完成之后使用 接口关闭文件流。因为写入的过程在实际的系统运行会出现较复杂的情况:磁盘満了又或者磁盘损坏导致无法写入等,所以如果在写入的过程中出现异常,我们就需要使用 来捕获异常。
支持从 流读取数据,可以直接将文件流作为输入参数给到 ,函数原型为:
比如现在有一个文件 :
代码实现:
源码中第 10 行使用 读取 json 文件,如果文件无法打开,使用 查看具体失败原因。
源码第 18 行将 作为参数传入 接口:
从面向对象的设计思想出发,建议将每份 json 的读写设计成一个独立的类,这里面所指的“每份 json”可以是 json 字符串或者是 json 文件,以这样的方式来进行设计之后,业务层只需要关心期望取得的键值即可。
版权声明:
本文来源网络,所有图片文章版权属于原作者,如有侵权,联系删除。
本文网址:https://www.mushiming.com/mjsbk/12394.html