DIV CSS 佈局教程網

用 JS 為文章中的關鍵字上色:單一關鍵字、多關鍵字與安全做法
編輯:JavaScript綜合知識     

需求很單純:文章是靜態頁面,關鍵字清單卻隨時會變,所以不適合在產出時寫死,改由前端 JavaScript 在執行時把關鍵字標亮起來。

最直觀的作法:字串 replace

<script>
txt.innerHTML = txt.innerHTML.replace(/文章/gi, "<font color=red>文章");
</script>

用正則的 g(全域)與 i(忽略大小寫)旗標,把文中所有「文章」前面插入一個紅色標籤。寫法短,但問題不少:它沒有關上 <font>,而且直接對 innerHTML 做字串替換,很容易破壞既有的 HTML 結構。

多關鍵字版本

<script>
txt.innerHTML = txt.innerHTML.replace(/(文章)|(關鍵字)|(功能)/gi,
    "<font color=red>$1$2$3");
</script>

用 | 串起多個關鍵字,並用 $1$2$3 把「實際命中的那一個」原封不動填回去。這裡的替換字元意義如下:

  • $$:一個 $ 符號
  • $&:整個匹配到的內容
  • $`:匹配之前的字串部分
  • $':匹配之後的字串部分
  • $n:第 n 個捕獲群組(n 為 1–9)
  • $nn:第 nn 個捕獲群組(01–99)

旗標方面,g 代表全域匹配,i 代表忽略大小寫。

更聰明的思路:從文字節點下手

與其對整段 HTML 做字串替換,不如只處理純文字的部分。早期 IE 可以用 TextRange 達成:

<script>
function highlight(key) {
    var key = key.split('|');
    for (var i = 0; i < key.length; i++) {
        var rng = document.body.createTextRange();
        while (rng.findText(key[i])) {
            rng.pasteHTML(rng.text.fontcolor('red'));
        }
    }
}
highlight('文章|關鍵|功能');
</script>

它只針對文字內容操作,因此不會誤傷標籤屬性。但 createTextRange 是 IE 專屬 API,且 findText 在迴圈中若未推進游標,會造成無窮迴圈——這段程式實際上就有這個風險。

跨瀏覽器的安全實作

用 TreeWalker 走訪所有文字節點,只在文字層級做替換:

function highlightKeywords(container, keywords) {
    var walker = document.createTreeWalker(container, NodeFilter.SHOW_TEXT, null, false);
    var nodes = [];
    while (walker.nextNode()) nodes.push(walker.currentNode);

    var pattern = new RegExp('(' + keywords.join('|') + ')', 'gi');

    nodes.forEach(function (node) {
        if (!pattern.test(node.nodeValue)) return;
        pattern.lastIndex = 0;

        var frag = document.createDocumentFragment();
        var last = 0, match;
        while ((match = pattern.exec(node.nodeValue)) !== null) {
            frag.appendChild(document.createTextNode(
                node.nodeValue.slice(last, match.index)));
            var mark = document.createElement('mark');
            mark.textContent = match[0];
            frag.appendChild(mark);
            last = match.index + match[0].length;
        }
        frag.appendChild(document.createTextNode(node.nodeValue.slice(last)));
        node.parentNode.replaceChild(frag, node);
    });
}

這版的關鍵設計:

  • 用 mark 元素而非 <font>,語意正確,樣式交給 CSS。
  • 用 textContent 而非 innerHTML 插入關鍵字,不可能產生 XSS。
  • 先把文字節點收集成陣列再處理,避免在走訪途中修改 DOM 造成指標錯亂。
  • 用 DocumentFragment 批次插入,只觸發一次 DOM 更新。

幾個實務陷阱

  • 永遠不要把關鍵字用 innerHTML 塞回去。若關鍵字清單來自後台設定或使用者輸入,直接拼接 HTML 就是 XSS 漏洞。
  • 跳過 script、style、可輸入元素的內容。否則會把程式碼或使用者輸入的內容也上色,甚至破壞功能。
  • 關鍵字之間若有包含關係,要先長後短排序。例如同時有「JavaScript」與「Java」,若先處理短的,「JavaScript」會被拆成兩段。
  • 關鍵字需跳脫正則特殊字元。像 C++、.NET 這類含 +、. 的名稱,必須先跳脫再組進 RegExp。
  • 靜態頁面若關鍵字更新頻繁,可考慮把清單放在外部 JS 檔,或用 fetch 於頁面載入後取得,避免修改每個 HTML 檔。
XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved