QT生成与解析JSON数据

本文完全转载自：【QT】QT生成与解析JSON数据，包含JSON数组_GLL_的博客-CSDN博客_qt解析json数组

本来只想留个连接方便日后查阅，但发文助手不允许，所以把内容复制一遍

简述

Qt5 中包含了处理 JSON 的类，均以 QJson 开头（例如：QJsonDocument、QJsonArray、QJsonObject），在 QtCore 模块中，不需要额外引入其它模块。

常用的 JSON 库

json.org 中介绍了 JSON 在各种语言中的应用，在 C/C++ 中比较常用的JSON 库主要有以下几个：

• JsonCpp 
  JsonCpp 是一个 C++ 用来处理 JSON 数据的开发包。 
  网址：JsonCpp

• cJSON 
  cJSON 是一个超轻巧，携带方便，单文件，简单的可以作为 ANSI-C 标准的 JSON 解析器。 
  网址：cJSON download | SourceForge.net

• QJson 
  QJson 是一个基于 Qt 的开发包用来将 JSON 数据解析成 QVariant 对象，JSON 的数组将被映射为QVariantList 实例，而其他对象映射为 QVariantMap 实例。 
  网址：QJson

关于 Qt 中对 JSON 的生成与解析，Qt5 以前的版本，可以使用 QJson 库，需要单独下载、编译，才能使用。到了 Qt5，提供了专门的 QJsonDocument 及其相关类来读和写 JSON 文档。

JSON 常用类

QJsonDocument

QJsonDocument 类用于读和写 JSON 文档。

一个 JSON 文档可以使用 QJsonDocument::fromJson() 从基于文本的表示转化为 QJsonDocument， toJson() 则可以反向转化为文本。解析器非常快且高效，并将 JSON 转换为 Qt 使用的二进制表示。

已解析文档的有效性，可以使用 !isNull() 进行查询。

如果要查询一个 JSON 文档是否包含一个数组或一个对象，使用 isArray() 和 isObject()。包含在文档中的数组或对象可以使用 array() 或 object() 检索，然后读取或操作。

也可以使用 fromBinaryData() 或 fromRawData() 从存储的二进制表示创建来 JSON 文档。

QJsonArray

QJsonArray 类封装了一个 JSON 数组。

JSON 数组是值的列表。列表可以被操作，通过从数组中插入和删除 QJsonValue 。

一个 QJsonArray 可以和一个 QVariantList 相互转换。可以使用 size() 来查询条目的数量，通过 insert() 在指定索引处插入值，removeAt() 来删除指定索引的值。

QJsonObject

QJsonObject 类封装了一个 JSON 对象。

一个 JSON 对象是一个“key/value 对”列表，key 是独一无二的字符串，value 由一个 QJsonValue 表示。

一个 QJsonObject 可以和一个 QVariantMap 相互转换。可以使用 size() 来查询“key/value 对”的数量，通过 insert() 插入“key/value 对”， remove() 删除指定的 key。

QJsonValue

QJsonValue 类封装了一个值。

JSON 中的值有 6 种基本数据类型：

• bool（QJsonValue::Bool）
• double（QJsonValue::Double）
• string（QJsonValue::String）
• array（QJsonValue::Array）
• object（QJsonValue::Object）
• null（QJsonValue::Null）

一个值可以由任何上述数据类型表示。此外，QJsonValue 有一个特殊的标记来表示未定义的值，可以使用 isUndefined() 查询。

值的类型可以通过 type() 或 isBool()、isString() 等访问函数查询。同样地，值可以通过 toBool()、toString() 等函数转化成相应的存储类型。

QJsonParseError

QJsonParseError 类用于在 JSON 解析中报告错误。

枚举 QJsonParseError::ParseError：

该枚举描述 JSON 文档在解析过程中所发生的错误类型。

常量	值	描述
QJsonParseError::NoError	0	未发生错误
QJsonParseError::UnterminatedObject	1	对象不正确地终止以右花括号结束
QJsonParseError::MissingNameSeparator	2	分隔不同项的逗号丢失
QJsonParseError::UnterminatedArray	3	数组不正确地终止以右中括号结束
QJsonParseError::MissingValueSeparator	4	对象中分割 key/value 的冒号丢失
QJsonParseError::IllegalValue	5	值是非法的
QJsonParseError::TerminationByNumber	6	在解析数字时，输入流结束
QJsonParseError::IllegalNumber	7	数字格式不正确
QJsonParseError::IllegalEscapeSequence	8	在输入时，发生一个非法转义序列
QJsonParseError::IllegalUTF8String	9	在输入时，发生一个非法 UTF8 序列
QJsonParseError::UnterminatedString	10	字符串不是以引号结束
QJsonParseError::MissingObject	11	一个对象是预期的，但是不能被发现
QJsonParseError::DeepNesting	12	对解析器来说，JSON 文档嵌套太深
QJsonParseError::DocumentTooLarge	13	对解析器来说，JSON 文档太大
QJsonParseError::GarbageAtEnd	14	解析的文档在末尾处包含额外的乱码

简单的 JSON 对象

构造一个简单的 JSON 对象：

1. {

2. "Cross Platform": true,

3. "From": 1991,

4. "Name": "Qt"

5. }

生成比较简单，由于是一个对象，只需要用 QJsonObject 即可。

1. // 构建 JSON 对象

2. QJsonObject json;

3. json.insert("Name", "Qt");

4. json.insert("From", 1991);

5. json.insert("Cross Platform", true);

7. // 构建 JSON 文档

8. QJsonDocument document;

9. document.setObject(json);

10. QByteArray byteArray = document.toJson(QJsonDocument::Compact);

11. QString strJson(byteArray);

13. qDebug() << strJson;

解析如下：

1. QJsonParseError jsonError;

2. QJsonDocument doucment = QJsonDocument::fromJson(byteArray, &jsonError); // 转化为 JSON 文档

3. if (!doucment.isNull() && (jsonError.error == QJsonParseError::NoError)) { // 解析未发生错误

4. if (doucment.isObject()) { // JSON 文档为对象

5. QJsonObject object = doucment.object(); // 转化为对象

6. if (object.contains("Name")) { // 包含指定的 key

7. QJsonValue value = object.value("Name"); // 获取指定 key 对应的 value

8. if (value.isString()) { // 判断 value 是否为字符串

9. QString strName = value.toString(); // 将 value 转化为字符串

10. qDebug() << "Name : " << strName;

11. }

12. }

13. if (object.contains("From")) {

14. QJsonValue value = object.value("From");

15. if (value.isDouble()) {

16. int nFrom = value.toVariant().toInt();

17. qDebug() << "From : " << nFrom;

18. }

19. }

20. if (object.contains("Cross Platform")) {

21. QJsonValue value = object.value("Cross Platform");

22. if (value.isBool()) {

23. bool bCrossPlatform = value.toBool();

24. qDebug() << "CrossPlatform : " << bCrossPlatform;

25. }

26. }

27. }

28. }

注意：在转化为 QJsonDocument 后，首先需要根据 QJsonParseError 的值判定是否转化成功，然后在进行相应的转化解析。

简单的 JSON 数组

构造一个简单的 JSON 对象：

1. [

2. "Qt",

3. 5.7,

4. true

5. ]

生成比较简单，由于是一个数组，只需要用 QJsonArray 即可。

1. // 构建 JSON 数组

2. QJsonArray json;

3. json.append("Qt");

4. json.append(5.7);

5. json.append(true);

7. // 构建 JSON 文档

8. QJsonDocument document;

9. document.setArray(json);

10. QByteArray byteArray = document.toJson(QJsonDocument::Compact);

11. QString strJson(byteArray);

13. qDebug() << strJson;

需要注意的是，和上面不同的是，这里使用的是 QJsonDocument 的 setArray() 函数，因为是数组嘛！

解析如下：

1. QJsonParseError jsonError;

2. QJsonDocument doucment = QJsonDocument::fromJson(byteArray, &jsonError); // 转化为 JSON 文档

3. if (!doucment.isNull() && (jsonError.error == QJsonParseError::NoError)) { // 解析未发生错误

4. if (doucment.isArray()) { // JSON 文档为数组

5. QJsonArray array = doucment.array(); // 转化为数组

6. int nSize = array.size(); // 获取数组大小

7. for (int i = 0; i < nSize; ++i) { // 遍历数组

8. QJsonValue value = array.at(i);

9. if (value.type() == QJsonValue::String) {

10. QString strName = value.toString();

11. qDebug() << strName;

12. }

13. if (value.type() == QJsonValue::Double) {

14. double dVersion = value.toDouble();

15. qDebug() << dVersion;

16. }

17. if (value.type() == QJsonValue::Bool) {

18. bool bCrossPlatform = value.toBool();

19. qDebug() << bCrossPlatform;

20. }

21. }

22. }

23. }

和 JSON 对象类似，在遍历数组时，获取每个 value，首先需要判断 value 的类型（和 is***() 函数类似，这里根据 type() 函数返回的枚举值来判断），然后再进行相应的转换。

复杂的 JSON

构造一个复杂的 JSON 对象：

1. {

2. "Company": "Digia",

3. "From": 1991,

4. "Name": "Qt",

5. "Page": {

6. "Developers": "https://www.qt.io/developers/",

7. "Download": "https://www.qt.io/download/",

8. "Home": "https://www.qt.io/"

9. },

10. "Version": [

11. 4.8,

12. 5.2,

13. 5.7

14. ]

15. }

包含了一个拥有五个“key/value 对”的对象，values 中的两个（Company、Name）是字符串，一个（From）是数字，一个（Page）是对象，一个（Version）是数组。

要生成这样一个复杂的 JSON 文档，需要分别构造对象和数组，然后将它们拼接起来：

1. // 构建 Json 数组 - Version

2. QJsonArray versionArray;

3. versionArray.append(4.8);

4. versionArray.append(5.2);

5. versionArray.append(5.7);

7. // 构建 Json 对象 - Page

8. QJsonObject pageObject;

9. pageObject.insert("Home", "https://www.qt.io/");

10. pageObject.insert("Download", "https://www.qt.io/download/");

11. pageObject.insert("Developers", "https://www.qt.io/developers/");

13. // 构建 Json 对象

14. QJsonObject json;

15. json.insert("Name", "Qt");

16. json.insert("Company", "Digia");

17. json.insert("From", 1991);

18. json.insert("Version", QJsonValue(versionArray));

19. json.insert("Page", QJsonValue(pageObject));

21. // 构建 Json 文档

22. QJsonDocument document;

23. document.setObject(json);

24. QByteArray byteArray = document.toJson(QJsonDocument::Compact);

25. QString strJson(byteArray);

27. qDebug() << strJson;

解析部分其实并没有看起来这么复杂，只要一步步搞明白对应的类型，然后进行相应转化即可。

1. QJsonParseError jsonError;

2. QJsonDocument doucment = QJsonDocument::fromJson(byteArray, &jsonError); // 转化为 JSON 文档

3. if (!doucment.isNull() && (jsonError.error == QJsonParseError::NoError)) { // 解析未发生错误

4. if (doucment.isObject()) { // JSON 文档为对象

5. QJsonObject object = doucment.object(); // 转化为对象

6. if (object.contains("Name")) {

7. QJsonValue value = object.value("Name");

8. if (value.isString()) {

9. QString strName = value.toString();

10. qDebug() << "Name : " << strName;

11. }

12. }

13. if (object.contains("Company")) {

14. QJsonValue value = object.value("Company");

15. if (value.isString()) {

16. QString strCompany = value.toString();

17. qDebug() << "Company : " << strCompany;

18. }

19. }

20. if (object.contains("From")) {

21. QJsonValue value = object.value("From");

22. if (value.isDouble()) {

23. int nFrom = value.toVariant().toInt();

24. qDebug() << "From : " << nFrom;

25. }

26. }

27. if (object.contains("Version")) {

28. QJsonValue value = object.value("Version");

29. if (value.isArray()) { // Version 的 value 是数组

30. QJsonArray array = value.toArray();

31. int nSize = array.size();

32. for (int i = 0; i < nSize; ++i) {

33. QJsonValue value = array.at(i);

34. if (value.isDouble()) {

35. double dVersion = value.toDouble();

36. qDebug() << "Version : " << dVersion;

37. }

38. }

39. }

40. }

41. if (object.contains("Page")) {

42. QJsonValue value = object.value("Page");

43. if (value.isObject()) { // Page 的 value 是对象

44. QJsonObject obj = value.toObject();

45. if (obj.contains("Home")) {

46. QJsonValue value = obj.value("Home");

47. if (value.isString()) {

48. QString strHome = value.toString();

49. qDebug() << "Home : " << strHome;

50. }

51. }

52. if (obj.contains("Download")) {

53. QJsonValue value = obj.value("Download");

54. if (value.isString()) {

55. QString strDownload = value.toString();

56. qDebug() << "Download : " << strDownload;

57. }

58. }

59. if (obj.contains("Developers")) {

60. QJsonValue value = obj.value("Developers");

61. if (value.isString()) {

62. QString strDevelopers = value.toString();

63. qDebug() << "Developers : " << strDevelopers;

64. }

65. }

66. }

67. }

68. }

69. }

基本的用法就这些，比较简单，细节很关键，建议在处理的过程中启用严格模式，例如：先通过 QJsonParseError::NoError 判断转化 JSON 文档无误，再进行解析。在解析过程中，先判断 QJsonValue 是否为对应的类型如 isObject()，再通过 toObject() 转化。

更多参考

• JavaScript Programming Language
• Standard ECMA-262 3rd Edition - December 1999
• json.org
• RFC-4627
• Qt之JSON
• Qt之JSON保存与读取