Класс QJsonDocument

Класс QJsonDocument предоставляет способ чтения и записи JSON-документов. Подробнее...

Этот класс был представлен в Qt 5.0.

• Список всех членов, включая унаследованные
• Устаревшие члены

Примечание: Все функции в этом классе являются реентерабельными.

Общедоступные типы

Общедоступные функции

Статические общедоступные члены

Подробное описание

QJsonDocument — это класс, который оборачивает весь JSON-документ и может читать и писать этот документ как из текстового представления, закодированного в UTF-8, так и из собственного двоичного формата Qt.

JSON-документ можно преобразовать из его текстового представления в QJsonDocument с помощью QJsonDocument::fromJson(). toJson() преобразует его обратно в текст. Парсер очень быстрый и эффективный, преобразует JSON в двоичное представление, используемое Qt.

Можно проверить валидность обработанного документа с помощью !isNull()

Можно проверить, содержит ли документ массив или объект, с помощью isArray() и isObject(). Массив или объект, содержащиеся в документе, можно получить с помощью array() или object() и затем прочитать или изменить.

Документ также можно создать из сохранённого двоичного представления, используя fromBinaryData() или fromRawData().

См. также Поддержка JSON в Qt и Пример сохранения игры в JSON.

Документация по типам членов

Перечисление QJsonDocument::DataValidation

Это значение используется для указания QJsonDocument, нужно ли проверять двоичные данные при преобразовании в QJsonDocument с помощью fromBinaryData() или fromRawData().

Перечисление QJsonDocument::JsonFormat

Это значение определяет формат JSON-байтового массива, создаваемого при преобразовании в QJsonDocument с помощью toJson().

    {
        "Array": [
            true,
            999,
            "string"
        ],
        "Key": "Value",
        "null": null
    }

    {"Array":[true,999,"string"],"Key":"Value","null":null}

Это перечисление было введено или изменено в Qt 5.1.

Документация по функциям членов

QJsonDocument::QJsonDocument(QJsonDocument &&other)

Создает QJsonDocument, перемещая данные из other.

Эта функция была введена в Qt 5.10.

QJsonDocument::QJsonDocument(const QJsonDocument &other)

Создает копию документа other.

QJsonDocument::QJsonDocument(const QJsonArray &array)

Создает QJsonDocument из array.

QJsonDocument::QJsonDocument(const QJsonObject &object)

Создает QJsonDocument из object.

QJsonDocument::QJsonDocument()

Создает пустой и невалидный документ.

QJsonDocument &QJsonDocument::operator=(QJsonDocument &&other)

Перемещает присвоение other этому документу.

Эта функция была добавлена в Qt 5.10.

QJsonDocument &QJsonDocument::operator=(const QJsonDocument &other)

Присваивает документ other этому QJsonDocument. Возвращает ссылку на этот объект.

QJsonDocument::~QJsonDocument()

Удаляет документ.

Набор бинарных данных с fromRawData не освобождается.

QJsonArray QJsonDocument::array() const

Возвращает QJsonArray, содержащуюся в документе.

Возвращает пустой массив, если документ содержит объект.

См. также isArray(), object() и setArray().

[static] QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *error = nullptr)

Парсит json как UTF-8 кодированный JSON документ и создаёт QJsonDocument из него.

Возвращает корректный (не нулевой) QJsonDocument, если парсинг успешен. В случае ошибки возвращает null, а необязательная переменная error содержит подробности об ошибке.

См. также toJson(), QJsonParseError и isNull().

[static] QJsonDocument QJsonDocument::fromVariant(const QVariant &variant)

Создаёт QJsonDocument из QVariant variant.

Если variant содержит тип, отличный от QVariantMap, QVariantHash, QVariantList или QStringList, возвращаемый документ некорректен.

См. также toVariant().

bool QJsonDocument::isArray() const

Возвращает true , если документ содержит массив.

См. также array() и isObject().

bool QJsonDocument::isEmpty() const

Возвращает true если документ не содержит данных.

bool QJsonDocument::isNull() const

возвращает true если этот документ null.

Нулевые документы — это документы, созданные через конструктор по умолчанию.

Документы, созданные из UTF-8 кодированного текста или бинарного формата, проверяются при парсинге. Если проверка не пройдена, возвращаемый документ также будет null.

bool QJsonDocument::isObject() const

Возвращает true если документ содержит объект.

См. также object() и isArray().

QJsonObject QJsonDocument::object() const

Возвращает QJsonObject, содержащуюся в документе.

Возвращает пустой объект, если документ содержит массив.

См. также isObject(), array() и setObject().

void QJsonDocument::setArray(const QJsonArray &array)

Устанавливает array как главный объект этого документа.

См. также setObject() и array().

void QJsonDocument::setObject(const QJsonObject &object)

Устанавливает object как главный объект этого документа.

См. также setArray() и object().

void QJsonDocument::swap(QJsonDocument &other)

Меняет местами документ other с этим. Данная операция очень быстрая и никогда не приводит к ошибке.

Эта функция была добавлена в Qt 5.10.

QByteArray QJsonDocument::toJson() const

Преобразует QJsonDocument в отформатированный, UTF-8 кодированный JSON документ.

См. также fromJson().

QByteArray QJsonDocument::toJson(QJsonDocument::JsonFormat format) const

Преобразует QJsonDocument в UTF-8 кодированный JSON документ в заданном формате format.

Эта функция была добавлена в Qt 5.1.

См. также fromJson() и JsonFormat.

QVariant QJsonDocument::toVariant() const

Возвращает QVariant, представляющую JSON документ.

Возвращаемый variant будет QVariantList, если документ является QJsonArray, и QVariantMap, если документ является QJsonObject.

См. также fromVariant() и QJsonValue::toVariant().

bool QJsonDocument::operator!=(const QJsonDocument &other) const

возвращает true если other не равно этому документу

bool QJsonDocument::operator==(const QJsonDocument &other) const

Возвращает true если документ other равен этому документу.

const QJsonValue QJsonDocument::operator[](const QString &key) const

Возвращает QJsonValue, представляющую значение для ключа key.

Эквивалентно вызову object().value(key).

Возвращаемый QJsonValue равен QJsonValue::Undefined, если ключ не существует или если isObject() равно false.

Эта функция была добавлена в Qt 5.10.

См. также QJsonValue, QJsonValue::isUndefined() и QJsonObject.

const QJsonValue QJsonDocument::operator[](QStringView key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.14.

const QJsonValue QJsonDocument::operator[](QLatin1String key) const

Это перегруженная функция.

Эта функция была добавлена в Qt 5.10.

const QJsonValue QJsonDocument::operator[](int i) const

Возвращает QJsonValue, представляющую значение для индекса i.

Эквивалентно вызову array().at(i).

Возвращаемый QJsonValue равен QJsonValue::Undefined, если i выходит за пределы массива или если isArray() равно false.

Эта функция была добавлена в Qt 5.10.

См. также QJsonValue, QJsonValue::isUndefined() и QJsonArray.