JSON Support in Qt

Qt provides support for dealing with JSON data. JSON is a format to encode object data derived from Javascript, but now widely used as a data exchange format on the internet.

The JSON support in Qt provides an easy to use C++ API to parse, modify and save JSON data. It also contains support for saving this data in a binary format that is directly "mmap"-able and very fast to access.

More details about the JSON data format can be found at json.org and in RFC-4627.

Overview

JSON is a format to store structured data. It has 6 basic data types:

  • bool
  • double
  • string
  • array
  • object
  • null

A value can have any of the above types. A boolean value is represented by the strings true or false in JSON. JSON doesn't explicitly specify the valid range for numbers, but the support in Qt is limited to the validity range and precision of doubles. A string can be any valid unicode string. An array is a list of values, and an object is a collection of key/value pairs. All keys in an object are strings, and an object cannot contain any duplicate keys.

The text representation of JSON encloses arrays in square brackets ([ ... ]) and objects in curly brackets ({ ... }). Entries in arrays and objects are separated by commas. The separator between keys and values in an object is a colon (:).

A simple JSON document encoding a person, his/her age, address and phone numbers could look like:

{
    "FirstName": "John",
    "LastName": "Doe",
    "Age": 43,
    "Address": {
        "Street": "Downing Street 10",
        "City": "London",
        "Country": "Great Britain"
    },
    "Phone numbers": [
        "+44 1234567",
        "+44 2345678"
    ]
}

The above example consists of an object with 5 key/value pairs. Two of the values are strings, one is a number, one is another object and the last one an array.

A valid JSON document is either an array or an object, so a document always starts with a square or curly bracket.

The JSON Classes

All JSON classes are value based, implicitly shared classes.

JSON support in Qt consists of these classes:

See also JSON Save Game Example.

QJsonArray

Encapsulates a JSON array

QJsonDocument

Way to read and write JSON documents

QJsonObject

Encapsulates a JSON object

QJsonObject::iterator

QJsonObject::iterator class provides an STL-style non-const iterator for QJsonObject

QJsonObject::const_iterator

QJsonObject::const_iterator class provides an STL-style const iterator for QJsonObject

QJsonParseError

Used to report errors during JSON parsing

QJsonValue

Encapsulates a value in JSON

Notes provided by the Qt Community

No notes