JavaScript中MutationObServer監聽DOM元素詳情
一、基本使用
可以通過MutationObserver建構函式例項化,引數是一個回撥函式。
let observer = new MutationObserver(() => console.log("change")); console.log(observer);
observer物件原型鏈如下:
MutationObserver例項:
可以看到有disconnect
、observer
、takeRecords
方法。
1. observer方法監聽
observer
方法用於關聯DOM
元素,並根據相關設定進行監聽。
語法如下:
// 接收兩個引數 observer(DOM元素,MutationObserverInit物件);
其中:
- 第一個引數DOM元素就是頁面元素,比如:body、div等。
- 第二個引數就是設定要監聽的範圍。比如:屬性、文字、子節點等,是一個鍵值對陣列。
示例1,監聽body元素class的變化:
let observer = new MutationObserver(() => console.log("change")); // 監聽body元素的屬性變化 observer.observe(document.body,{ attributes: true }); // 更改body元素的class,會非同步執行建立MutationObserver物件時傳入的回撥函式 document.body.className = "main"; console.log("修改了body屬性"); // 控制檯輸出: // 修改了body屬性 // change
上面 change
的輸出是在 修改了body
屬性 之後,可見註冊的回撥函式是非同步執行的,是在後面執行的。
2. 回撥函式增加MutationRecord例項陣列引數
現在回撥函式非常簡單,就是輸出一個字串,看不出到底發生了什麼變化。
其實回撥函式接收一個 MutationRecord
例項陣列,實務中可以通過這個檢視詳細的資訊。
let observer = new MutationObserver( // 回撥函式是一個 MutationRecord 例項陣列。格式如下: // [MutationRecord,MutationRecord,...] (mutationRecords) => console.log(mutationRecords) ); observer.observe(document.body,{ attributes: true }); document.body.className = "main"; console.log("修改了body屬性"); // 控制檯輸出: // 修改了body屬性 // (1) [MutationRecord]
其中 mutationRecords資訊 如下:
MutationRecord例項:
其中幾個比較關鍵的資訊:
attributeName
表示修改的屬性名稱target
修改的目標type
型別
如果多次修改body的屬性,那麼會有多條記錄:
// MutationRecord let observer = new MutationObserver( // 回撥函式接收一個 MutationRecord 例項,是一個數組。 (mutationRecords) => console.log(mutationRecords) ); observer.observe(document.body,{ attributes: true }); // 修改三次 document.body.className = "main"; document.body.className = "container"; document.body.className = "box"; // 控制檯列印如下: // (3) [MutationRecord,MutationRecord]
注意:
這裡不是修改一次就執行一次回撥,而是每修改一次就往 mutationRecords 引數加入一個 MutationRecord 例項,最後執行一次回撥打印出來。
如果修改一次就執行一次回撥,那麼效能就會比較差。
3. disconnect方法終止回撥
如果要終止回撥,可以使用disconnect方法。
let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); observer.observe(document.body,{ attributes: true }); // 第一次修改 document.body.className = "main"; // 終止 observer.disconnect(); // 第二次修改 document.body.className = "container"; // 沒有日誌輸出
這裡沒有日誌輸出,包括第一次修改也沒有日誌輸出,因為回撥函式的執行是非同步的,是在最後執行的。後面把observer
終止了,所以就不會執行了。
可以用setTimeout控制最後才終止,這樣回撥就會正常執行。
let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); observer.observe(document.body,{ attributes: true }); // 第一次修改 document.body.className = "main"; // 終止 setTimeout(() => { observer.disconnect(); // 第三次修改,下面修改不會回調了 document.body.className = "container"; },0); // 第二次修改 document.body.className = "container"; // 頁面輸出: // (2) [MutationRecord,MutationRecord]
終止之後再啟用
終止了之後可以再次啟動,請看下面示例:
let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); observer.observe(document.body,{ attributes: true }); // 第一次修改,會入 mutationRecords 陣列 document.body.className = "main"; // 終止 setTimeout(() => { observer.disconnect(); // 第二次修改,因為終止了,下面修改不會入 mutationRecords 陣列 document.body.className = "container"; },0); setTimeout(() => { // 再次啟用 observer.observe(document.body,{ attributes: true }); // 修改body屬性,會入 mutationRecords 陣列 document.body.className = "container"; },0); // 控制檯輸出: // [MutationRecord] // [MutationRecord]
這邊回撥函式是執行了兩次,列印了兩個,其中:
- 第一個輸出是在第一次修改,後面沒有同步程式碼了,就執行了回撥。
- 第二個輸出是在第三次修改,因為重新啟用了,所以就正常執行了回撥。
第二次修改,因為observer
被終止了,所以修改body
的屬性不會入 mutationRecords
陣列。
4. takeRecords方法獲取修改記錄
如果希望在終止observer
之前,對已有的 mutationRecords
記錄進行處理,可以用takeRecords
方法獲取。
let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); observer.observe(document.body,{ attributes: true }); // 第一次修改,會入 mutationRecords 陣列 document.body.className = "main"; // 第二次修改,會入 mutationRecords 陣列 document.body.className = "container"; // 第三次修改,會入 mutationRecords 陣列 document.body.className = "box"; // 取到修改記錄,可以對其進行處理 let mutationRecords = observer.takeRecords(); console.log(mutationRecords); // 控制檯列印: // (3) [MutationRecord,MutationRecord] console.log(observer.takeRecords()); // 控制檯列印: // [] // 終止 observer.disconnect();
二、監聽多個元素
上面監聽都是隻有一個元素,如果要監聽多個元素可以複用MutationObserver
例項
let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); // 建立 div1 元素,並監聽 let div1 = document.http://www.cppcns.comcreateElement("div"); observer.observe(div1,{ attributes: true }); div1.id = "box1"; // 建立div2並監聽 let div2 = document.createElement("div"); observer.observe(div2,{ attributes: true }); div2.id = "box2"; // 控制檯列印: // (2) [MutationRecord,MutationRecord]
控制檯列印了兩個MutationRecord,其中:
- 第一個
MutationRecord
就是 div1 的id屬性修改記錄。 - 第二個
MutationRecord
就是 div2 的id屬性修改記錄。
其他使用方式和上面的類似。
三、監聽範圍MutationObserverInit物件
上面的監聽都是監聽屬性,當然也可以監聽其他的東西,比如:文字、子節點等。
1. 觀察屬性
上面的例子都是觀察元素自有的屬性,這裡再舉一個自定義屬性的例子。
let observer = new MutationObserver( (mutationRecords) => console.logwww.cppcns.com(mutationRecords) ); observer.observe(document.body,{ attributes: true }); // 修改自定義的屬性 document.body.setAttribute("data-id",1); // 控制檯列印: // [MutationRecord]
修改自定義的屬性一樣會加入到 mutationRecords
陣列。
另外值的一提的是 data-id
經常用來給元素標記一些資料啥的,如果發生變化,程式就可以監聽到,就可以處理一些相應的邏輯。
attributeFilter過濾:
如果要監聽指定的屬性變化,可以用 attributeFilter
過濾。
let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); observer.observe(document.body,{ attributes: true,// 設定白名單 attributeFilter: ["data-id"] }); // 修改白名單 attributeFilter 內的屬性,會入 mutationRecords docume客棧nt.body.setAttribute("data-id",1); // 修改不在白名單 attributeFilter 內的屬性,不會入 mutationRecords document.body.setAttribute("class","main"); // 控制檯列印: // [MutationRecord]
attributeOldValue記錄舊值:
如果要記錄舊值,可以設定 attributeOldValue
為true
。
let observer = new MutationObserver( // MutationRecord物件中oldValue表示舊值 (mutationRecords) => console.log(mutationRecords.map((x) => x.oldValue)) ); observer.observe(document.body,attributeOldValue: true,}); // 第一次修改,因為原來沒有值,所以舊值 oldValue = null document.body.setAttribute("class","main"); // 第二次修改,因為前面有改了一次,所以舊值 oldValue = main document.body.setAttribute("class","container"); // 控制檯列印: // (2) [null,'main']
2. 觀察文字
觀察文字設定 characterData
為 true
即可,不過只能觀察文字節點。
請看如下示例:
<!-- 一個性感的div --> <div id="box">Hello</div> <script type="text/"> let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); // 獲取文字節點 let textNode = document.getElementById("box").childNodes[0]; observer.observe(textNode,{ // 觀察文字變化 characterData: true }); // 修改文字 textNode.textContent = "Hi"; // 控制檯列印: // [MutationRecord] </script>
如果直接監聽div元素,那麼是不生效的:
<!-- 一個性感的div --> <div id="box">Hello</div> <script type="text/script"> let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); // 監聽div不會生效 let box = document.getElementById("box"); observer.observe(box,{ characterData: true }); box.textContent = "Hi"; // 控制檯無輸出 </script>
characterDataOldValue記錄舊值:
如果要記錄文字舊值,可以設定 characterDataOldValue
為true
。
<!-- 一個性感的div --> <div id="box">Hello</div> <script type="text/javascript"> let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords.map((x) => x.oldValue)) ); // 獲取文字節點 let textNode = document.getElementById("box").childNodes[0]; observer.observe(textNode,{ // 觀察文字變化 characterData: true,// 保留舊資料 characterDataOldValue: true,}); // 修改文字兩次 textNode.textContent = "Hi"; textNode.textContent = "Nice"; // 控制檯列印: // (2) ['Hello','Hi'] </script>
因為div內的內容原本為Hello,先修改為Hi,又修改為Nice,所以兩次修改的舊值就為:Hello 和 Hi 了。
3. 觀察子節點
MutationObserver
例項也可以觀察目標節點子節點的變化。
<!-- 一個性感的div -->
<div id="box">Hello</div>
<script type="text/javascript">
let observer = new MutationObserver(
(mutationRecords) => console.log(mutationRecords)
);
// 獲取div
let box = document.getElementById("box");
observer.observe(box,{
// 觀察子節點變化
childList: true,});
// 新增元素
let span = document.createElement("span")
span.textContent = "world";
box.appendChild(span);
// 控制檯列印:
// [MutationRecord]
</scripthttp://www.cppcns.com>
MutationRecord
中的addedNodes
屬性記錄了增加的節點。
移除節點:
<!-- 一個性感的div --> <div id="box">Hello</div> <script type="text/javascript"> let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); // 獲取div let box = document.getElementById("box"); observer.observe(box,}); // 移除第一個子節點,就是Hello文字節點 box.removeChild(box.childNodes[0]); // 控制檯列印: // [MutationRecord] </script>
MutationRecord
中的removedNodes
屬性記錄了移除的節點。
移動節點:
對於已有的節點進行移動,那麼會記錄兩條MutationRecord
記錄,因為移動現有的節點是先刪除,後新增。
<!-- 一個性感的div --> <div id="box">Hello<span>world</span></div> <script type="text/javascript"> let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); // 獲取div let box = document.getElementById("box"); observer.observe(box,}); // 將span節點移動到Hello節點前面 box.insertBefore(box.childNodes[1],box.childNodes[0]); // 移動節點,實際是先刪除,後新增。 // 控制檯列印: // (2) [MutationRecord,MutationRecord] </script>
4. 觀察子樹
上面觀察的節點都是當前設定的目標節點,比如body
,就只能觀察body
元素和其子節點的變化。
如果要觀察body
及其所有後代節點的變化,那麼可以設定subtree
屬性為true
。
<!-- 一個性感的div --> <div id="box">Hello<span>world</span></div> <script type="text/javascript"> let observer = new MutationObserver( (mutationRecords) => console.log(mutationRecords) ); let box = document.getElementById("box"); observer.observe(box,{ attributes: true,// 觀察子樹的變化 subtree: true }); // span元素的id屬性變化就可以觀察到 box.childNodes[1].id = "text"; // 控制檯列印: // [MutationRecord] </script>
subtree
設定為true
後,不光div元素本身,span
元素也可以觀察到了。
總結:
- 1.
MutationObserver
例項可以用來觀察物件。 - 2.
MutationRecord
例項記錄了每一次的變化。 - 3. 回撥函式需要所有任務完成後,才會執行,即採用非同步方式。
- 4. 可以觀察的訪問有屬性、文字、子節點、子樹。
到此這篇關於JavaScript
中MutationObServer
監聽DOM元素詳情的文章就介紹到這了,更多相關JavaScript中MutationObServer監聽DOM元素內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!