浅谈nextTick实现原理
Vue3中的`nextTick`确保在DOM更新后获取最新实例的回调。其实现主要通过`Promise`,将回调放入微任务队列中。源码中,`nextTick`返回一个`Promise`,并通过`queueFlush`和`flushJobs`管理任务队列,确保任务在DOM更新后执行。简单实现中,使用`resolvedPromise`和`callbacks`数组来模拟这一过程。
夜深风竹敲秋韵。万叶千声皆是恨。
浅谈nextTick实现原理
-
由于在vue响应式数据状态发生变化中,最终的DOM更新并不是同步生效的,而是将它们缓存在一个队列中,直到下一个“nextTick”才一起执行,这样主要是为了确保每个组件无论发生多少状态改变,都仅执行一次更新。
-
换句话说,在此时获取到的组件实例并不是最新的实例,
nextTick的主要作用就是确保在DOM更新后能够获取到最新实例的回调
类型
typescript
export function nextTick<T = void, R = void>(
this: T,
fn?: (this: T) => R,
): Promise<Awaited<R>>
-
可以看到,
nextTick可以接受一个fn回调函数,并且是可选的,this参数主要作用于在组件上下文中。 -
$nextTick()与nextTick的唯一区别就是组件传递给this.$nextTick()的回调函数会带上this上下文,其绑定了当前组件实例。 -
nextTick返回的是一个promise
示例
nextTick() 可以在状态改变后立即使用,以等待 DOM 更新完成。你可以传递一个回调函数作为参数,或者 await 返回的 Promise。
typescript
<script setup>
import { ref, nextTick } from 'vue'
const count = ref(0)
async function increment() {
count.value++
// DOM 还未更新
console.log(document.getElementById('counter').textContent) // 0
await nextTick()
// DOM 此时已经更新
console.log(document.getElementById('counter').textContent) // 1
}
</script>
<template>
<button id="counter" @click="increment">{{ count }}</button>
</template>
以上主要是官方文档的介绍
原理
在vue3版本中,nextTick源码位于/runtime-core/src/scheduler中,主要代码如下:
typescript
const resolvedPromise = /*#__PURE__*/ Promise.resolve() as Promise<any>
let currentFlushPromise: Promise<void> | null = null
export function nextTick<T = void, R = void>(
this: T,
fn?: (this: T) => R,
): Promise<Awaited<R>> {
const p = currentFlushPromise || resolvedPromise
return fn ? p.then(this ? fn.bind(this) : fn) : p
}
可以看到,nextTick如果接受了一个回调函数,那么就执行这个回调,否则只返回一个promise
里面有一个currentFlushPromise变量,并且也是一个promise。在源码中发现,有两个方法在使用这个变量(其实我并不喜欢贴一堆的源码,有兴趣可以去扒拉源码看就好了,但是这里源码也不多,放了就放了吧)
-
queueFlush:将currentFlushPromise设置为一个Promise -
flushJobs:将currentFlushPromise设置为null -
queueJob:主要是将任务加入队列,并执行queueFlushtypescript// 添加任务,这个方法会在queueFlush 方法中被调用 function queueJob(job) { /** * 通过 Array.includes() 的 startIndex 参数来搜索任务队列中是否已经存在相同的任务 * 默认情况下,搜索的起始索引包含了当前正在执行的任务 * 所以它不能递归地再次触发自身 * 如果任务是一个 watch() 回调,则搜索将从+1索引开始,这样就可以递归调用了 * 但是这个递归调用是由用户来保证的,不能无限递归 */ if (!queue.length || !queue.includes(job, isFlushing && job.allowRecurse ? flushIndex + 1 : flushIndex)) { // 如果任务没有 id 属性,那么就将任务插入到任务队列中 if (job.id == null) { queue.push(job); } // 如果任务有 id 属性,那么就将任务插入到任务队列的合适位置 else { queue.splice(findInsertionIndex(job.id), 0, job); } // 刷新任务队列 queueFlush(); } } // 省略。。。。代码 // 是否正在刷新,没有在刷新时,添加任务执行回调, let isFlushing = false; // 标记是否有任务等待刷新 let isFlushPending = false; // 刷新任务队列 function queueFlush() { // 如果没有在刷新,并且没有任务需要刷新执行 if (!isFlushing && !isFlushPending) { // 标记有任务等待刷新 isFlushPending = true // 将 currentFlushPromise 设置为一个 Promise, 并且在 Promise 的 then 方法中执行 flushJobs currentFlushPromise = resolvedPromise.then(flushJobs) } } // 省略。。。。代码 // 任务队列 const queue: SchedulerJob[] = [] // 当前正在刷新的任务队列的索引 let flushIndex = 0; // 执行任务刷新 function flushJobs(seen) { // 标记已经没有任务等待刷新了(个人理解是。在执行回调任务后,表示已经执行到了当前的任务队列) isFlushPending = false; // 将 isFlushing 设置为 true,表示正在刷新 isFlushing = true; // 非生产环境下,将 seen 设置为一个 Map if ((process.env.NODE_ENV !== 'production')) { seen = seen || new Map(); } // 在刷新之前对队列进行排序,这确保了: // 1. 组件从父级更新到子级。(因为父级总是在子级之前创建,所以它的渲染效果将具有较小的优先级) // 2. 如果在父组件更新期间卸载了组件,子组件则可以跳过其更新。 queue.sort(comparator); // 非生产环境下,检查是否有递归更新 // checkRecursiveUpdates 方法的使用必须在 try ... catch 代码块之外确定, // 因为 Rollup 默认会取消在 try-catch 代码块中树摇优化。这可以使所有警告代码保持不变 // 虽然它们最终会被像 terser 这样的压缩工具树摇优化, // 但有些压缩工具会失败(例如:https://github.com/evanw/esbuild/issues/1610) const check = (process.env.NODE_ENV !== 'production') ? (job) => checkRecursiveUpdates(seen, job) : NOOP; try { for (flushIndex = 0; flushIndex < queue.length; flushIndex++) { const job = queue[flushIndex]; if (job && job.active !== false) { if ((process.env.NODE_ENV !== 'production') && check(job)) { continue; } // 执行任务 callWithErrorHandling(job, null, 14 /* ErrorCodes.SCHEDULER */); } } } finally { // 重置 flushIndex flushIndex = 0; // 快速清空队列 queue.length = 0; // 刷新生命周期的回调 flushPostFlushCbs(seen); // 当前刷新结束 isFlushing = false; // 表示当前的任务,已经完成 currentFlushPromise = null; // 可能在刷新的过程中又有新的任务需要刷新,所以需要判断一下,如果有新添加的任务,就需要再次刷新 if (queue.length || pendingPostFlushCbs.length) { flushJobs(seen); } } }任务执行流程:
- 任务入队 (
queueJob):- 当有新的任务需要执行时,会调用
queueJob方法将任务加入到任务队列queue中。 - 在将任务加入队列前,
queueJob方法会检查队列中是否已存在相同任务,以避免重复添加。 - 如果当前任务具有特定的
id属性,则会根据此id将任务插入到队列的特定位置;若无id,则直接将任务添加到队列末尾。 - 若当前正处于任务刷新过程中(即
isFlushing为true),则会更新flushIndex,这是用于追踪当前正在处理的任务索引的一个变量。 - 最后,调用
queueFlush方法,表明有新的任务待刷新。
- 当有新的任务需要执行时,会调用
- 准备刷新 (
queueFlush):queueFlush方法的主要作用是设置isFlushPending为true,标记有任务等待刷新。- 此步骤确保了即使在异步操作完成之前,也能够知道有任务需要被处理。
- 任务刷新 (
flushJobs):- 当条件成熟时(如微任务或宏任务的执行间隙),
flushJobs方法会被触发来处理任务队列中的任务。 - 首先,
isFlushPending被设置为false,表示不再有任务等待刷新;同时,isFlushing被设置为true,表示开始处理任务。 - 任务的实际执行是通过
callWithErrorHandling方法实现的,该方法负责执行任务并捕捉可能发生的错误,一旦发生错误,会调用onErrorCaptured方法进行处理。 - 所有任务处理完毕后,会清空任务队列
queue,并调用flushPostFlushCbs方法。 flushPostFlushCbs方法通常用于执行一些生命周期钩子函数,如组件的mounted和updated生命周期回调。
- 当条件成熟时(如微任务或宏任务的执行间隙),
- 任务入队 (
实现nextTick
这里实现一个简单的nextTick,不考虑其他细节,只是简单的实现其功能
typescript
// myNextTick.ts
const resolvedPromise = Promise.resolve() as Promise<any>
let callbacks:any[] = []; // 存储回调函数的数组
let pending = false; // 标记是否有一个异步任务正在等待执行
function flushCallbacks() { // 执行所有存储的回调函数
callbacks.forEach(callback => callback());
// 清空数组
callbacks.length = 0
pending = false; // 重置 pending 标志
}
export const myNextTick = (cb?: Function) => {
if (typeof cb !== "function") { // 如果回调不是一个函数,直接返回Promise
return resolvedPromise
}
callbacks.push(cb); // 存放到回调中
if (!pending){ // 如果当前没有异步任务正在等待,则创建一个新的异步任务
pending = true;
return resolvedPromise.then(flushCallbacks)
}
return resolvedPromise // 如果有正在等待执行,直接返回Promise
}
使用上面例子来验证一下
vue
<script setup lang="ts">
import { ref} from "vue";
import {myNextTick} from "./myNextTick.ts";
const count = ref(0)
const increment = ()=>{
count.value++
// DOM 还未更新
console.log(document.getElementById('counter')?.textContent) // 0
myNextTick(()=> {
// DOM 此时已经更新
console.log(document.getElementById('counter')?.textContent) // 1
});
// 再多一个
myNextTick(()=> {
// DOM 此时已经更新
console.log(document.getElementById('counter')?.textContent) // 1
});
}
</script>
<template>
<div @click="increment" id="counter">点我:{{count}}</div>
</template>
<style scoped>
</style>

总结
- 因为DOM更新并不是同步生效的,因此
nextTick的主要作用就是确保在DOM更新后能够获取到最新实例的回调 nextTick的实现原理主要是通过Promise实现的,并返回一个Promise,nextTick中的回调会放到微任务队列中,等待执行(至于为什么是微任务而不是宏任务,个人理解为,因为微任务比宏任务的执行更靠前,而且在执行栈中执行完后,到了微任务,此时已经可以拿到最新的实例了)
其实,在vue2版本中,nextTick 主要依赖浏览器的 Promise、MutationObserver 和 setImmediate 这些异步机制来实现,主要是为了做兼容性,但是在vue3之后,就只需要Promise,大概原因可能是vue3之后,基本上都是支持最新的浏览器版本,在旧版本浏览器中,可能并没有Promise,因此退而求其次,使用一些其他微任务或者宏任务来做代替。