检测DOM中的更改

我想在一些div或输入添加到html时执行一个函数。 这可能吗?< / p >

例如,添加了一个文本输入,然后应该调用函数。

416937 次浏览

2015年更新,新的MutationObserver被现代浏览器支持:

Chrome 18+, Firefox 14+, IE 11+, Safari 6+

如果你需要支持旧的方法,你可以尝试使用其他方法,比如下面这个5(!)年的答案中提到的方法。那里有龙。享受:)


其他人正在更改文档?因为如果你可以完全控制这些变化,你只需要创建你自己的domChanged API——用一个函数或自定义事件——并在你修改东西的地方触发/调用它。

DOM Level-2有突变事件类型,但旧版本的IE不支持它。注意,突变事件是在DOM3事件规范中已弃用,并有一个性能损失

您可以尝试用IE中的onpropertychange模拟突变事件(如果它们都不可用,则退回到蛮力方法)。

对于完整的 domChange, interval可能是一个过度kill。假设您需要存储整个文档的当前状态,并检查每个元素的每个属性是否相同。

也许如果你只对元素及其顺序感兴趣(正如你在问题中提到的),getElementsByTagName("*")可以工作。如果您添加一个元素,删除一个元素,替换元素或更改文档的结构,这将自动触发。

我写了一个概念证明:

(function (window) {
var last = +new Date();
var delay = 100; // default delay


// Manage event queue
var stack = [];


function callback() {
var now = +new Date();
if (now - last > delay) {
for (var i = 0; i < stack.length; i++) {
stack[i]();
}
last = now;
}
}


// Public interface
var onDomChange = function (fn, newdelay) {
if (newdelay) delay = newdelay;
stack.push(fn);
};


// Naive approach for compatibility
function naive() {


var last = document.getElementsByTagName('*');
var lastlen = last.length;
var timer = setTimeout(function check() {


// get current state of the document
var current = document.getElementsByTagName('*');
var len = current.length;


// if the length is different
// it's fairly obvious
if (len != lastlen) {
// just make sure the loop finishes early
last = [];
}


// go check every element in order
for (var i = 0; i < len; i++) {
if (current[i] !== last[i]) {
callback();
last = current;
lastlen = len;
break;
}
}


// over, and over, and over again
setTimeout(check, delay);


}, delay);
}


//
//  Check for mutation events support
//


var support = {};


var el = document.documentElement;
var remain = 3;


// callback for the tests
function decide() {
if (support.DOMNodeInserted) {
window.addEventListener("DOMContentLoaded", function () {
if (support.DOMSubtreeModified) { // for FF 3+, Chrome
el.addEventListener('DOMSubtreeModified', callback, false);
} else { // for FF 2, Safari, Opera 9.6+
el.addEventListener('DOMNodeInserted', callback, false);
el.addEventListener('DOMNodeRemoved', callback, false);
}
}, false);
} else if (document.onpropertychange) { // for IE 5.5+
document.onpropertychange = callback;
} else { // fallback
naive();
}
}


// checks a particular event
function test(event) {
el.addEventListener(event, function fn() {
support[event] = true;
el.removeEventListener(event, fn, false);
if (--remain === 0) decide();
}, false);
}


// attach test events
if (window.addEventListener) {
test('DOMSubtreeModified');
test('DOMNodeInserted');
test('DOMNodeRemoved');
} else {
decide();
}


// do the dummy test
var dummy = document.createElement("div");
el.appendChild(dummy);
el.removeChild(dummy);


// expose
window.onDomChange = onDomChange;
})(window);

用法:

onDomChange(function(){
alert("The Times They Are a-Changin'");
});

这适用于IE 5.5+, FF 2+, Chrome, Safari 3+和Opera 9.6+

到目前为止,使用最小代码的终极方法:

(IE11+, FF, Webkit)

使用MutationObserver并回落到已弃用的 突变事件如果需要:
. . .

var observeDOM = (function(){
var MutationObserver = window.MutationObserver || window.WebKitMutationObserver;


return function( obj, callback ){
if( !obj || obj.nodeType !== 1 ) return;


if( MutationObserver ){
// define a new observer
var mutationObserver = new MutationObserver(callback)


// have the observer observe for changes in children
mutationObserver.observe( obj, { childList:true, subtree:true })
return mutationObserver
}
    

// browser support fallback
else if( window.addEventListener ){
obj.addEventListener('DOMNodeInserted', callback, false)
obj.addEventListener('DOMNodeRemoved', callback, false)
}
}
})()




//------------< DEMO BELOW >----------------


// add item
var itemHTML = "<li><button>list item (click to delete)</button></li>",
listElm = document.querySelector('ol');


document.querySelector('body > button').onclick = function(e){
listElm.insertAdjacentHTML("beforeend", itemHTML);
}


// delete item
listElm.onclick = function(e){
if( e.target.nodeName == "BUTTON" )
e.target.parentNode.parentNode.removeChild(e.target.parentNode);
}
    

// Observe a specific DOM element:
observeDOM( listElm, function(m){
var addedNodes = [], removedNodes = [];


m.forEach(record => record.addedNodes.length & addedNodes.push(...record.addedNodes))
   

m.forEach(record => record.removedNodes.length & removedNodes.push(...record.removedNodes))


console.clear();
console.log('Added:', addedNodes, 'Removed:', removedNodes);
});




// Insert 3 DOM nodes at once after 3 seconds
setTimeout(function(){
listElm.removeChild(listElm.lastElementChild);
listElm.insertAdjacentHTML("beforeend", Array(4).join(itemHTML));
}, 3000);
<button>Add Item</button>
<ol>
<li><button>list item (click to delete)</button></li>
<li><button>list item (click to delete)</button></li>
<li><button>list item (click to delete)</button></li>
<li><button>list item (click to delete)</button></li>
<li><em>&hellip;More will be added after 3 seconds&hellip;</em></li>
</ol>

或者你可以简单地创建自己的活动,在任何地方运行

 $("body").on("domChanged", function () {
//dom is changed
});




$(".button").click(function () {


//do some change
$("button").append("<span>i am the new change</span>");


//fire event
$("body").trigger("domChanged");


});
< p >完整的示例 http://jsfiddle.net/hbmaam/Mq7NX/ < / p >

我最近写了一个插件,就是这样做的——jquery.initialize

使用方法与.each函数相同

$(".some-element").initialize( function(){
$(this).css("color", "blue");
});

.each的不同之处在于——它接受你的选择器,在本例中是.some-element,并等待将来有这个选择器的新元素,如果这样的元素被添加,它也将被初始化。

在我们的例子中,初始化函数只是将元素颜色改为蓝色。因此,如果我们添加新元素(无论是使用ajax还是F12检查器或任何东西),如:

$("<div/>").addClass('some-element').appendTo("body"); //new element will have blue color!

插件会立即初始化它。另外,plugin确保一个元素只初始化一次。因此,如果你添加元素,然后.detach()它从body,然后再添加它,它将不会再次初始化。

$("<div/>").addClass('some-element').appendTo("body").detach()
.appendTo(".some-container");
//initialized only once

Plugin基于MutationObserver -它将在IE9和10上工作,并在自述文件页面. Plugin中详细描述依赖项。

如何为这个扩展jquery ?

   (function () {
var ev = new $.Event('remove'),
orig = $.fn.remove;
var evap = new $.Event('append'),
origap = $.fn.append;
$.fn.remove = function () {
$(this).trigger(ev);
return orig.apply(this, arguments);
}
$.fn.append = function () {
$(this).trigger(evap);
return origap.apply(this, arguments);
}
})();
$(document).on('append', function (e) { /*write your logic here*/ });
$(document).on('remove', function (e) { /*write your logic here*/ });

Jquery 1.9+已经建立了对此的支持(我听说没有测试过)。

使用MutationObserver接口,如Gabriele Romanato的博客所示

Chrome 18+, Firefox 14+, IE 11+, Safari 6+

// The node to be monitored
var target = $( "#content" )[0];


// Create an observer instance
var observer = new MutationObserver(function( mutations ) {
mutations.forEach(function( mutation ) {
var newNodes = mutation.addedNodes; // DOM NodeList
if( newNodes !== null ) { // If there are new nodes added
var $nodes = $( newNodes ); // jQuery set
$nodes.each(function() {
var $node = $( this );
if( $node.hasClass( "message" ) ) {
// do something
}
});
}
});
});


// Configuration of the observer:
var config = {
attributes: true,
childList: true,
characterData: true
};


// Pass in the target node, as well as the observer options
observer.observe(target, config);


// Later, you can stop observing
observer.disconnect();

下面的例子改编自Mozilla Hacks的博客,并使用了MutationObserver

// Select the node that will be observed for mutations
var targetNode = document.getElementById('some-id');


// Options for the observer (which mutations to observe)
var config = { attributes: true, childList: true };


// Callback function to execute when mutations are observed
var callback = function(mutationsList) {
for(var mutation of mutationsList) {
if (mutation.type == 'childList') {
console.log('A child node has been added or removed.');
}
else if (mutation.type == 'attributes') {
console.log('The ' + mutation.attributeName + ' attribute was modified.');
}
}
};


// Create an observer instance linked to the callback function
var observer = new MutationObserver(callback);


// Start observing the target node for configured mutations
observer.observe(targetNode, config);


// Later, you can stop observing
observer.disconnect();

浏览器支持:Chrome 18+, Firefox 14+, IE 11+, Safari 6+

MutationObserver = window.MutationObserver || window.WebKitMutationObserver;


var observer = new MutationObserver(function(mutations, observer) {
// fired when a mutation occurs
console.log(mutations, observer);
// ...
});


// define what element should be observed by the observer
// and what types of mutations trigger the callback
observer.observe(document, {
subtree: true,
attributes: true
//...
});

完整的解释:https://stackoverflow.com/a/11546242/6569224

使用TrackChanges检测html更改。 链接:https://www.npmjs.com/package/track-changes-js < / p >

例子

 let button = document.querySelector('.button');


trackChanges.addObserver('buttonObserver', () => button);
 

trackChanges.addHandler('buttonObserver', buttonHandler);


function buttonHandler(button) {
console.log(`Button created: ${button}`);
}

8年后,这里是我的解决方案使用MutationObserverRxJS

observeDOMChange(document.querySelector('#dom-changes-here'))
.subscribe(val => log('DOM-change detected'));

与其他方法的主要区别是在DOM更改时触发CustomEvent,并通过以下特性侦听事件debound以有效地执行用户逻辑;

  • 撤消连续的DOM更改,以防止执行过多
  • 在给定的时间后停止观看
  • 在停止监视DOM更改后删除事件侦听器/订阅者
  • 观察一个框架(比如Angular)中发生的DOM变化是很有用的
import { fromEvent, timer} from 'rxjs';
import { debounceTime, takeUntil, tap } from 'rxjs/operators';


function observeDOMChange(el, options={}) {
options = Object.assign({debounce: 100, expires: 2000}, options);


const observer = new MutationObserver(list =>  {
el.dispatchEvent(new CustomEvent('dom-change', {detail: list}));
});
observer.observe(el, {attributes: false, childList: true, subtree: true });


let pipeFn;
if (options.expires) {
setTimeout(_ => observer.disconnect(), options.expires);
pipeFn = takeUntil(timer(options.expires));
} else {
pipeFn = tap(_ => _);
}


return fromEvent(el, 'dom-change')
.pipe(pipeFn, debounceTime(options.debounce));
}
< p > 在stackblitz演示。
enter image description here < / p >

在2022年发现了这个问题的解决方案。

我们已经看到了不同的解决方案,主要涉及MutationObserver

如果有人想记录DOM更改并存储它们以便一段时间后重播,他们可以使用rrweb

编辑:

再举个例子,下面是一些提示:

你可以通过CDNnpm使用rrweb

让我们以CDN为例来记录DOM更改事件:

第一步:只在<HTML><head>标记中包含以下script标记

<script src="https://cdn.jsdelivr.net/npm/rrweb@2.0.0-alpha.2/dist/rrweb-all.js" crossorigin="anonymous"></script>

步骤2:并在代码中添加以下代码以捕获rrweb生成的事件。

<script>
var events = [];
rrweb.record({
emit(event) {
events.push(event);
// you can store this event anywhere and you can replay them later. ex: some JSON file, or DB
}
});


</script>


这个例子主要用于记录任何web应用程序的事件。

要了解和理解细节(如何记录/回放),请阅读rrweb文档

重播的例子:

这是为了调试,但添加在这里,以便任何人都可以检查重放的一面:

播放实例