在 DOM 中嵌入任意 JSON 的最佳实践？

Question

我正在考虑像这样在 DOM 中嵌入任意 JSON：

<script type="application/json" id="stuff">
    {
        "unicorns": "awesome",
        "abc": [1, 2, 3]
    }
</script>

这类似于将任意 HTML 模板存储在 DOM 中以供以后与 JavaScript 模板引擎一起使用的方式。在这种情况下，我们可以稍后检索 JSON 并解析它：

var stuff = JSON.parse(document.getElementById('stuff').innerHTML);

This works，但这是最好的方法吗？这是否违反任何最佳实践或标准？

注意：我不是在寻找将 JSON 存储在 DOM 中的替代方法，我已经确定这是解决我遇到的特定问题的最佳解决方案。我只是在寻找最好的方法。

Answer 1

我认为你原来的方法是最好的。 HTML5 规范甚至解决了这种用途：

"当用于包含数据块（相对于脚本）时，数据 必须内嵌，数据的格式必须使用 type 属性，src 属性不能被指定，并且 脚本元素的内容必须符合要求 为使用的格式定义。”

在这里阅读：http://dev.w3.org/html5/spec/Overview.html#the-script-element

你确实做到了。什么是不爱？无需对属性数据进行字符编码。您可以根据需要对其进行格式化。它具有表现力，预期用途很明确。感觉不像是 hack（例如，使用 CSS 来隐藏你的“载体”元素）。这是完全有效的。

Answer 2

作为一个大方向，我会尝试改用HTML5 data attributes。没有什么可以阻止您输入有效的 JSON。例如：

<div id="mydiv" data-unicorns='{"unicorns":"awesome", "abc":[1,2,3]}' class="hidden"></div>

如果您使用的是 jQuery，那么检索它就像这样简单：

var stuff = JSON.parse($('#mydiv').attr('data-unicorns'));

Answer 3

这种在脚本标签中嵌入 json 的方法存在潜在的安全问题。假设 json 数据来自用户输入，则可以制作一个数据成员，该成员实际上会脱离脚本标签并允许直接注入 dom。见这里：

http://jsfiddle.net/YmhZv/1/

这里是注射

<script type="application/json" id="stuff">
{
    "unicorns": "awesome",
    "abc": [1, 2, 3],
    "badentry": "blah </script><div id='baddiv'>I should not exist.</div><script type="application/json" id='stuff'> ",
}
</script>

转义/编码是没有办法的。

Answer 4

请参阅 OWASP 的 XSS 预防备忘单中的 Rule #3.1。

假设你想在 HTML 中包含这个 JSON：

{
    "html": "<script>alert(\"XSS!\");</script>"
}

在 HTML 中创建一个隐藏的<div>。接下来，通过编码不安全的实体（例如 &、、"、' 和 /）来转义 JSON，并将其放入元素中。

<div id="init_data" style="display:none">
        {&#34;html&#34;:&#34;&lt;script&gt;alert(\&#34;XSS!\&#34;);&lt;/script&gt;&#34;}
</div>

现在您可以通过使用 JavaScript 读取元素的 textContent 并对其进行解析来访问它：

var text = document.querySelector('#init_data').textContent;
var json = JSON.parse(text);
console.log(json); // {html: "<script>alert("XSS!");</script>"}

Answer 5

我建议将 JSON 放入带有函数回调的内联脚本（类似于 JSONP）：

<script>
someCallback({
    "unicorns": "awesome",
    "abc": [1, 2, 3]
});
</script>

如果执行脚本在文档之后加载，您可以将其存储在某处，可能带有附加标识符参数：someCallback("stuff", { ... });

Answer 6

HTML5 包含一个<data> element，用于保存机器可读数据。作为<script type="application/json"> 的替代方案（也许更安全），您可以在该元素的value 属性中包含您的JSON 数据。

const jsonData = document.querySelector('.json-data');
const data = JSON.parse(jsonData.value);

console.log(data)

<data class="json-data" value='
  {
    "unicorns": "awesome",
    "abc": [1, 2, 3],
    "careful": "to escape &#39; quotes"
  }
'></data>

在这种情况下，您需要将所有单引号替换为 ' 或 " 如果您选择用双引号引起来。否则，您的风险XSS 攻击就像其他答案一样建议。

Answer 7

我的建议是将 JSON 数据保存在外部 .json 文件中，然后通过 Ajax 检索这些文件。你不会把 CSS 和 JavaScript 代码放到网页上（内联），那你为什么要用 JSON 呢？