QJsonDocument Class
La clase QJsonDocument permite leer y escribir documentos JSON. Más información ...
| Encabezado: | #include <QJsonDocument> |
| CMake: | find_package(Qt6 REQUIRED COMPONENTS Core) target_link_libraries(mytarget PRIVATE Qt6::Core) |
| qmake: | QT += core |
- Lista de todos los miembros, incluidos los miembros heredados
- QJsonDocument forma parte del soporte para JSON en Qt y de las clases compartidas implícitamente.
Nota: Todas las funciones de esta clase son reentrantes.
Comparaciones de QJsonDocument
| Categoría | Tipos comparables |
|---|---|
| igualdad | QJsonDocument |
Tipos públicos
| enum | JsonFormat { Indented, Compact } |
Funciones públicas
| QJsonDocument() | |
(since 6.12) | QJsonDocument(QJsonArray &&array) |
(since 6.12) | QJsonDocument(QJsonObject &&object) |
| QJsonDocument(const QJsonArray &array) | |
| QJsonDocument(const QJsonObject &object) | |
| QJsonDocument(const QJsonDocument &other) | |
| QJsonDocument(QJsonDocument &&other) | |
| ~QJsonDocument() | |
| QJsonArray | array() const |
| bool | isArray() const |
| bool | isEmpty() const |
| bool | isNull() const |
| bool | isObject() const |
| QJsonObject | object() const |
| void | setArray(const QJsonArray &array) |
| void | setObject(const QJsonObject &object) |
| void | swap(QJsonDocument &other) |
| QByteArray | toJson(QJsonDocument::JsonFormat format = JsonFormat::Indented) const |
| QVariant | toVariant() const |
| QJsonDocument & | operator=(QJsonDocument &&other) |
| QJsonDocument & | operator=(const QJsonDocument &other) |
| const QJsonValue | operator[](const QString &key) const |
| const QJsonValue | operator[](qsizetype i) const |
| const QJsonValue | operator[](QLatin1StringView key) const |
| const QJsonValue | operator[](QStringView key) const |
Miembros públicos estáticos
| QJsonDocument | fromJson(const QByteArray &json, QJsonParseError *error = nullptr) |
| QJsonDocument | fromVariant(const QVariant &variant) |
Elementos no miembros relacionados
| bool | operator!=(const QJsonDocument &lhs, const QJsonDocument &rhs) |
| bool | operator==(const QJsonDocument &lhs, const QJsonDocument &rhs) |
Descripción detallada
QJsonDocument es una clase que envuelve un documento JSON completo y puede leer este documento desde una representación basada en texto codificada en UTF-8, así como escribirlo en ella.
Un documento JSON se puede convertir desde su representación textual a un QJsonDocument utilizando QJsonDocument::fromJson(). toJson() lo vuelve a convertir a texto. El analizador es muy rápido y eficiente, y convierte el JSON a la representación binaria utilizada por Qt.
La validez del documento analizado se puede comprobar con !isNull().
Se puede comprobar si un documento contiene una matriz o un objeto utilizando isArray() y isObject(). La matriz u objeto contenido en el documento se puede recuperar mediante array() o object(), para luego leerlo o manipularlo.
Véase también Compatibilidad con JSON en Qt y Guardar y cargar una partida.
Documentación sobre los tipos de miembros
enum QJsonDocument::JsonFormat
Este valor define el formato de la matriz de bytes JSON que se genera al convertir a un objeto ` QJsonDocument ` mediante la función ` toJson()`.
| Constante | Valor | Descripción |
|---|---|---|
QJsonDocument::Indented | 0 | Define una salida legible para el ser humano de la siguiente manera: |
QJsonDocument::Compact | 1 | Define una salida compacta de la siguiente manera: |
Documentación de las funciones de miembro
QJsonDocument::QJsonDocument()
Crea un documento vacío y no válido.
[explicit, since 6.12] QJsonDocument::QJsonDocument(QJsonArray &&array)
Crea un objeto `QJsonDocument` a partir de ` array`.
Esta función se introdujo en Qt 6.12.
[explicit, since 6.12] QJsonDocument::QJsonDocument(QJsonObject &&object)
Crea un QJsonDocument a partir de un objeto ` object`.
Esta función se introdujo en Qt 6.12.
[explicit] QJsonDocument::QJsonDocument(const QJsonArray &array)
Crea un objeto `QJsonDocument` a partir de ` array`.
[explicit] QJsonDocument::QJsonDocument(const QJsonObject &object)
Crea un objeto `QJsonDocument` a partir de ` object`.
QJsonDocument::QJsonDocument(const QJsonDocument &other)
Crea una copia del documento « other ».
[noexcept] QJsonDocument::QJsonDocument(QJsonDocument &&other)
Crea un objeto `QJsonDocument` a partir de ` other`.
[noexcept] QJsonDocument::~QJsonDocument()
Elimina el documento.
El conjunto de datos binarios creado con fromRawData no se libera.
QJsonArray QJsonDocument::array() const
Devuelve el objeto ` QJsonArray ` que contiene el documento.
Devuelve una matriz vacía si el documento contiene un objeto.
Véase también ` isArray()`, ` object()` y ` setArray()`.
[static] QJsonDocument QJsonDocument::fromJson(const QByteArray &json, QJsonParseError *error = nullptr)
Analiza json como un documento JSON codificado en UTF-8 y crea a partir de él un objeto ` QJsonDocument `.
Devuelve un ` QJsonDocument ` válido (no nulo) si el análisis se realiza correctamente. Si falla, el documento devuelto será nulo y la variable opcional ` error ` contendrá más detalles sobre el error.
Véase también toJson(), QJsonParseError y isNull().
[static] QJsonDocument QJsonDocument::fromVariant(const QVariant &variant)
Crea un « QJsonDocument » a partir del « QVariant » variant.
Si el ` variant ` contiene cualquier otro tipo que no sea ` QVariantMap`, ` QVariantHash`, ` QVariantList ` o ` QStringList`, el documento devuelto no es válido.
Véase también toVariant().
bool QJsonDocument::isArray() const
Devuelve « true » si el documento contiene una matriz.
Véase también array() y isObject().
bool QJsonDocument::isEmpty() const
Devuelve « true » si el documento no contiene ningún dato.
bool QJsonDocument::isNull() const
Devuelve « true » si este documento es nulo.
Los documentos nulos son aquellos creados mediante el constructor por defecto.
Los documentos creados a partir de texto codificado en UTF-8 o en formato binario se validan durante el análisis. Si la validación falla, el documento devuelto también será nulo.
bool QJsonDocument::isObject() const
Devuelve « true » si el documento contiene un objeto.
Véase también object() y isArray().
QJsonObject QJsonDocument::object() const
Devuelve el objeto ` QJsonObject ` contenido en el documento.
Devuelve un objeto vacío si el documento contiene un array.
Véase también isObject(), array() y setObject().
void QJsonDocument::setArray(const QJsonArray &array)
Establece array como el objeto principal de este documento.
Véase también setObject() y array().
void QJsonDocument::setObject(const QJsonObject &object)
Establece object como el objeto principal de este documento.
Véase también setArray() y object().
[noexcept] void QJsonDocument::swap(QJsonDocument &other)
Intercambia este documento con other. Esta operación es muy rápida y nunca falla.
QByteArray QJsonDocument::toJson(QJsonDocument::JsonFormat format = JsonFormat::Indented) const
Convierte el archivo « QJsonDocument » en un documento JSON codificado en UTF-8 en la ruta « format » indicada.
Véase también fromJson() y JsonFormat.
QVariant QJsonDocument::toVariant() const
Devuelve un objeto ` QVariant ` que representa el documento JSON.
La variante devuelta será un ` QVariantList ` si el documento es un ` QJsonArray ` y un ` QVariantMap ` si el documento es un ` QJsonObject`.
Véase también fromVariant() y QJsonValue::toVariant().
[noexcept] QJsonDocument &QJsonDocument::operator=(QJsonDocument &&other)
La acción «Mover» asigna « other » a este documento.
QJsonDocument &QJsonDocument::operator=(const QJsonDocument &other)
Asigna el documento ` other ` a este ` QJsonDocument`. Devuelve una referencia a este objeto.
const QJsonValue QJsonDocument::operator[](const QString &key) const
Devuelve un objeto ` QJsonValue ` que representa el valor de la clave ` key`.
Equivale a llamar a object().value(key).
El objeto ` QJsonValue ` devuelto es ` QJsonValue::Undefined ` si la clave no existe o si ` isObject()` es falso.
Véase también QJsonValue, QJsonValue::isUndefined() y QJsonObject.
const QJsonValue QJsonDocument::operator[](qsizetype i) const
Devuelve un objeto ` QJsonValue ` que representa el valor correspondiente al índice ` i`.
Equivale a llamar a ` array()`.at(i).
El objeto ` QJsonValue ` devuelto es ` QJsonValue::Undefined`, si ` i ` está fuera de límites o si ` isArray()` es falso.
Véase también QJsonValue, QJsonValue::isUndefined() y QJsonArray.
const QJsonValue QJsonDocument::operator[](QLatin1StringView key) const
Esta es una función sobrecargada.
const QJsonValue QJsonDocument::operator[](QStringView key) const
Esta es una función sobrecargada.
Elementos no miembros relacionados
[noexcept] bool operator!=(const QJsonDocument &lhs, const QJsonDocument &rhs)
Devuelve « true » si el documento « lhs » no es igual al documento « rhs »; en caso contrario, devuelve « false ».
[noexcept] bool operator==(const QJsonDocument &lhs, const QJsonDocument &rhs)
Devuelve ` true ` si el documento ` lhs ` es igual al documento ` rhs `; en caso contrario, devuelve ` false `.
© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.