DIV CSS 佈局教程網

用原生 JavaScript 實作關鍵字高亮
編輯:JavaScript基礎知識     

所謂高亮,指的是把頁面中指定區域內的指定文字加上背景著色,讓它從大量內容裡跳出來。搜尋結果頁最常需要這個效果:使用者搜了什麼,就該在結果裡被標出來。

下面提供一種以原生 JavaScript 實作的解法,做法核心是「遞迴走訪 DOM 節點,只處理文字節點,命中後替換成帶樣式的 span 或 a」。

步驟一:引入高亮函式

先在 <head> 中放入以下程式碼:

<script type="text/javascript">
//<![CDATA[
//--------begin function fHl(o, flag, rndColor, url)------------------//
function fHl(o, flag, rndColor, url){
  /// <summary>
  ///   使用 javascript HTML DOM 高亮顯示頁面特定字詞.
  ///   實例:
  ///     fHl(document.body, '紙傘|她');
  ///     這裡的 body 是指高亮 body 裡面的內容。
  ///     fHl(document.body, '希望|愁怨', false, '/');
  ///     fHl(document.getElementById('at_main'), '獨自|飄過|悠長', true, 'search.asp?keyword=');
  ///     這裡的'at_main'是指高亮 id='at_main' 的 div 裡面的內容。
  ///     search.asp?keyword= 指給關鍵字加的連結地址。
  /// </summary>
  /// <param name="o" type="Object"> 對象, 要進行高亮顯示的對象. </param>
  /// <param name="flag" type="String"> 字符串, 要進行高亮的詞或多個詞, 使用豎槓(|)分隔. </param>
  /// <param name="rndColor" type="Boolean"> 是否隨機顯示背景色與文字色, true 表示隨機. </param>
  /// <param name="url" type="String"> 是否對高亮的詞添加連結. </param>
  var bgCor=fgCor='';
  if(rndColor){
    bgCor=fRndCor(10, 20);
    fgCor=fRndCor(230, 255);
  } else {
    bgCor='#F0F';
    fgCor='black';
  }
  var re=new RegExp(flag, 'i');
  for(var i=0; i<o.childNodes.length; i++){
    var o_=o.childNodes[i];
    var o_p=o_.parentNode;
    if(o_.nodeType==1) {
      fHl(o_, flag, rndColor, url);           // 元素節點:遞迴深入
    } else if (o_.nodeType==3) {              // 文字節點:嘗試比對
      if(!(o_p.nodeName=='A')){               // 跳過連結內的文字,避免巢狀破壞結構
        if(o_.data.search(re)==-1)continue;
        var temp=fEleA(o_.data, flag);
        o_p.replaceChild(temp, o_);
      }
    }
  }
  //------------------------------------------------
  function fEleA(text, flag){
    var style=' style="background-color:'+bgCor+';color:'+fgCor+';" '
    var o=document.createElement('span');
    var str='';
    var re=new RegExp('('+flag+')', 'gi');
    if(url){
      str=text.replace(re, '<a href="'+url+
        '$1"'+style+'>$1</a>');   // 給關鍵字加連結,$1 為比對到的字
    } else {
      str=text.replace(re, '<span '+style+'>$1</span>');  // 不加連結時的顯示
    }
    o.innerHTML=str;
    return o;
  }
  //------------------------------------------------
  function fRndCor(under, over){
    if(arguments.length==1){
      var over=under;
      under=0;
    }else if(arguments.length==0){
      var under=0;
      var over=255;
    }
    var r=fRandomBy(under, over).toString(16);
    r=padNum(r, r, 2);
    var g=fRandomBy(under, over).toString(16);
    g=padNum(g, g, 2);
    var b=fRandomBy(under, over).toString(16);
    b=padNum(b, b, 2);
    return '#'+r+g+b;

    function fRandomBy(under, over){
      switch(arguments.length){
        case 1: return parseInt(Math.random()*under+1);
        case 2: return parseInt(Math.random()*(over-under+1) + under);
        default: return 0;
      }
    }
    function padNum(str, num, len){
      var temp=''
      for(var i=0; i<len;temp+=num, i++);
      return temp=(temp+=str).substr(temp.length-len);
    }
  }
}
//--------end function fHl(o, flag, rndColor, url)--------------------//
//]]>
</script>

四個參數的意義如下:o 是要處理的 DOM 節點,flag 是以豎線分隔的關鍵字群,rndColor 決定是否隨機配色,url 則是關鍵字要指向的連結前綴。

步驟二:在頁面尾端呼叫

<script type="text/javascript">
fHl(document.body, '高亮');   // 對 body 區域中的「高亮」文字上色
</script>

實作原理拆解

這段程式碼的關鍵在於三個判斷:

  • nodeType == 1 代表元素節點,直接遞迴深入其子節點,這樣才能覆蓋巢狀結構。
  • nodeType == 3 代表文字節點,是唯一真正需要處理的對象。為什麼不直接對 innerHTML 做全字串取代?因為那樣會把標籤屬性、class 名稱一起換掉,把 HTML 結構弄壞。只處理文字節點是安全做法。
  • 父節點不是 A 時才處理,避免在連結內部再塞連結,產生非法的巢狀結構。

另外,fRndCor 刻意讓背景色落在低數值區間(10–20)、文字色落在高數值區間(230–255),這樣隨機產生的配色永遠維持高對比,不會出現「背景與文字同色」的尷尬情況。這個細節比隨機本身更重要。

可以怎麼改進

如果要在正式專案中使用,有幾個方向值得調整:把 innerHTML 組字串的做法改成 document.createTextNode 加 document.createElement 的節點操作,可以避開 XSS 風險(關鍵字若來自使用者輸入,直接寫進 innerHTML 是危險的);替換後跳過已處理的節點,避免重複呼叫時把先前的 span 再包一層;若要處理中文,記得加上 use strict 並留意 RegExp 對全形字元的處理。

整體來說,這個思路簡單可靠:遞迴走訪、只碰文字節點、命中即替換。理解它之後,實作程式碼行號高亮、敏感詞遮蔽、內容自動連結化,都是同一套骨架的變形。

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