内容

• 公共类型
• 公共函数
• 静态公共成员
• 详细描述

QJsonDocument 类

The QJsonDocument class provides a way to read and write JSON documents. 更多...

• 所有成员列表，包括继承成员

注意： 此类的所有函数 可重入 .

公共类型

公共函数

静态公共成员

详细描述

The QJsonDocument class provides a way to read and write JSON documents.

QJsonDocument is a class that wraps a complete JSON document and can read and write this document both from a UTF-8 encoded text based representation as well as Qt's own binary format.

A JSON document can be converted from its text-based representation to a QJsonDocument 使用 QJsonDocument::fromJson (). toJson () converts it back to text. The parser is very fast and efficient and converts the JSON to the binary representation used by Qt.

Validity of the parsed document can be queried with ! isNull ()

A document can be queried as to whether it contains an array or an object using isArray () 和 isObject (). The array or object contained in the document can be retrieved using array () 或 对象 () and then read or manipulated.

A document can also be created from a stored binary representation using fromBinaryData () 或 fromRawData ().

另请参阅 在 Qt 中支持 JSON and JSON 保存游戏范例 .

成员类型文档编制

enum QJsonDocument:: DataValidation

This value is used to tell QJsonDocument whether to validate the binary data when converting to a QJsonDocument 使用 fromBinaryData () 或 fromRawData ().

enum QJsonDocument:: JsonFormat

This value defines the format of the JSON byte array produced when converting to a QJsonDocument 使用 toJson ().

    {

"Array"

:

[


true


,


999


,


"string"


]


,


"Key"

:

"Value"


,


"null"

: null
}
								

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

该枚举在 Qt 5.1 引入或被修改。

成员函数文档编制

QJsonDocument:: QJsonDocument ()

构造空的无效文档。

QJsonDocument:: QJsonDocument (const QJsonObject & object )

创建 QJsonDocument from object .

QJsonDocument:: QJsonDocument (const QJsonArray & array )

构造 QJsonDocument from array .

QJsonDocument:: QJsonDocument (const QJsonDocument & other )

创建副本为 other 文档。

QJsonDocument:: QJsonDocument ( QJsonDocument && other )

移动构造 QJsonDocument from other .

该函数在 Qt 5.10 引入。

QJsonDocument:: ~QJsonDocument ()

删除文档。

Binary data set with fromRawData is not freed.

QJsonArray QJsonDocument:: array () const

返回 QJsonArray 包含在文档中。

返回空数组若文档包含对象。

另请参阅 isArray (), 对象 ()，和 setArray ().

[static] QJsonDocument QJsonDocument:: fromBinaryData (const QByteArray & data , QJsonDocument::DataValidation validation = Validate)

创建 QJsonDocument from data .

validation decides whether the data is checked for validity before being used. By default the data is validated. If the data is not valid, the method returns a null document.

另请参阅 toBinaryData (), fromRawData (), isNull ()，和 DataValidation .

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

剖析 json 作为 UTF-8 编码 JSON 文档，并创建 QJsonDocument 从它。

返回有效 (非 null) QJsonDocument 若剖析成功。若它失败，返回文档将为 null，且可选 error 变量将包含有关错误的进一步细节。

另请参阅 toJson (), QJsonParseError ，和 isNull ().

[static] QJsonDocument QJsonDocument:: fromRawData (const char * data , int size , QJsonDocument::DataValidation validation = Validate)

创建 QJsonDocument that uses the first size 字节来自 data . It assumes data contains a binary encoded JSON document. The created document does not take ownership of data and the caller has to guarantee that data will not be deleted or modified as long as any QJsonDocument , QJsonObject or QJsonArray still references the data.

data 必须对齐 4 字节边界。

validation decides whether the data is checked for validity before being used. By default the data is validated. If the data is not valid, the method returns a null document.

返回 QJsonDocument 表示数据。

另请参阅 rawData (), fromBinaryData (), isNull ()，和 DataValidation .

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

创建 QJsonDocument 从 QVariant variant .

若 variant 包含任何其它类型除了 QVariantMap , QVariantHash , QVariantList or QStringList ，返回的文档无效。

另请参阅 toVariant ().

bool QJsonDocument:: isArray () const

返回 true 若文档包含数组。

另请参阅 array () 和 isObject ().

bool QJsonDocument:: isEmpty () const

返回 true 若文档未包含任何数据。

bool QJsonDocument:: isNull () const

返回 true 若此文档为 null。

null 是透过默认构造函数创建文档。

Documents created from UTF-8 encoded text or the binary format are validated during parsing. If validation fails, the returned document will also be null.

bool QJsonDocument:: isObject () const

返回 true 若文档包含对象。

另请参阅 对象 () 和 isArray ().

QJsonObject QJsonDocument:: 对象 () const

返回 QJsonObject 包含在文档中。

返回空对象若文档包含数组。

另请参阅 isObject (), array ()，和 setObject ().

const char *QJsonDocument:: rawData ( int * size ) const

Returns the raw binary representation of the data size 将包含返回数据的大小。

This method is useful to e.g. stream the JSON document in it's binary form to a file.

void QJsonDocument:: setArray (const QJsonArray & array )

集 array 作为此文档的 main 对象。

另请参阅 setObject () 和 array ().

void QJsonDocument:: setObject (const QJsonObject & object )

集 object 作为此文档的 main 对象。

另请参阅 setArray () 和 对象 ().

void QJsonDocument:: swap ( QJsonDocument & other )

Swaps the document other with this. This operation is very fast and never fails.

该函数在 Qt 5.10 引入。

QByteArray QJsonDocument:: toBinaryData () const

Returns a binary representation of the document.

The binary representation is also the native format used internally in Qt, and is very efficient and fast to convert to and from.

The binary format can be stored on disk and interchanged with other applications or computers. fromBinaryData () can be used to convert it back into a JSON document.

另请参阅 fromBinaryData ().

QByteArray QJsonDocument:: toJson () const

转换 QJsonDocument to an indented, UTF-8 encoded JSON document.

另请参阅 fromJson ().

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

转换 QJsonDocument 成 UTF-8 编码 JSON 文档在提供 format .

该函数在 Qt 5.1 引入。

另请参阅 fromJson () 和 JsonFormat .

QVariant QJsonDocument:: toVariant () const

返回 QVariant 表示 Json 文档。

返回的变体将是 QVariantList 若文档为 QJsonArray 和 QVariantMap 若文档为 QJsonObject .

另请参阅 fromVariant () 和 QJsonValue::toVariant ().

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

返回 true if other 不等于此文档

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

赋值 other 文档到此 QJsonDocument 。返回此对象的引用。

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

移动赋值 other 到此文档。

该函数在 Qt 5.10 引入。

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

返回 true 若 other 文档等于此文档。

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

返回 QJsonValue 表示值为键 key .

相当于调用 对象 ().value(key).

返回的 QJsonValue is QJsonValue::Undefined 若键不存在，或者若 isObject () 为 false。

该函数在 Qt 5.10 引入。

另请参阅 QJsonValue , QJsonValue::isUndefined ()，和 QJsonObject .

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

这是重载函数。

该函数在 Qt 5.10 引入。

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

返回 QJsonValue representing the value for index i .

相当于调用 array ().at(i).

返回的 QJsonValue is QJsonValue::Undefined ，若 i 超出边界，或者若 isArray () 为 false。

该函数在 Qt 5.10 引入。

另请参阅 QJsonValue , QJsonValue::isUndefined ()，和 QJsonArray .