HOWTO · JavaScript

使用 JavaScript 解碼 HTML 實體

在本文中,我們將瞭解如何使用 JavaScript 解碼 HTML 實體。

本頁內容

若要解碼字串中的 HTML 實體,程式在瀏覽器中執行時可使用瀏覽器的 textarea 元素;在 Node.js 專案中則可使用 he 套件。這兩種方法都能將 &nbsp;、&#39; 和 &amp; 等字元參照轉換成對應字元。範例輸入也包含原本就存在的 <h2> 和 <br> 標籤;解碼實體不會移除這些標籤。

使用 Vanilla JavaScript 解碼 HTML 實體

瀏覽器的 textarea 可以解碼字元參照,但它的 innerHTML 設定器會解析 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, '&lt;');
  return textarea.value;
}

const input = "Give&nbsp;us some&#39;<h2>time</h2>&#39; &amp; space <br> Please";
document.querySelector('#source').value = input;
document.querySelector('#result').textContent = decodeEntities(input);
</script>

逐一跳脫原本就存在的 <,可避免輸入內容提供 textarea 結束標籤或其他元素標記給解析器。&lt; 等編碼參照仍會解碼,但產生的 < 會成為 textarea 值中的文字,不會再次被解析為標記。指定給 textContent 也會將解碼後的 <h2> 和 <br> 字元顯示為文字。若之後要將解碼結果以 HTML 呈現,請在該呈現步驟另外套用適當的 HTML 消毒政策。

對於只處理以分號結尾的十進位數值字元參照的簡短 Node.js 範例,可以使用 String.fromCodePoint() 轉換 JavaScript 接受的每個比對值。這個輔助函式不會套用 HTML 的數值字元參照規則:&#0; 會變成 U+0000,&#55296; 會變成孤立代理字元 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&#39; us time"));
Give' us time

使用 he 函式庫解碼 HTML 實體

在 Node.js 中,請使用 npm install he 安裝 he 套件,再以 const he = require('he'); 載入套件,並透過 he.decode(input) 解碼字串。he 支援具名與數值 HTML 字元參照;當輸入可能包含多種實體時,它比手動列出替換項目更合適。請確認套件目前要求的 Node.js 引擎版本符合你的專案版本,不要假設所有版本都受支援。

decode() 函式的第一個引數是必要的 HTML 字串。第二個引數則是選用的選項物件;isAttributeValue 和 strict 等屬性是該物件中的布林設定,不是可以直接傳入的獨立值。一般文字不需要選項,直接呼叫 he.decode(input) 即可。使用上方的範例輸入時,解碼後的字串為 Give us some'<h2>time</h2>' & space <br> Please(「Give」後方的空格是不換行空格)。

如果程式已在瀏覽器中執行,請選用 textarea 方法;若使用 Node.js,或需要可獨立使用且支援多種實體的解碼器,請選用 he。解碼會轉換字元參照,但不會移除範例中原本就存在的標籤。請將解碼與安全呈現視為不同步驟。