DIV CSS 佈局教程網

getElementsByClassName 用法解析與相容性自訂實作
編輯:關於JavaScript     

getElementsByClassName() 是 HTML5 新增的 DOM 查詢 API,能大幅簡化「依 class 名稱挑選元素」這件事。不過它並非所有環境都有,本文說明用法,並提供幾種自製的相容方案。

基本用法

這個方法只接受一個字串參數,回傳一個包含所有符合元素的 NodeList:

var el = document.getElementsByClassName('foo');

若要同時匹配多個 class,以空格分隔即可。以下程式會挑出「同時擁有 foo 與 bar」的元素:

var el = document.getElementsByClassName('foo bar');

要注意的是,IE8 及以下版本並不支援這個方法。早年開發者若想觸發 DOM Ready 後的初始化,往往得自己寫一套遍歷工具,而 jQuery 之所以流行,很大一部分原因就是免去了這類麻煩。

自製相容寫法(單一 class)

function getElementsByClassName (className) {
  var all = document.all ? document.all : document.getElementsByTagName('*');
  var elements = new Array();
  for (var e = 0; e < all.length; e++) {
    if (all[e].className == className) {
      elements[elements.length] = all[e];
      break;
    }
  }
  return elements;
}

這版本有個明顯的瑕疵:break 會讓迴圈在找到第一個符合項後就結束,因此只會回傳一個元素,並不符合方法名稱的語意。實務上應移除該 break。

可指定搜尋範圍的版本

function getElementsByClassName(className, parent){
  var oParent = parent ? document.getElementById(parent) : document;
  var oLis = oParent.getElementsByTagName("*");
  var arr = [];
  for (var i = 0; i < oLis.length; i++){
    if (oLis[i].className == className){
      arr.push(oLis[i]);
    }
  }
  return arr;
}

加上 parent 參數後,就能把搜尋限定在某個容器內,對於大型頁面而言能有效減少遍歷成本。

處理多 class 的寫法

當元素寫成 class="test1 test2 test3" 時,直接比對整個 className 字串就會失效,必須先拆開:

function getElementsByClassName (className) {
  var all = document.all ? document.all : document.getElementsByTagName('*');
  var elements = new Array();
  for (var e = 0; e < all.length; e++) {
    var classList = all[e].className.split(" ");
    for (var i = 0; i < classList.length; i++){
      if (classList[i] == className) {
        elements[elements.length] = all[e];
        break;
      }
    }
  }
  return elements;
}

完整測試範例

<!DOCTYPE html>
<html>
<head>
<meta charset='UTF-8' />
<script>
window.onload = function(){
  var adom = document.getElementsByClassName('a1');
  for(var i = 0; i < adom.length; i++) adom[i].style.backgroundColor = "red";
};
function getElementByClassName(className){
  var elems = [];
  if(!document.getElementsByClassName){
    alert("no exit");
    var dom = document.getElementsByTagName('*');
    for(var i = 0; i < dom.length; i++){
      if(dom[i].className == className) elems.push(dom[i]);
    }
  } else {
    elems = document.getElementsByClassName(className);
    alert('exit');
  }
  return elems;
}
</script>
</head>
<body>
<div id="a1">a1</div>
<div class="a1">a1</div>
<div class="a1">a1</div>
<div id="a1">a1</div>
<div class="a1">a1</div>
</body>
</html>

執行後可以看到,只有帶有 class="a1" 的三個 div 被染成紅色,帶 id 的兩個不受影響——這也順帶說明了 class 選擇器與 id 選擇器的本質差異。

執行結果:

結語

在支援的瀏覽器中,直接呼叫原生 getElementsByClassName 永遠是最快也最準確的選擇;只有在需要向下相容舊版 IE 時,才有必要退回自製的遍歷寫法。而若是新專案,直接用 querySelectorAll('.foo') 會是更一致、更簡潔的作法。

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