The qt-json project is a simple collection of functions for parsing and serializing JSON data to and from QVariant hierarchies.
NOTE: Qt5 introduced a native JSON object class. If you are targeting Qt5, you should use that instead.
HOW TO USE
Parsing JSON
The parser is really easy to use. Let's say we have the following QString of JSON data:
{
"encoding" : "UTF-8",
"plug-ins" : [
"python",
"c++",
"ruby"
],
"indent" : {
"length" : 3,
"use_space" : true
}
}
We would first call the parse-function:
#include "json.h"
bool ok;
// json is a QString containing the JSON data
QtJson::JsonObject result = QtJson::parse(json, ok).toMap();
if(!ok) {
qFatal("An error occurred during parsing");
Assuming the parser completed without errors, we can then go through the hierarchy:
qDebug() << "encoding:" << result["encoding"].toString();
qDebug() << "plugins:";
foreach(QVariant plugin, result["plug-ins"].toList()) {
qDebug() << " -" << plugin.toString();
}
QtJson::JsonObject nested = result["indent"].toMap();
qDebug() << "length:" << nested["length"].toInt();
qDebug() << "use_space:" << nested["use_space"].toBool();
The previous code would print out the following:
encoding: "UTF-8"
plugins:
- "python"
- "c++"
- "ruby"
length: 3
use_space: true
Serializing JSON
To write JSON data from Qt object is as simple as creating and assigning data to a QVariantMap/JsonObject:
QtJson::JsonObject contributor;
contributor["name"] = "Luis Gustavo";
contributor["age"] = 22;
QByteArray data = QtJson::serialize(contributor);
The byte array 'data' contains valid JSON data:
{
"name": "Luis Gustavo",
"age": 22
}
Serializing JSON pretty-print
By default, the serialization will create a minified version, like following:
{"name":"Luis Gustavo","age":22}
If you are debugging or logging, you may prefer to enable pretty-print mode globally, before serialize:
QtJson::setPrettySerialize(true);
QByteArray data = QtJson::serialize(contributor);
// ...
QByteArray data = QtJson::serialize(other_contributor);
Obviously, you can disable it with:
QtJson::setPrettySerialize(false);
After creating the QVariantMap, you can create a QVariantList/JsonArray and append the QVariantMaps.
QtJson::JsonObject friend1, friend2, friend3;
friend1["id"] = 1;
friend1["name"] = "Mackenzie Hamphrey";
friend2["id"] = 2;
friend2["name"] = "Melanie Molligan";
friend3["id"] = 3;
friend3["name"] = "Sydney Calhoun";
QtJson::JsonArray friends;
friends.append(friend1);
friends.append(friend2);
friends.append(friend3);
QtJson::JsonObject obj;
obj["friends"] = friends;
This way you create a nested structure:
{
"friends": [
{
"id": 1,
"name": "MackenzieHamphrey"
},
{
"id": 2,
"name": "MelanieMolligan"
},
{
"id": 3,
"name": "SydneyCalhoun"
}
]
}
If you continue this process recursively, you nest more levels into the JSON structure.
Using Builders
For simplicity you can use builders, if you prefer.
For example, create a JsonObject:
QtJson::JsonObject json = QtJson::objectBuilder()
->set("field_1", 10)
->set("field_2", "A string")
->set("field_3", true)
->set("field_4", QtJson::objectBuilder()
->set("sub_field_1", 10.4)
->set("sub_field_n", "Another string")
)
->create();
Or create a JsonArray:
QtJson::JsonArray json = QtJson::arrayBuilder()
->add(5)
->add(90.2)
->add(true)
->add("anything else")
->create();
Take a look at this example that rewrite the previous one:
QtJson::JsonObject obj = QtJson::objectBuilder()
->set("friends", QtJson::arrayBuilder()
->add(QtJson::objectBuilder()
->set("id", 1)
->set("name", "Mackenzie Hamphrey")
)
->add(QtJson::objectBuilder()
->set("id", 2)
->set("name", "Melanie Molligan")
)
->add(QtJson::objectBuilder()
->set("id", 3)
->set("name", "Sydney Calhoun")
)
)
->create();
3. CONTRIBUTING
Send in a pull request and bug the maintainer until it gets merged and published. Make sure to add yourself to AUTHORS.
275 Dec 28, 2022
547 Jan 4, 2023
2.6k Dec 31, 2022
273 Dec 2, 2022
17 Oct 19, 2022
180 Dec 22, 2022
24 Sep 21, 2022
352 Jan 4, 2023
23 Jun 15, 2022
28 Dec 30, 2022
16.3k Dec 27, 2022
2.1k Jan 1, 2023
234 Jan 8, 2023
110 Dec 4, 2022
7 Oct 30, 2022
31 Nov 16, 2022
13 May 25, 2022
5 Sep 23, 2021