检测 DOM 中的更改

Detect changes in the DOM

提问人:esafwan 提问时间:7/10/2010 最后编辑:000esafwan 更新时间:6/29/2023 访问量:469247

问:

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

例如,添加文本输入,则应调用该函数。

JavaScript DOM 事件 突变观察者

评论

1赞 Justin Johnson 7/11/2010
除非某些第三方脚本将节点添加到 DOM,否则没有必要这样做。
0赞 Gabriele Petrioli 7/16/2010
stackoverflow.com/questions/2457043/ 的副本...
0赞 Makyen 10/28/2017
是否有 JavaScript/jQuery DOM 更改侦听器的可能副本?
12赞 FluorescentGreen5 5/2/2018
@JustinJohnson如果你正在制作一个注入 JS 代码的 chrome 扩展,它会很有用。
0赞 Maykonn 7/26/2018
github.com/Maykonn/page-info-js

答:

253赞 19 revs, 3 users 69%galambalazs #1

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

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

如果您需要支持较旧的方法,您可以尝试回退到其他方法,例如下面这个 5 (!) 年前的答案中提到的方法。有龙。享受:)


其他人正在更改文档?因为如果你对更改有完全的控制权,你只需要创建自己的 API(使用函数或自定义事件),并在修改内容的任何地方触发/调用它。domChanged

DOM Level-2 具有 Mutation 事件类型,但旧版本的 IE 不支持它。请注意,在 DOM3 事件规范中不推荐使用突变事件,并且会降低性能

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

对于完整的 domChange,间隔可能是过度杀戮。想象一下,您需要存储整个文档的当前状态,并检查每个元素的每个属性是否相同。

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

评论

4赞 Kees C. Bakker 1/23/2011
想知道:如果 jQuery live() 无法检测到 DOM 更改,他们如何解决这个问题?
1赞 Bojangles 2/4/2013
@JoshStodola 大胆的人也惹恼了我。我决定修复它。
1赞 Adam Pietrasiak 2/7/2015
突变事件已弃用。您应该使用 MutationObserver。我已经为这样的问题编写了我的插件 - github.com/AdamPietrasiak/jquery.initialize
1赞 SuperUberDuper 3/24/2015
我怎样才能让jquery onClick在突变观察器之前触发,当使用余烬操作单击按钮时触发?stackoverflow.com/questions/29216434/......
3赞 RobG 11/2/2015
顺便说一句,从一个窗口另一个窗口传递是没有意义的。如果目的是安全地获取 global/window 对象,请传入 this: 因为在全局代码中,this 始终指向 global/window 对象。(function(window){...}(window))(function(window){...}(this))
304赞 vsync 1/29/2013 #2

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

(IE11+、FF、Webkit)

如果需要,使用 MutationObserver 并回退到已弃用的 Mutation 事件
(以下示例,如果仅适用于有关附加或删除节点的 DOM 更改)

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>

评论

1赞 Sebastien Lorber 2/26/2014
对于新的 DOM 节点来说,它似乎工作得很好。我们可以调整它以处理 dom 节点更改(至少是 DOM 节点值/文本)吗?
2赞 A1rPun 6/28/2014
将参数传递给回调函数以获得更多控制。mutations, observer
4赞 stiller_leser 11/26/2014
这对我有很大帮助,但是我该如何“解绑”呢?假设我只想观察一次更改,但多次这样做?oberserveDOM = null 显然行不通......
1赞 stldoug 7/7/2020
JSHint 不喜欢 .它只是检查以确保 nodeType 是一个元素,因此您可以使用 .!obj.nodeType === 1obj.nodeType !== 1
2赞 Vadorequest 5/17/2022
要“取消监视”,请使用 developer.mozilla.org/en-US/docs/Web/API/MutationObserverobserver.disconnect();
13赞 HB MAAM 3/6/2014 #3

或者您可以简单地创建自己的事件,这些事件在任何地方运行

 $("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");

        });

完整示例 http://jsfiddle.net/hbmaam/Mq7NX/

评论

1赞 lefoy 11/17/2016
这是不一样的......上述方法仍然有效 api.jquery.com/trigger
16赞 Adam Pietrasiak 2/7/2015 #4

我最近写了一个插件来做到这一点 - jquery.initialize
NPM 链接 - 不同的 NPM/GitHub 用户名,同一作者)

您可以像使用函数一样使用它.each

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

与 - 的区别是 - 它需要您的选择器,在这种情况下,并等待将来使用此选择器的新元素,如果将添加此类元素,它也将被初始化。.each.some-element

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

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

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

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

插件基于 - 它将在 IE9 和 10 上运行,其依赖项详见自述文件页面MutationObserver

评论

1赞 thexpand 6/25/2018
请添加到 npm。
4赞 StartCoding 2/13/2017 #5

如何为此扩展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+ 已经对此建立了支持(我听说没有测试过)。

7赞 Anthony Awuley 5/24/2018 #6

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

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();

评论

4赞 BenMorel 10/5/2018
MutationObserver 是原生 JavaScript,而不是 jQuery。
47赞 Anthony Awuley 5/24/2018 #7

以下示例改编自 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+

14赞 Mahdi Bashirpour 11/23/2020 #8
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

评论

1赞 Altimus Prime 4/23/2021
当我尝试这样做时,没有任何内容会记录到 DOM 的任何突变的控制台。我一定做得不对。
1赞 Soley 7/13/2022
使用完后别忘了observer.disconnect()
0赞 itmor 7/16/2021 #9

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

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

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

 function buttonHandler(button) {
   console.log(`Button created: ${button}`);
 }
4赞 allenhwkim 10/2/2021 #10

8 年后,这是我使用和MutationObserverRxJS

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

与其他方法的主要区别在于,当 DOM 发生变化时触发 a,并侦听去抖动的事件,以通过以下功能有效地执行用户逻辑;CustomEvent

  • 取消连续的 DOM 更改以防止执行过多
  • 在给定时间后停止观看
  • 在停止监视 DOM 更改后删除事件侦听器/订阅者
  • 对于观察框架中发生的 DOM 更改很有用,例如 Angular
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));
}

在stackblitz演示。
enter image description here

1赞 Code_Crash 9/19/2022 #11

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

我们已经看到了不同的解决方案,其中大部分涉及.MutationObserver

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

编辑:

添加示例,以下是提示:

rrweb,您可以通过 CDNnpm 使用

让我们以 CDN 为例,用于记录 DOM 更改事件:

第 1 步:只需在标签中包含以下脚本标签<HTML><head>

<script src="https://cdn.jsdelivr.net/npm/[email protected]/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 文档

重播器示例:

这是为了调试,但是在此处添加,以便任何人都可以检查重播端:

重播器示例

评论

1赞 esafwan 9/28/2022
伟大。看看是否可以在此处添加一些代码片段或示例。这将使它成为一个更有用的答案。
0赞 Code_Crash 9/30/2022
当然@esafwan,添加了示例,请检查是否有帮助。