DIV CSS 佈局教程網

用 JavaScript 實作關鍵字高亮顯示
編輯:關於JavaScript     

關鍵字高亮有兩種常見情境:搜尋結果頁把使用者輸入的詞標出來,以及技術文章裡把程式語言關鍵字上色。兩者的核心都是正則替換,但細節差很多。

情境一:標示搜尋關鍵字

function highlight(text, keyword) {
  if (!keyword) return text;
  // 先跳脫正則特殊字元,避免使用者輸入 "." 或 "*" 時出錯
  var safe = keyword.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
  var reg = new RegExp('(' + safe + ')', 'gi');
  return text.replace(reg, '<span class="highlight">$1</span>');
}

三個關鍵點:

第一,一定要跳脫特殊字元。使用者可能搜尋 C++、a.b 或 [test],不處理的話正則會拋錯或比對出錯誤結果。

第二,用 '$1' 而不是 '' + keyword + '' 回填。因為比對是忽略大小寫的,用捕獲組能保留原文的大小寫形態。

第三,替換的目標是 HTML 字串時,必須先對原始文字做 HTML 轉義,否則內容裡的 < 會被當成標籤解析。

情境二:程式碼關鍵字上色

這個版本要把關鍵字列表逐一比對,並避開字串與註解區段:

var KEYWORDS = ['function', 'var', 'return', 'if', 'else', 'for',
                'while', 'new', 'this', 'typeof', 'class', 'const', 'let'];

function highlightCode(code) {
  var html = code
    .replace(/&/g, '&amp;')
    .replace(/</g, '&lt;')
    .replace(/>/g, '&gt;');

  var reg = new RegExp('\\b(' + KEYWORDS.join('|') + ')\\b', 'g');
  return html.replace(reg, '<span class="kw">$1</span>');
}

這裡用 \b 加上字邊界,避免 if 誤配到 shift 裡的 if。樣式只要一行 CSS 就能收尾:

.kw { color: #0070C0; font-weight: bold; }
.highlight { background-color: #ff0; }

一個必須知道的陷阱

上面這種「逐關鍵字 replace」的寫法,在真實程式碼上會出問題:關鍵字若出現在字串字面值或註解裡,一樣會被上色;更糟的是,替換產生的 <span> 標籤本身可能含有關鍵字(例如 class 名稱裡的 kw),造成二次替換而破壞 HTML 結構。

嚴謹的做法是一次掃描、以單一正則分組處理:把「字串」、「註解」、「關鍵字」寫進同一個正則的不同捕獲組,然後在替換回呼中依命中的組別決定如何包裝。這樣每個字元只會被處理一次,也就不會有嵌套替換的問題。

實務上更省力的選擇是直接引入 Prism 或 highlight.js——它們把這套詞法分析的細節都處理好了,而且支援上百種語言。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved