HOWTO · JavaScript
使用 JavaScript 解码 HTML 实体
在本文中,我们将了解如何使用 JavaScript 解码 HTML 实体。
本页内容
在浏览器中运行的代码可使用浏览器的 textarea 元素解码字符串中的 HTML 实体;在 Node.js 项目中则可使用 he 套件。这两种方法都会将 、' 和 & 等字符引用转换为对应字符。示例输入还包含字面的 <h2> 和 <br> 标签;解码实体不会移除这些标签。
使用 Vanilla JavaScript 解码 HTML 实体
浏览器中的 textarea 可以解码字符引用,但它的 innerHTML setter 会解析 HTML 语法。将不可信输入赋给它之前,先转义字面的左尖括号,避免类似 </textarea><img src=x onerror=alert(1)> 的字符串关闭解析上下文或创建元素。字符引用仍会被解码,而字面的标签文本仍会作为文本处理。此方法需要 document,因此只能在浏览器中运行,不能直接在 Node.js 中运行。
下面是一个完整的浏览器页面。将示例字符串替换为需要解码的值即可。函数会在解析前转义字面的 < 字符,然后页面使用 textContent 显示函数返回的值。
<!doctype html>
<meta charset="utf-8">
<textarea id="source"></textarea>
<pre id="result"></pre>
<script>
function decodeEntities(input) {
const textarea = document.createElement('textarea');
textarea.innerHTML = input.replace(/</g, '<');
return textarea.value;
}
const input = "Give us some'<h2>time</h2>' & space <br> Please";
document.querySelector('#source').value = input;
document.querySelector('#result').textContent = decodeEntities(input);
</script>
逐个转义字面的 <,可以防止输入向解析器提供 textarea 结束标签或其他元素标记。< 等编码字符引用仍会被解码,但得到的 < 在 textarea 的值中仍是文本,不会再次作为标记解析。赋给 textContent 的内容也会将解码后的 <h2> 和 <br> 字符显示为文本。如果之后要将解码后的数据作为 HTML 渲染,请在那个单独的渲染步骤中应用适当的 HTML 清理策略。
对于一个只处理以分号结尾的十进制数字字符引用的简短 Node.js 示例,可以使用 String.fromCodePoint() 转换 JavaScript 接受的匹配值。这个辅助函数不会应用 HTML 的数字字符引用规则:� 会变成 U+0000,� 会变成孤立代理项 U+D800;而 HTML 解析器会将两者都替换为 U+FFFD。该函数也不会验证格式错误或超出范围的引用,超出范围的值可能导致 String.fromCodePoint() 抛出 RangeError。没有分号的引用会保持原样。这只是一个范围有限的示例,并非完整的 HTML 实体解码器;要处理更广泛的实体语法,请使用上面的浏览器方法或下面的 he 套件。
运行此示例:
function decodeDecimalReferences(input) {
return input.replace(/&#(\d+);/g, (_, digits) =>
String.fromCodePoint(Number(digits))
);
}
console.log(decodeDecimalReferences("Give' us time"));
Give' us time
使用 he 库解码 HTML 实体
在 Node.js 中,使用 npm install he 安装 he 套件,然后通过 const he = require('he'); 加载它,并使用 he.decode(input) 解码字符串。he 支持命名和数字形式的 HTML 字符引用;当输入可能包含各种实体时,它比手写替换列表更合适。请根据项目所用的 Node.js 版本检查该套件当前要求的 Node.js 引擎版本,不要假设所有版本都受支持。
decode() 函数的第一个参数是必需的 HTML 字符串。可选的第二个参数是选项对象;isAttributeValue 和 strict 等属性是该对象中的布尔设置,不应作为独立参数直接传入。处理普通文本时,直接调用 he.decode(input),无需传入选项。使用上面的示例输入,解码后的字符串为 Give us some'<h2>time</h2>' & space <br> Please(“Give”后面的空格是不换行空格)。
已经在浏览器中运行的代码可选择 textarea 方法;Node.js 项目,或需要独立且支持多种实体的解码器时,可选择 he。解码会转换字符引用,但不会移除示例中的字面标签。请将解码与安全渲染分开处理。