Qt - 带有注释的 JSON

Qt - JSON with comments

本文关键字：JSON 注释 Qt      更新时间：2023-10-16

我知道 JSON 中的 C/C++ 样式注释(// ...，/* ... */( 是无效的，但因为人们有所谓的sense(不知道那是什么(故意使用无效的 JSON，例如 JSON minify 或 RapidJSON。

因为Qt带有它自己的JSON类，所以我(并不(惊讶地发现没有关于评论的内容。所以问题是...

示例输入文件：

test.json：

{
// This is a comment
/* This is a another comment */
"property1": "It's just json",
"foo": "bar"
}

Qt是否提供了某种使用(无效(注释JSON的方法，或者我是否必须为此使用其他库？

正如我在上面的评论中提到的，您可以使用QJSEngine为您完成大部分繁重的工作。 您作为示例提供的字符串本身不会评估为 JSON，但它绝对是有效的 JavaScript。 因此，如果我们可以让 JavaScript 引擎来评估该文本(因此忽略注释(，我们可以使用脚本引擎中的内置 JSON 对象来完成将其转换回字符串的所有工作。

最简单的事情就是利用JSEngine作为你的JSON解析器：

QString str = <your json input file that has comments>
QJSValue val = jsengine.evaluate(text);

该表达式的结果是 QJSValue (val( 的实例，它将是完全解析的对象树。 可以使用 QJSValue 上的所有方法来枚举子对象和值。 你完成了。

如果你真的想去掉注释，以便与不同的JSON解析器(包括Qt内置的那个(一起使用，你可以在上面调用JSON.stringify：

#include <QJSEngine>
#include <QJSValue>
QString stripCommentsOffJSon(const QString& originalText)
{
QJSEngine jsengine;
QString result;
// create an assignment statement so that evaulation works reliably
QString evalExpression = "x=" + originalText + ";";
QJSValue val = jsengine.evaluate(QString(evalExpression));
if (val.isObject() || val.isArray() || val.isNumber() || val.isBool() || val.isNull() || val.isString())
{
QJSValue func = jsengine.evaluate(QString("JSON.stringify"));
QJSValueList funcArgs;
funcArgs.append(val);
QJSValue val2 = func.call(funcArgs);
if (val2.isString())
{
result = val2.toString();
}
}
return result;
}

最终结果是上述函数的返回值是一个没有注释的有效 JSON 字符串。 现在，您可以将其馈送到您选择的任何 JSON 解析器中。

示例(使用示例文件(

const char* text = "
{n
// This is a commentn
/* This is a another comment */n
"property1": "It's just json",n
"foo": "bar"n
}";
QString result = stripCommentsOffJSon(QString(text));
std::wcout << L"Result: " << result.toStdWString() << std::endl;

输出：

Result: {"foo":"bar","property1":"It's just json"}

如果您已经是QML应用程序，那么一切顺利。 对于控制台或小部件应用程序，您需要拉入 QML 库。 我将其添加到控制台应用程序的 .pro 文件中：

QT += qml
相关文章：