Класс QJsonValue
Класс QJsonValue инкапсулирует значение в JSON. Подробнее...
| Заголовок: | #include <QJsonValue> |
| qmake: | QT += core |
| С тех пор: | Qt 5.0 |
Этот класс был представлен в Qt 5.0.
Примечание: Все функции в этом классе являются повторно входящими.
Типы публичного доступа
| перечисление | Тип { Пустое, Булево, Двойное, Строка, Массив, …, Неопределенное } |
Функции публичного доступа
| QJsonValue(QJsonValue &&other) | |
| QJsonValue(const QJsonValue &other) | |
| QJsonValue(const QJsonObject &o) | |
| QJsonValue(const QJsonArray &a) | |
| QJsonValue(const char *s) | |
| QJsonValue(QLatin1String s) | |
| QJsonValue(const QString &s) | |
| QJsonValue(qint64 v) | |
| QJsonValue(int v) | |
| QJsonValue(double v) | |
| QJsonValue(bool b) | |
| QJsonValue(QJsonValue::Type type = Пустое) | |
| QJsonValue & | operator=(QJsonValue &&other) |
| QJsonValue & | operator=(const QJsonValue &other) |
| ~QJsonValue() | |
| bool | isArray() const |
| bool | isBool() const |
| bool | isDouble() const |
| bool | isNull() const |
| bool | isObject() const |
| bool | isString() const |
| bool | isUndefined() const |
| void | swap(QJsonValue &other) |
| QJsonArray | toArray(const QJsonArray &defaultValue) const |
| QJsonArray | toArray() const |
| bool | toBool(bool defaultValue = false) const |
| double | toDouble(double defaultValue = 0) const |
| int | toInt(int defaultValue = 0) const |
| QJsonObject | toObject(const QJsonObject &defaultValue) const |
| QJsonObject | toObject() const |
| QString | toString() const |
| QString | toString(const QString &defaultValue) const |
| QVariant | toVariant() const |
| QJsonValue::Type | type() const |
| bool | operator!=(const QJsonValue &other) const |
| bool | operator==(const QJsonValue &other) const |
| const QJsonValue | operator[](const QString &key) const |
| const QJsonValue | operator[](QStringView key) const |
| const QJsonValue | operator[](QLatin1String key) const |
| const QJsonValue | operator[](int i) const |
Статические члены публичного доступа
| QJsonValue | fromVariant(const QVariant &variant) |
Подробное описание
Значение в JSON может быть одним из 6 основных типов:
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() и так далее.
Значения строго типизированы внутри и, в отличие от QVariant, не будут пытаться выполнять неявные преобразования типов. Это означает, что преобразование в тип, который не хранится в значении, вернёт значение по умолчанию.
QJsonValueRef
QJsonValueRef — вспомогательный класс для QJsonArray и QJsonObject. Когда вы получаете объект типа QJsonValueRef, вы можете использовать его так, как если бы это была ссылка на QJsonValue. Если вы присваиваете ему значение, присваивание будет применено к элементу в QJsonArray или QJsonObject, из которого вы получили ссылку.
Следующие методы возвращают QJsonValueRef:
- QJsonArray::operator[](int i)
- QJsonObject::operator[](const QString & key) const
См. также Поддержка JSON в Qt и Пример сохранения игры JSON.
Документация типов членов
enum QJsonValue::Type
Этот перечисление описывает тип значения JSON.
| Постоянная | Значение | Описание |
|---|---|---|
QJsonValue::Null |
0x0 |
Значение Null |
QJsonValue::Bool |
0x1 |
Булево значение. Используйте toBool() для преобразования в bool. |
QJsonValue::Double |
0x2 |
Число с плавающей точкой. Используйте toDouble() для преобразования в double. |
QJsonValue::String |
0x3 |
Строка. Используйте toString() для преобразования в QString. |
QJsonValue::Array |
0x4 |
Массив. Используйте toArray() для преобразования в QJsonArray. |
QJsonValue::Object |
0x5 |
Объект. Используйте toObject() для преобразования в QJsonObject. |
QJsonValue::Undefined |
0x80 |
Значение не определено. Обычно возвращается как ошибка, когда пытаетесь прочитать значение за пределами массива или несуществующий ключ в объекте. |
Документация по функциям-членам
QJsonValue::QJsonValue(QJsonValue &&other)
Перемещающее создание QJsonValue из other.
Эта функция была добавлена в Qt 5.10.
QJsonValue::QJsonValue(const QJsonValue &other)
Создает копию other.
QJsonValue::QJsonValue(const QJsonObject &o)
Создаёт значение типа Объект со значением o.
QJsonValue::QJsonValue(const QJsonArray &a)
Создаёт значение типа Массив со значением a.
QJsonValue::QJsonValue(const char *s)
Создаёт значение типа Строка со значением s, предполагая кодировку UTF-8 входных данных.
Вы можете отключить этот конструктор, определив QT_NO_CAST_FROM_ASCII при компиляции ваших приложений.
Эта функция была добавлена в Qt 5.3.
QJsonValue::QJsonValue(QLatin1String s)
Создаёт значение типа Строка со значением s.
QJsonValue::QJsonValue(const QString &s)
Создаёт значение типа Строка со значением s.
QJsonValue::QJsonValue(qint64 v)
Это перегруженная функция.
Создаёт значение типа Число с плавающей точкой, со значением v. ПРИМЕЧАНИЕ: пределы целых чисел для данных двойной точности IEEE 754 составляют 2^53 (-9007199254740992 до +9007199254740992). Если вы передадите значения за пределами этого диапазона, ожидайте потери точности.
QJsonValue::QJsonValue(int v)
Это перегруженная функция.
Создаёт значение типа Число с плавающей точкой, со значением v.
QJsonValue::QJsonValue(double v)
Создаёт значение типа Число с плавающей точкой, со значением v.
QJsonValue::QJsonValue(bool b)
Создаёт значение типа Булево, со значением b.
QJsonValue::QJsonValue(QJsonValue::Type type = Null)
Создаёт QJsonValue типа type.
По умолчанию создаётся значение Null.
QJsonValue &QJsonValue::operator=(QJsonValue &&other)
Перемещающее присваивание other этому значению.
Эта функция была добавлена в Qt 5.10.
QJsonValue &QJsonValue::operator=(const QJsonValue &other)
Присваивает значение, хранящееся в other, этому объекту.
QJsonValue::~QJsonValue()
Удаляет значение.
[static] QJsonValue QJsonValue::fromVariant(const QVariant &variant)
Преобразует variant в QJsonValue и возвращает его.
Преобразование выполняется следующим образом:
| Исходный тип | Целевой тип |
|---|---|
| QJsonValue::Null | |
| QJsonValue::Bool | |
| QJsonValue::Double | |
| QJsonValue::String | |
| QJsonValue::Array | |
| QJsonValue::Object | |
| QJsonValue::String. Преобразование использует QUrl::toString() с флагом QUrl::FullyEncoded для обеспечения максимальной совместимости при парсинге URL | |
| QJsonValue::String. Начиная с Qt 5.11, результирующая строка не будет содержать фигурных скобок | |
| Любой тип, который возвращает QCborValue::toJsonValue(). | |
| QJsonValue::Array. См. QCborValue::toJsonValue() для ограничений преобразования. | |
| QJsonValue::Object. См. QCborValue::toJsonValue() для ограничений преобразования и "строкового" представления ключей словаря. |
Потеря информации и другие типы
QVariant может содержать больше информации, чем может быть представлено в JSON. Если QVariant не является одним из перечисленных типов, преобразование не гарантируется и может измениться в будущих версиях Qt, как это было с UUID. Код должен стремиться не использовать другие типы, кроме перечисленных выше.
Если QVariant::isNull() возвращает true, возвращается или вставляется null QJsonValue в список или объект независимо от типа, хранящегося в QVariant. Обратите внимание на изменение поведения в Qt 6.0, которое влияет на QVariant::isNull() и, соответственно, на эту функцию.
Значение с плавающей точкой, являющееся бесконечностью или NaN, будет преобразовано в null значение JSON. Начиная с Qt 6.0, QJsonValue может хранить всю точность любого 64-битного целого без потерь, но в предыдущих версиях значения за пределами диапазона ±2^53 могут потерять точность. Беззнаковые 64-битные значения, большие или равные 2^63, либо потеряют точность, либо будут алиасить до отрицательных значений, поэтому QMetaType::ULongLong следует избегать.
Для других типов, не перечисленных выше, будет предпринята попытка преобразования в строку, обычно, но не всегда, с помощью QVariant::toString(). Если преобразование не удается, значение заменяется на null значение JSON. Обратите внимание, что QVariant::toString() также приводит к потере информации для большинства типов. Например, если переданный QVariant представляет данные сырого массива байтов, рекомендуется предварительно закодировать их в Base64 (или другую без потерь кодировку), в противном случае будет использоваться потери кодировка с помощью QString::fromUtf8().
Обратите внимание, что преобразования через QVariant::toString() могут быть изменены в любое время. Как QVariant, так и QJsonValue могут быть расширены в будущем для поддержки дополнительных типов, что приведет к изменению работы этой функции при преобразованиях.
См. также toVariant() и QCborValue::fromVariant().
bool QJsonValue::isArray() const
Возвращает true если значение содержит массив.
См. также toArray().
bool QJsonValue::isBool() const
Возвращает true , если значение содержит булево значение.
См. также toBool().
bool QJsonValue::isDouble() const
Возвращает true , если значение содержит число с плавающей точкой.
См. также toDouble().
bool QJsonValue::isNull() const
Возвращает true , если значение равно null.
bool QJsonValue::isObject() const
Возвращает true , если значение содержит объект.
См. также toObject().
bool QJsonValue::isString() const
Возвращает true , если значение содержит строку.
См. также toString().
bool QJsonValue::isUndefined() const
Возвращает true , если значение не определено. Это может произойти в определённых случаях ошибок, например, при обращении к несуществующему ключу в QJsonObject.
void QJsonValue::swap(QJsonValue &other)
Меняет местами значение other с этим. Данная операция очень быстрая и никогда не терпит неудачу.
Эта функция была добавлена в Qt 5.10.
QJsonArray QJsonValue::toArray(const QJsonArray &defaultValue) const
Преобразует значение в массив и возвращает его.
Если type() не равно Array, возвращается defaultValue.
QJsonArray QJsonValue::toArray() const
Это перегруженная функция.
Преобразует значение в массив и возвращает его.
Если type() не равно Array, возвращается QJsonArray().
bool QJsonValue::toBool(bool defaultValue = false) const
Преобразует значение в bool и возвращает его.
Если type() не равно bool, возвращается defaultValue.
double QJsonValue::toDouble(double defaultValue = 0) const
Преобразует значение в double и возвращает его.
Если type() не равно Double, возвращается defaultValue.
int QJsonValue::toInt(int defaultValue = 0) const
Преобразует значение в int и возвращает его.
Если type() не равно Double или значение не является целым числом, возвращается defaultValue.
Эта функция была добавлена в Qt 5.2.
QJsonObject QJsonValue::toObject(const QJsonObject &defaultValue) const
Преобразует значение в объект и возвращает его.
Если type() не равно Object, возвращается defaultValue.
QJsonObject QJsonValue::toObject() const
Это перегруженная функция.
Преобразует значение в объект и возвращает его.
Если type() не равно Object, возвращается QJsonObject().
QString QJsonValue::toString() const
Преобразует значение в QString и возвращает его.
Если type() не равно String, возвращается null QString.
См. также QString::isNull().
QString QJsonValue::toString(const QString &defaultValue) const
Преобразует значение в QString и возвращает его.
Если type() не равно String, возвращается defaultValue.
QVariant QJsonValue::toVariant() const
Преобразует значение в QVariant().
Типы QJsonValue будут преобразованы следующим образом:
| Постоянная | Описание |
|---|---|
Null |
QMetaType::Nullptr |
Bool |
QMetaType::Bool |
Double |
QMetaType::Double или QMetaType::LongLong |
String |
QString |
Array |
QVariantList |
Object |
QVariantMap |
Undefined |
QVariant() |
См. также fromVariant().
QJsonValue::Type QJsonValue::type() const
Возвращает тип значения.
См. также QJsonValue::Type.
bool QJsonValue::operator!=(const QJsonValue &other) const
Возвращает true , если значение не равно other.
bool QJsonValue::operator==(const QJsonValue &other) const
Возвращает true , если значение равно other.
const QJsonValue QJsonValue::operator[](const QString &key) const
Возвращает QJsonValue, представляющую значение для ключа key.
Эквивалентно вызову toObject().value(key).
Возвращаемое QJsonValue будет QJsonValue::Undefined, если ключ не существует или если isObject() равно false.
Эта функция была добавлена в Qt 5.10.
См. также QJsonValue, QJsonValue::isUndefined() и QJsonObject.
const QJsonValue QJsonValue::operator[](QStringView key) const
Это перегруженная функция.
Эта функция была добавлена в Qt 5.14.
const QJsonValue QJsonValue::operator[](QLatin1String key) const
Это перегруженная функция.
Эта функция была добавлена в Qt 5.10.
const QJsonValue QJsonValue::operator[](int i) const
Возвращает QJsonValue, представляющую значение для индекса i.
Эквивалентно вызову toArray().at(i).
Возвращаемое QJsonValue будет QJsonValue::Undefined, если i выходит за пределы границ или если isArray() равно false.
Эта функция была добавлена в Qt 5.10.
См. также QJsonValue, QJsonValue::isUndefined() и QJsonArray.
© The Qt Company Ltd
Licensed under the GNU Free Documentation License, Version 1.3.
https://doc.qt.io/qt-5.15/qjsonvalue.html