Vue.nextTick

2020/07/26 front-end 共 4842 字,约 14 分钟

在公司实习的项目中遇到了一个叫做Vue.nextTick()的东西,感觉有点意思,想了解一下。

1.前言

先来看一个案例:

<div class="app">
  <div ref="msgDiv"></div>
  <div v-if="msg1">Message got outside $nextTick: </div>
  <div v-if="msg2">Message got inside $nextTick: </div>
  <div v-if="msg3">Message got outside $nextTick: </div>
  <button @click="changeMsg">
    Change the Message
  </button>
</div>

Vue:

new Vue({
  el: '.app',
  data: {
    msg: 'Hello Vue.',
    msg1: '',
    msg2: '',
    msg3: '',
  },
  methods: {
    changeMsg() {
      this.msg = 'Hello world.';
      this.msg1 = this.$refs.msgDiv.innerHTML;
      this.$nextTick(() => {
        this.msg2 = this.$refs.msgDiv.innerHTML;
      });
      this.msg3 = this.$refs.msgDiv.innerHTML;
    },
  },
});

从图中可以得知:msg1 和 msg3 显示的内容还是变换之前的,而 msg2 显示的内容是变换之后的。其根本原因是因为 Vue 中 DOM 更新是异步的

2.应用场景

  • 在 Vue 生命周期的created()钩子函数进行的 DOM 操作一定要放在Vue.nextTick()的回调函数中
  • 在数据变化后要执行的某个操作,而这个操作需要使用随数据改变而改变的 DOM 结构的时候,这个操作都应该放进Vue.nextTick()的回调函数中。

解释:在created()钩子函数执行的时候 DOM 其实并未进行任何渲染,而此时进行 DOM 操作无异于徒劳,所以此处一定要将 DOM 操作的 js 代码放进Vue.nextTick()的回调函数中。与之对应的就是mounted()钩子函数,因为该钩子函数执行时所有的 DOM 挂载和渲染都已完成,此时在该钩子函数中进行任何 DOM 操作都不会有问题 。

官方文档中这样说道:

Vue 异步执行 DOM 更新。只要观察到数据变化,Vue 将开启一个队列,并缓冲在同一事件循环中发生的所有数据改变。如果同一个 watcher 被多次触发,只会被推入到队列中一次。这种在缓冲时去除重复数据对于避免不必要的计算和 DOM 操作上非常重要。然后,在下一个的事件循环“tick”中,Vue 刷新队列并执行实际 (已去重的) 工作。Vue 在内部尝试对异步队列使用原生的 Promise.thenMessageChannel,如果执行环境不支持,会采用 setTimeout(fn, 0)代替。

例如,当你设置vm.someData = 'new value',该组件不会立即重新渲染。当刷新队列时,组件会在事件循环队列清空时的下一个“tick”更新。多数情况我们不需要关心这个过程,但是如果你想在 DOM 状态更新后做点什么,这就可能会有些棘手。虽然 Vue.js 通常鼓励开发人员沿着“数据驱动”的方式思考,避免直接接触 DOM,但是有时我们确实要这么做。为了在数据变化之后等待 Vue 完成更新 DOM ,可以在数据变化之后立即使用Vue.nextTick(callback) 。这样回调函数在 DOM 更新完成后就会调用。

3.机制

其实官方的解释已经说明了一个问题:Vue 不是数据发生变化后 DOM 立即变化,而是通过一定的策略进行 DOM 更新。即异步更新

(1)所有同步任务都在主线程上执行,形成一个执行栈(execution context stack)。 (2)主线程之外,还存在一个“任务队列”(task queue)。只要异步任务有了运行结果,就在”任务队列”之中放置一个事件。 (3)一旦”执行栈”中的所有同步任务执行完毕,系统就会读取”任务队列”,看看里面有哪些事件。那些对应的异步任务,于是结束等待状态,进入执行栈,开始执行。 (4)主线程不断重复上面的第三步。

还有一个例子可以说明问题:

事件循环过程如下:

  • 第一个 tick(上图的第一个黑方块,即本次更新循环)
    • 首先修改数据,这是同步的任务。同一事件循环的所有同步任务都在主线程上执行,形成一个执行栈,此时仍未涉及 DOM
    • 侦听到数据变化,Vue 将开启一个队列,并缓冲在同一事件循环中发生的所有数据变更。如果同一个 watcher 被多次的触发,只会被推入到队列中一次。
  • 第二个 tick(上图的第二个黑方块,即’下次更新循环’)
    • 同步任务执行完毕,开始执行异步 watcher 队列的任务,更新 DOM。Vue 在内部尝试对异步队列使用原生的Promise.then()MessageChannel方法,如果环境不支持,会使用setTimeout(fn,0)代替。
  • 第三个 tick(最后一个方块)
    • 此时便是‘下次 DOM 更新循环结束后’
    • 此时可以通过Vue.nextTick获取到改变之后的 DOM。

4.源码小解析

/**
 * Defer a task to execute it asynchronously.
 */
export const nextTick = (function () {
  const callbacks = [];
  let pending = false;
  let timerFunc;

  function nextTickHandler() {
    pending = false;
    const copies = callbacks.slice(0);
    callbacks.length = 0;
    for (let i = 0; i < copies.length; i++) {
      copies[i]();
    }
  }

  // the nextTick behavior leverages the microtask queue, which can be accessed
  // via either native Promise.then or MutationObserver.
  // MutationObserver has wider support, however it is seriously bugged in
  // UIWebView in iOS >= 9.3.3 when triggered in touch event handlers. It
  // completely stops working after triggering a few times... so, if native
  // Promise is available, we will use it:
  /* istanbul ignore if */
  if (typeof Promise !== 'undefined' && isNative(Promise)) {
    var p = Promise.resolve();
    var logError = (err) => {
      console.error(err);
    };
    timerFunc = () => {
      p.then(nextTickHandler).catch(logError);
      // in problematic UIWebViews, Promise.then doesn't completely break, but
      // it can get stuck in a weird state where callbacks are pushed into the
      // microtask queue but the queue isn't being flushed, until the browser
      // needs to do some other work, e.g. handle a timer. Therefore we can
      // "force" the microtask queue to be flushed by adding an empty timer.
      if (isIOS) setTimeout(noop);
    };
  } else if (
    !isIE &&
    typeof MutationObserver !== 'undefined' &&
    (isNative(MutationObserver) ||
      // PhantomJS and iOS 7.x
      MutationObserver.toString() === '[object MutationObserverConstructor]')
  ) {
    // use MutationObserver where native Promise is not available,
    // e.g. PhantomJS, iOS7, Android 4.4
    var counter = 1;
    var observer = new MutationObserver(nextTickHandler);
    var textNode = document.createTextNode(String(counter));
    observer.observe(textNode, {
      characterData: true,
    });
    timerFunc = () => {
      counter = (counter + 1) % 2;
      textNode.data = String(counter);
    };
  } else {
    // fallback to setTimeout
    /* istanbul ignore next */
    timerFunc = () => {
      setTimeout(nextTickHandler, 0);
    };
  }

  return function queueNextTick(cb?: Function, ctx?: Object) {
    let _resolve;
    callbacks.push(() => {
      if (cb) {
        try {
          cb.call(ctx);
        } catch (e) {
          handleError(e, ctx, 'nextTick');
        }
      } else if (_resolve) {
        _resolve(ctx);
      }
    });
    if (!pending) {
      pending = true;
      timerFunc();
    }
    if (!cb && typeof Promise !== 'undefined') {
      return new Promise((resolve, reject) => {
        _resolve = resolve;
      });
    }
  };
})();

其中nextTickHandler()函数用来执行callbacks里存储的所有回调函数。

接下来是将触发方式赋值给timerFunc

  • 先判断是否原生支持 promise,如果支持,则利用 promise 来触发执行回调函数;
  • 否则,如果支持 MutationObserver,则实例化一个观察者对象,观察文本节点发生变化时,触发执行所有回调函数。
  • 如果都不支持,则利用 setTimeout 设置延时为 0。

这里有一个新名词:MutationObserver

MutationObserver是 HTML5 中的新 API,是个用来监视 DOM 变动的接口。他能监听一个 DOM 对象上发生的子节点删除、属性修改、文本内容修改等等。

用的时候要绑个回调函数:

var domTarget = 你想要监听的dom节点;
var mo = new MutationObserver(callback);
mo.observe(domTarget, {
  characterData: true, //说明监听文本内容的修改。
});

nextTickMutationObserver的作用就如上图所示。在监听到 DOM 更新后,调用回调函数。

其实使用 MutationObserver的原因就是 nextTick想要一个异步 API,用来在当前的同步代码执行完毕后,执行想执行的异步回调,包括PromisesetTimeout都是基于这个原因。

但是深入的话,就要涉及到同步任务和异步任务(包括弘任务和微任务)了。

文档信息

Search

    Table of Contents