網頁開發中,我們經常需要操作相同類名的元素。一道常見的面試題就是:如何用JavaScript取得頁面中所有class為test的節點。本文整理兩種經典方案。
HTML5 DOM新增了getElementsByClassName方法,讓我們能透過class中的類名來訪問元素。它與getElementsByTagName類似,只接受一個表示類名的參數,回傳一個包含所有該類名元素的數組:
document.getElementsByClassName("sale")
它還能查找帶有多個類名的元素,只要在字符串參數中用空格分隔類名即可:
alert(document.getElementsByClassName("sale important").length);
完整示例:
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Shopping List</title>
</head>
<body>
<h1>What to buy</h1>
<p title="a gentle reminder">Don't forget to buy this stuff.</p>
<ul id="purchase">
<li>A tin of beans</li>
<li class="sale">Cheese</li>
<li class="sale important">Milk</li>
</ul>
<script>
alert(document.getElementsByClassName("sale important").length);
</script>
</body>
</html>
你會看到彈出1,因為只有一個元素同時帶有important和sale類名。值得注意的是,即使元素class屬性中類名的順序是「sale important」,而參數指定的是「important sale」,也照樣匹配;元素帶有更多類名也無妨。它同樣能與getElementById組合使用,先定位到特定物件再調用:
var shopping = document.getElementById("purchase");
var sales = shopping.getElementsByClassName("sale");
alert(sales.length); // 2
遺憾的是,這個方法只有較新的瀏覽器(Safari 3.1、Chrome、Firefox 3、Opera 9.5以上)才支援。
為了相容老舊瀏覽器,DOM腳本程式設計師需要自己實現一個getElementsByClassName。Jeremy Keith在《JavaScript DOM編程藝術》中提到的做法如下:
function getElementsByClassName(node, classname){
if(node.getElementsByClassName){
return node.getElementsByClassName(classname);
} else {
var results = [];
var elems = node.getElementsByTagName("*");
for(var i = 0; i < elems.length; i++){
if(elems[i].className.indexOf(classname) != -1){
results[results.length] = elems[i];
}
}
return results;
}
}
它接受兩個參數:node表示DOM樹中的搜索起點,classname是要搜索的類名。若傳入節點已存在原生的getElementsByClassName就直接回傳,否則遍歷所有標籤查找帶相應類名的元素。它的缺點是不支援多個類名。用法示例:
var shopping = document.getElementById("purchase");
var sales = getElementsByClassName(shopping, "test");
console.log(sales);
搜尋匹配DOM元素的方法很多,但真正高效的卻不多。2008年,Robert Nyman在《The Ultimate GetElementsByClassName》中提供了更強大的方案,相比前者新增了幾個能力:
1. 若瀏覽器支援原生getElementsByClassName則優先調用;
2. 若支援則使用XPath(一種定位XML文件的強大方式,但瀏覽器支援不一致);
3. 支援多個類名的搜索,不計先後順序;
4. 回傳真正的節點數組,而非原生的NodeList。
關於NodeList轉數組,可以用:
myList = Array.prototype.slice.call(myNodeList);
Robert的完整實現如下:
var getElementsByClassName = function (className, tag, elm){
if (document.getElementsByClassName) {
getElementsByClassName = function (className, tag, elm) {
elm = elm || document;
var elements = elm.getElementsByClassName(className),
nodeName = (tag)? new RegExp("\b" + tag + "\b", "i") : null,
returnElements = [],
current;
for(var i=0, il=elements.length; i<il; i+=1){
current = elements[i];
if(!nodeName || nodeName.test(current.nodeName)) {
returnElements.push(current);
}
}
return returnElements;
};
}
else if (document.evaluate) {
getElementsByClassName = function (className, tag, elm) {
tag = tag || "*";
elm = elm || document;
var classes = className.split(" "),
classesToCheck = "",
xhtmlNamespace = "https://www.w3.org/1999/xhtml",
namespaceResolver = (document.documentElement.namespaceURI === xhtmlNamespace)? xhtmlNamespace : null,
returnElements = [], elements, node;
for(var j=0, jl=classes.length; j<jl; j+=1){
classesToCheck += "[contains(concat(' ', @class, ' '), ' " + classes[j] + " ')]";
}
try {
elements = document.evaluate(".//" + tag + classesToCheck, elm, namespaceResolver, 0, null);
} catch (e) {
elements = document.evaluate(".//" + tag + classesToCheck, elm, null, 0, null);
}
while ((node = elements.iterateNext())) {
returnElements.push(node);
}
return returnElements;
};
}
else {
getElementsByClassName = function (className, tag, elm) {
tag = tag || "*";
elm = elm || document;
var classes = className.split(" "),
classesToCheck = [],
elements = (tag === "*" && elm.all)? elm.all : elm.getElementsByTagName(tag),
current, returnElements = [], match;
for(var k=0, kl=classes.length; k<kl; k+=1){
classesToCheck.push(new RegExp("(^|\s)" + classes[k] + "(\s|$)"));
}
for(var l=0, ll=elements.length; l<ll; l+=1){
current = elements[l];
match = false;
for(var m=0, ml=classesToCheck.length; m<ml; m+=1){
match = classesToCheck[m].test(current.className);
if (!match) { break; }
}
if (match) { returnElements.push(current); }
}
return returnElements;
};
}
return getElementsByClassName(className, tag, elm);
};
這套方案按瀏覽器能力分三層降級:有原生方法就用原生,其次用XPath,最後退回遍歷正則匹配,兼顧了效能與相容性,是處理多類名查詢時值得借鑑的成熟實現。