如何更改页面上加载的 HTML 内容

How to change the HTML content as it's loading on the page

我在我们的网站上进行 A/B 测试,我的大部分工作都在一个 JS 文件中,该文件在呈现任何其他内容之前但在 jQuery 之后加载到页面顶部有时会派上用场。

举一个更改 H1 标签的非常简单的例子,我通常会在头部注入样式以将 H1 不透明度设置为 0,然后在 DOMContentLoaded 上,我会操作 H1 内容,然后将不透明度设置为 1 .这样做的原因是为了避免在更改发生之前闪现旧内容-隐藏整个对象在眼睛上更优雅。

我已经开始研究 MutationObserver API。我之前在用户可以打开的覆盖对话框中更改内容时使用过它,这似乎是一种很酷的方法,我想知道是否有人设法使用 MutationObserver 来收听文档,因为它是第一次加载/在首次呈现之前和 DOMContentLoaded 之前解析并更改文档?

这种方法可以让我更改 H1 内容,而不必隐藏它,更改它,然后再显示它。

我已经尝试过但到目前为止都失败了,并且刚刚结束阅读有关即将过时的突变事件并想知道我是否正在尝试做一些不可能的事情。但是我们(不是我)已经设法将机器人送上火星,所以我希望我能解决这个问题。

那么是否可以在加载/解析页面时使用 MutationObservers 即时更改 HTML 内容?

感谢您的帮助或指点。

此致, 尼克

The docs on MDN 有一个不完整的通用示例,没有展示常见的陷阱。 Mutation summary 库提供了一个 human-friendly 包装器,但与所有包装器一样,它会增加开销。 参见 Performance of MutationObserver to detect nodes in entire DOM

创建并启动观察者。

让我们使用递归 document-wide MutationObserver 来报告所有 added/removed 个节点。

var observer = new MutationObserver(onMutation);
observer.observe(document, {
  childList: true, // report added/removed nodes
  subtree: true,   // observe any descendant elements
});

添加节点的简单枚举。

极大地减慢 big/complex 页面的加载速度,请参阅 Performance
有时会错过合并到 parent 容器中的 H1 元素,请参阅下一节。

function onMutation(mutations) {
  mutations.forEach(mutation, m => {
    [...m.addedNodes]
      .filter(node =>
        node.localName === 'h1' && /foo/.test(node.textContent))
      .forEach(h1 => {
        h1.innerHTML = h1.innerHTML.replace(/foo/, 'bar');
      });
  });
}

添加节点的高效枚举

现在是困难的部分。突变记录中的节点可能是加载页面时的容器(例如整个站点 header 块,其所有元素都报告为一个添加的节点):规范 doesn't require 每个添加的节点都被列出单独地,所以我们必须使用 querySelectorAll(极慢)或 getElementsByTagName(极快)来查看每个元素。

function onMutation(mutations) {
  for (var i = 0, len = mutations.length; i < len; i++) {
    var added = mutations[i].addedNodes;
    for (var j = 0, node; (node = added[j]); j++) {
      if (node.localName === 'h1') {
        if (/foo/.test(node.textContent)) {
          replaceText(node);
        }
      } else if (node.firstElementChild) {
        for (const h1 of node.getElementsByTagName('h1')) {
          if (/foo/.test(h1.textContent)) {
            replaceText(h1);
          }
        }
      }
    }
  }
}

function replaceText(el) {
  const walker = document.createTreeWalker(el, NodeFilter.SHOW_TEXT);
  for (let node; (node = walker.nextNode());) {
    const text = node.nodeValue;
    const newText = text.replace(/foo/, 'bar');
    if (text !== newText) {
      node.nodeValue = newText;
    }
  }
}

为什么是两个丑陋的香草 for 循环?因为 forEachfilter 以及 ES2015 for (val of array) 在某些浏览器中可能非常慢,请参阅 Performance of MutationObserver to detect nodes in entire DOM

为什么 TreeWalker?保留附加到 sub-elements 的任何事件侦听器。仅更改 Text 个节点:它们没有 child 个节点,更改它们不会触发新的突变,因为我们使用的是 childList: true,而不是 characterData: true .

通过实时 HTMLCollection 处理相对罕见的元素,无需枚举突变。

所以我们寻找一个应该很少使用的元素,如 H1 标签或 IFRAME 等。在这种情况下,我们可以使用 getElementsByTagName 返回的自动更新的 HTMLCollection 来简化和加速观察者回调。

const h1s = document.getElementsByTagName('h1');

function onMutation(mutations) {
  if (mutations.length === 1) {
    // optimize the most frequent scenario: one element is added/removed
    const added = mutations[0].addedNodes[0];
    if (!added || (added.localName !== 'h1' && !added.firstElementChild)) {
      // so nothing was added or non-H1 with no child elements
      return;
    }
  }
  // H1 is supposed to be used rarely so there'll be just a few elements
  for (var i = 0, h1; (h1 = h1s[i]); i++) {
    if (/foo/.test(h1.textContent)) {
      // reusing replaceText from the above fragment of code 
      replaceText(h1);
    }
  }
}

我以 A/B 测试为生,我经常使用 MutationObservers 并取得了很好的结果,但更多时候我只是做长轮询,这实际上是大多数第 3 方平台在后台做的事情您使用他们的所见即所得(有时甚至是他们的代码编辑器)。 50 毫秒的循环不应减慢页面速度或导致 FOUC。

我通常使用像这样的简单模式:

var poller = setInterval(function(){
  if(document.querySelector('#question-header') !== null) {
    clearInterval(poller);

    //Do something
  }
}, 50);

您可以使用 sizzle 选择器获得任何 DOM 元素,就像您在 jQuery 中使用 document.querySelector 一样,这有时是您唯一需要库的东西。

事实上,我们在工作中经常这样做,所以我们有一个构建过程和 a module library,其中包括一个名为 When 的函数,它完全符合您的要求寻找。该特定函数检查 jQuery 以及元素,但是修改库以不依赖 jQuery 是微不足道的(我们依赖 jQuery 因为它在 大多数 我们客户的网站,我们用它来做很多事情)。

谈到第 3 方测试平台和 javascript 库,根据实施情况,许多平台(如 Optimizely、Qubit,我认为是 Monetate)捆绑了 jQuery 的一个版本(有时会缩减)在执行代码时立即可用,因此如果您使用的是第 3 方平台,则需要考虑这一点。