MutationObserver 中的 document.querySelector:好的还是坏的做法?

时间:2021-03-25 08:28:50

标签: javascript asynchronous document-ready mutation-observers queryselector

目标和我的尝试

我正在尝试获得一种方法,以便能够等到元素已经在 DOM 中。我读过几篇关于 MutationObserver 的文章,我得到了这个方法,它应该可以完成我所需要的:

const waitForElement = async (queryString) => {
    return new Promise((resolve) => {
      const observer = new MutationObserver((mutations) => {
        mutations.forEach((mutation) => {
          const nodes = Array.from(mutation.addedNodes);
          nodes.forEach((node) => {
            console.log('NODE CUSTOM', node);
            if (node.matches && node.matches(queryString)) {
              observer.disconnect();
              resolve(node);
            }
          });
        });
      });

      observer.observe(document.documentElement, {
        childList: true,
        subtree: true,
      });
    });
};

然后,我可以简单地使用它:

await waitForElement('#id-of-element');

问题

问题是它实际上没有按预期工作console.log 只记录“父”元素,如果要搜索的元素在树的深处,它似乎没有记录它(这是在更复杂的应用程序中使用的,因此它可能与异步调用等有关)。

问题

然而,我发现,我只需要查看实际元素是否在 DOM 中,而不是通过突变和节点的数组,所以我实现了这个:

const waitForElement = async (queryString) => {
    return new Promise((resolve) => {
      let element;
      const observer = new MutationObserver(() => {
        element = document.querySelector(queryString);
        if (element) {
          observer.disconnect();
          resolve(element);
        }
      });

      observer.observe(document.documentElement, {
        childList: true,
        subtree: true,
      });
    });
  };

这种方法只会在每次更改后使用 querySelector 方法检查元素是否实际位于 DOM 上。 它确实有效(另一个失败了),而且我发现它更容易阅读和理解,并且中间的循环更少

这是一种值得推荐的方法吗?它会影响性能,还是和第一种方法一样?

谢谢!

1 个答案:

答案 0 :(得分:1)

对选择器的单个查询应该非常、非常、非常快,所以我不认为这是一个问题,但它会很多取决于您使用的 DOM测试您的用例,看看您是否发现了性能问题。

我至少可以指定在 DOM 中查看的位置,而不是在每次更改时查看整个内容。这最大限度地减少了对您的变异观察者的调用,并最大限度地减少了它在被调用时所做的搜索量。如果特定用例必须查看整个事物,那么它可以使用 documentElement,但我至少可以避免这种情况。 (也没有理由在实际使用范围之上的范围内声明 element,并且“查询字符串”在网络编程中具有特定含义,而不是您在这里使用它的目的,所以我'd 只使用“选择器”或“选择器字符串”。)

以下是您如何做到这一点的想法:

const waitForElement = async (selector, rootElement = document.documentElement) => {
    return new Promise((resolve) => {
        const observer = new MutationObserver(() => {
            const element = document.querySelector(selector);
            if (element) {
                observer.disconnect();
                resolve(element);
            }
        });
      
        observer.observe(rootElement, {
            childList: true,
            subtree: true,
        });
    });
};

有选择地接受 AbortSignal 也可能是有意义的,这样您就可以停止等待该元素,让它因一些适当的“取消”错误而被拒绝。