首页 Qt 学习之路 2 Qt 学习之路 2(63):使用 QJson 处理 JSON

Qt 学习之路 2(63):使用 QJson 处理 JSON

22 2

XML 曾经是各种应用的配置和传输的首选方式。但是现在 XML 遇到了一个强劲的对手:JSON。我们可以在这里看到有关 JSON 的语法。总体来说,JSON 的数据比 XML 更紧凑,在传输效率上也要优于 XML。不过 JSON 数据的层次化表达不及 XML,至少不如 XML 那样突出。不过这并不会阻止 JSON 的广泛应用。

一个典型的 JSON 文档可以像下面的例子:

{
  "encoding" : "UTF-8",
  "plug-ins" : [
      "python",
      "c++",
      "ruby"
      ],
  "indent" : { "length" : 3, "use_space" : true }
}

JSON 的全称是 JavaScript Object Notation,与 JavaScript 密不可分。熟悉 JavaScript 的童鞋马上就会发现,JSON 的语法就是 JavaScript 对象声明的语法。JSON 文档其实就是一个 JavaScript 对象,因而也称为 JSON 对象,以大括号作为起止符,其实质是不排序的键值对,其中键要求是 string 类型,值可以是任意类型。比如上面的示例,键 encoding 的值是字符串 UTF-8;键 plug-ins 的值是一个数组类型,在 JSON 中,数组以中括号表示,这个数组是一个字符串列表,分别有 python、c++ 和 ruby 三个对象;键 indent 的值是一个对象,这个对象有两个属性,length = 3,use_space = true。

对于 JSON 的解析,我们可以使用 QJson 这个第三方库。QJson 可以将 JSON 数据转换为 QVariant 对象,将 JSON 数组转换成 QVariantList 对象,将 JSON 对象转换成 QVariantMap 对象。我们在这里使用 git clone 出 QJson 的整个代码。注意 QJson 没有提供链接库的 pro 文件,因此我们只需要将所有源代码文件添加到我们的项目即可(如同这些文件是我们自己写的一样)。接下来就可以使用 QJson 读取 JSON 内容:

#include "parser.h"
//////////
QJson::Parser parser;
bool ok;

QString json("{"
        "\"encoding\" : \"UTF-8\","
        "\"plug-ins\" : ["
        "\"python\","
        "\"c++\","
        "\"ruby\""
        "],"
        "\"indent\" : { \"length\" : 3, \"use_space\" : true }"
        "}");
QVariantMap result = parser.parse(json.toUtf8(), &ok).toMap();
if (!ok) {
    qFatal("An error occurred during parsing");
    exit (1);
}

qDebug() << "encoding:" << result["encoding"].toString();
qDebug() << "plugins:";

foreach (QVariant plugin, result["plug-ins"].toList()) {
    qDebug() << "\t-" << plugin.toString();
}

QVariantMap nestedMap = result["indent"].toMap();
qDebug() << "length:" << nestedMap["length"].toInt();
qDebug() << "use_space:" << nestedMap["use_space"].toBool();

将 JSON 对象转换成QVariant对象很简单,基本只需要下面几行:

// 1. 创建 QJson::Parser 对象
QJson::Parser parser;

bool ok;
// 2. 将 JSON 对象保存在一个对象 json 中,进行数据转换
QVariant result = parser.parse (json, &ok);

QJson::Parser::parse()函数接受两个参数,第一个参数是 JSON 对象,可以是QIODevice *或者是QByteArray;第二个参数是转换成功与否,如果成功则被设置为 true。函数返回转换后的QVariant对象。注意我们转换后的对象其实是一个QVariantMap类型,可以像QMap一样使用重载的 [] 获取键所对应的值。另外,由于 result["plug-ins"] 是一个QVariantList对象(因为是由 JSON 数组返回的),因而可以调用其toList()函数,通过遍历输出每一个值。

如果需要将QVariant生成 JSON 对象,我们则使用QJson::Serializer对象。例如:

QVariantList people;

QVariantMap bob;
bob.insert("Name", "Bob");
bob.insert("Phonenumber", 123);

QVariantMap alice;
alice.insert("Name", "Alice");
alice.insert("Phonenumber", 321);

people << bob << alice;

QJson::Serializer serializer;
bool ok;
QByteArray json = serializer.serialize(people, &ok);

if (ok) {
    qDebug() << json;
} else {
    qCritical() << "Something went wrong:" << serializer.errorMessage();
}

QJson::Serializer和前面的QJson::Parser的用法相似,只需要调用QJson::Serializer::serialize()即可将QVariant类型的数据转换为 JSON 格式。其返回值是QByteArray类型,可以用于很多其它场合。

上面是 QJson 的主要使用方法。其实 QJson 还提供了另外一个类QObjectHelper,用于QVariantQObject之间的转换。注意我们上面所说的 QJson 的转换需要的是QVariant类型的数据,无论是转换到 JSON 还是从 JSON 转换而来。但是通常我们在应用程序中使用的是QObject及其子类。QObjectHelper提供了一个工具函数,完成QVariantQObject之间的转换。例如我们有下面的类:

class Person : public QObject
{
  Q_OBJECT

  Q_PROPERTY(QString name READ name WRITE setName)
  Q_PROPERTY(int phoneNumber READ phoneNumber WRITE setPhoneNumber)
  Q_PROPERTY(Gender gender READ gender WRITE setGender)
  Q_PROPERTY(QDate brithday READ brithday WRITE setBrithday)
  Q_ENUMS(Gender)

  public:
    Person(QObject* parent = 0);
    ~Person();

    QString name() const;
    void setName(const QString& name);

    int phoneNumber() const;
    void setPhoneNumber(const int phoneNumber);

    enum Gender {Male, Female};
    void setGender(Gender gender);
    Gender gender() const;

    QDate brithday() const;
    void setBrithday(const QDate& dob);

  private:
    QString m_name;
    int m_phoneNumber;
    Gender m_gender;
    QDate m_dob;
};

那么,我们可以使用下面的代码将Person类进行 JSON 序列化:

Person person;
person.setName("Flavio");
person.setPhoneNumber(123456);
person.setGender(Person::Male);
person.setDob(QDate(1982, 7, 12));

QVariantMap variant = QObjectHelper::qobject2qvariant(&person);
QJson::Serializer serializer;
qDebug() << serializer.serialize( variant);

以及:

QJson::Parser parser;
QVariant variant = parser.parse(json);
Person person;
QObjectHelper::qvariant2qobject(variant.toMap(), &person);

进行反序列化。

22 评论

datde 2014年6月7日 - 15:55

豆子你好,我在QT5.2.1版本山试图使用该QJson库,失败。
参考文档为:
http://blog.sina.com.cn/s/blog_6d0730c701012arj.html

请问QT5不能引用该库了么

回复
smart 2014年6月10日 - 11:35

这个库真么编,我是真心蛋疼了。网上各种方法cmake总报错。。

回复
smart 2014年7月2日 - 12:42

我在4,7编译成功了,你要加环境变量 把g++,gcc在的路径都加进去。。。

回复
smart 2014年7月2日 - 12:43

汗。。。忘了这个是自己问的了。。o(╯□╰)o

回复
豆子 2014年6月12日 - 10:27

我测试的 QJson 是可以在 Qt 5 中使用的,不知道你哪里出问题了?

回复
smart 2014年7月2日 - 12:44

我编译成dll了,没有直接用源码。

回复
smart 2014年6月10日 - 13:50

Qjson用cmake怎么编成库。。。。求解救、试了好多方法。

回复
王琼夏 2015年2月12日 - 11:42

豆子你好,麻烦问一下,你是如何使用 git clone 出 QJson 的整个代码呢?也就是哪里有代码?谢谢

回复
豆子 2015年2月18日 - 11:43

如果 clone 成功,目录下就应该有源代码的。如果没有,很有可能是因为网络问题 clone 失败,可以多尝试几次 clone 操作,看能不能获取代码。

回复
蔡同松 2015年2月27日 - 12:26

我不知道为什么 我用了上面的源代码 编译错误,我必须把 源代码修改成这样才可以运行通过,编译没有错误。

QString json("{"
"\"encoding\" : \"UTF-8\","
"\"plug-ins\" : ["
"\"python\","
"\"c++\","
"\"ruby\""
"],"
"\"indent\" : { \"length\" :\"3\", \"use_space\" : \"true\" }"
"}");

回复
豆子 2015年3月9日 - 14:28

加上引号是作为字符串,而不是原始的 int 和 bool 类型。JSON 规范里面应该是允许的。不知道为什么会有错误,是不是版本问题?

回复
dd 2015年6月9日 - 10:02

使用Qt4.8.1编译,出现moc_parserrunnable.cpp:56: error: definition of static data member 'QJson::ParserRunnable::staticMetaObjectExtraData' of dllimport'd class
错误,于是将所有的 QJSON_EXPORT 去掉,不让生成dll, 编译通过。希望能帮到别人~~

回复
zhudx6512 2015年7月31日 - 12:13

豆子你好。
请问在上面的代码中,有QString json("...")这里面的内容为什么是像你上面这样写的呢?里面有许多""是干什么用的。比如"{""这后面接了两个引号。。。

回复
豆子 2015年8月1日 - 14:44

C++ 里面,相邻的两个字符串可以直接拼接,例如 "{" "aaa" "}" 等价于 "{aaa}"。这么写的目的是将 JSON 写成多行,有利于阅读。

回复
zhudx6512 2015年9月2日 - 21:00

涨知识了,谢谢 🙂

回复
Jil 2015年10月3日 - 18:43

都是C++基础差的同学...

回复
Apeart 2015年8月29日 - 15:27

楼主写的是第三方的吧,QT5官方有支持了,不过... http://blog.csdn.net/jzaicn/article/details/41448863

居然有这么蛋疼的东西!!!!

回复
Jil 2015年10月3日 - 19:15

当我尝试把源代码添加到项目的时候,按您的说法添加了
#include "QJSON\parser.h"
旁边的项目树也添加了QJSON文件夹,其它就一样了,
编译提示class QVariant __thiscall QJson::Parser::parse无法解析的外部符号。在_main中被引用,未找到文件main.obj

回复
豆子 2015年10月9日 - 10:30

有没有重新运行一下 qmake 试试,还有看看新版本的 QJSON 是不是有了修改?

回复
M 2020年4月26日 - 09:18

非常适合新手看,感谢

回复
Niu MuYe 2021年7月10日 - 15:34

请问类里面开头这些语句的作用是什么?
Q_PROPERTY(QString name READ name WRITE setName)
Q_PROPERTY(int phoneNumber READ phoneNumber WRITE setPhoneNumber)
Q_PROPERTY(Gender gender READ gender WRITE setGender)
Q_PROPERTY(QDate brithday READ brithday WRITE setBrithday)
Q_ENUMS(Gender)

回复
豆子 2021年7月17日 - 15:10

Q_PROPERTY 定义了属性,即 property。它是基于 Qt 的元对象系统的,可以让系统选择获取属性的方式,比如 QString name 的读方法是 name,写方法是 setName。暴露出这些属性,就可以让 QML 等其它技术使用。

回复

发表评论

关于我

devbean

devbean

豆子,生于山东,定居南京。毕业于山东大学软件工程专业。软件工程师,主要关注于 Qt、Angular 等界面技术。

主题 Salodad 由 PenciDesign 提供 | 静态文件存储由又拍云存储提供 | 苏ICP备13027999号-2