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

Una*_*dra 2 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,
      });
    });
};
Run Code Online (Sandbox Code Playgroud)

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

await waitForElement('#id-of-element');
Run Code Online (Sandbox Code Playgroud)

问题

问题是它实际上没有按预期工作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,
      });
    });
  };
Run Code Online (Sandbox Code Playgroud)

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

这是一个值得推荐的方法吗?它会影响性能,还是与第一种方法相同?

谢谢你!

T.J*_*der 5

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

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

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

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,
        });
    });
};
Run Code Online (Sandbox Code Playgroud)

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