Vue nextTick学习笔记

最近做了个一个小功能:打开dialog后,光标能focus在输入框里。实现时小折腾了一会儿,不过正巧就借着机会介绍一下vue的一个知识点——nextTick。

dialog

focus

先从这个demo讲起。内容很简单,就是一个vuetify的dialog,点击该DIALOG按钮后,就会有个输入框。目标是让光标停留在这个输入框里。

<v-app id="app">
    <v-dialog v-model="show" max-width="290">
        <v-btn primary dark slot="activator">DIALOG</v-btn>
        <v-card>
          <v-card-title class="headline">
              Simple Form
          </v-card-title>

          <v-text-field ref="txt" label="Input"></v-text-field>
        </v-card>
    </v-dialog>
</v-app>

刚开始我的想法很naive:watch一下show值,如果是true就调用focus()方法。

new Vue({
  el: '#app',
  data () {
    return {
      show: false,
    }
  },
  watch: {
    show(val) {
      if (!val) return;

      this.$refs.txt.focus();
    },
  }
})

但这并没有什么用。

failed

OK,debug一下。当断点打在this.$refs.txt.focus()上时,我发现整个dialog内容是dispaly:none。复习一下dispaly:none,它是不渲染页面流的。也就是说,我试图将光标focus在一个未被渲染的输入框中。这必然是失败。

Vue开发者文档

至于为什么会这样,我们看看Vue开发者文档。这里提到了异步更新队列:

Vue异步执行DOM更新

当观察到数据变化后,Vue将开启一个队列,缓冲所有在同一事件循环中发生的数据改变。缓冲策略的好处就是去重,这就避免了同一个DOM重复的数据计算。

上文的例子中,当show被置为true后,组件<v-dialog/>并没有被立即渲染,而是被放到了下一个‘tick’中更新。这就是打断点后整个dialog依旧是dispaly:none的原因了。那怎么解决这个问题呢?文档里提到了Vue.nextTick(callback)。稍作修改,效果立马显现。

new Vue({
  ...
  watch: {
    show(val) {
      if (!val) return;
      // Dialog haven't been rendered
      this.$nextTick( () => {
        // Dialog DOM rendering finishes
        this.$refs.txt.focus();
      });
    },
  }
})
success

nextTick

当然,使用Vue API,假若知其然不知其所以然,并不能给我们带来太大帮助。我们还是得看看原理的:Vue实现响应式并不是数据变化后立即更新DOM的,而是根据一定策略在下一个时间点(next tick)里响应DOM变化。具体怎么实现,有兴趣的小伙伴可以看一下vue源码Watcher这一块的update方式。有点复杂我这里就不深入讲解了。

不过,所有的实现最终依靠的是src/core/util/next-tick.js这个文件里的函数——nextTick。内容不多,加上大段的注释也就100来行。我摘抄了核心部分——timerFunc实现:

const callbacks = []
let pending = false

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

let timerFunc // core function

if (typeof Promise !== 'undefined' && isNative(Promise)) {
  const p = Promise.resolve()
  timerFunc = () => {
    p.then(flushCallbacks)
  }
} else if (!isIE && typeof MutationObserver !== 'undefined' && (
  isNative(MutationObserver) ||
  MutationObserver.toString() === '[object MutationObserverConstructor]'
)) {
  let counter = 1
  const observer = new MutationObserver(flushCallbacks)
  const textNode = document.createTextNode(String(counter))
  observer.observe(textNode, {
    characterData: true
  })
  timerFunc = () => {
    counter = (counter + 1) % 2
    textNode.data = String(counter)
  }
} else if (typeof setImmediate !== 'undefined' && isNative(setImmediate)) {

  timerFunc = () => {
    setImmediate(flushCallbacks)
  }
} else {
  // Fallback to setTimeout.
  timerFunc = () => {
    setTimeout(flushCallbacks, 0)
  }
}

有点长,但是代码还挺容易看懂的,主要工作就是根据浏览器的兼容情况选择timerFunc的不同实现方法。timerFunc作为nextTick的核心模块,说白了,主要功能就是将回调函数延迟到下一个tick执行: 默认是Promise实现的,在IE里用的是MutationObserver,对那些更古老的浏览器,就用setImmediate或是setTime实现。从timerFunc可以看得出,vue团队主要精力还是在兼容各种版本的浏览器上。(汗)

Anyway,我们一般的开发也就兼容到IE为止了,所以Vue2的最终版将nextTick定性为了microtasks(我在以前的博客介绍过microtask和macrotask)。Microtask的好处是可以绕开一些事件操作的诡异行为,坏处就是会影响到冒泡和一些顺序执行的操作。我记得对nextTick的实现,Vue团队在microtask和macrotask之间反反复复了好几回,其中的tradeoff可见一斑。

nextTick最后部分是函数本体的实现,我们把上面timefunc部分精简一下放到一起:

const callbacks = []
let pending = false

function flushCallbacks () {
  pending = false
  callbacks.forEach( cb => cb() )
}

let timerFunc = () => {
    Promise.resolve().then(flushCallbacks)
}

function nextTick (cb, ctx) {
    let _resolve
    callbacks.push(() => {
       cb ? cb.call(ctx) : _resolve(ctx)
    })

    if (!pending) {
        pending = true
        timerFunc()
    }

    if (!cb) {
        return new Promise((resolve) => {
            _resolve = resolve
        })
    }
}

如上所示,调用nextTick时,既可以传入回调函数,又可以Promise化。前者是将所有回调压入callbacks数组,最后在下一个microTask(Promise.resolve().then)里执行flushCallbacks操作;后者是当_resolve函数执行(在flushCallbacks同一个microTask里),等再下一个microTask里执行then逻辑操作。我们试一下最后的Demo:

nextTick().then( () => {
    console.log('Onion')
})

nextTick(() => {
    console.log('Hello')
})

nextTick().then( () => {
    console.log('Garlic')
})

nextTick(() => {
    console.log('World')
})

输出如下,正如预期一样,Hello和World在第一个microTask里,Onion和Garlic在接下来的两个microTask里。

Hello
World
Onion
Garlic

总结

今天借着某个常见的需求介绍了一下vue nextTick的知识。我们了解到数据变化到DOM渲染是一个异步过程,发生在不同的tick里。虽然Vue.js通常鼓励开发人员沿着“数据驱动”的方式实现代码,尽量避免直接接触DOM。但是有时候不得不操作DOM,我们可以在数据变化后立即使用vm.nextTick(cb),这样回调函数会在DOM更新后执行。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,324评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,303评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,192评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,555评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,569评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,566评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,927评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,583评论 0 257
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,827评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,590评论 2 320
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,669评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,365评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,941评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,928评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,159评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,880评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,399评论 2 342

推荐阅读更多精彩内容

  • 找了一个实习,去公司做数据的可视化,就是用iview-admin,Echarts做一下展示。中间遇到了一个问题数据...
    小白小白啦阅读 8,670评论 1 8
  • Vue中的nextTick涉及到Vue中DOM的异步更新,感觉很有意思,特意了解了一下。其中关于nextTick的...
    Ruheng阅读 684,873评论 57 522
  • Vue之nextTick理解 前言 一开始就只想搞清楚nextTick的一个原理,谁知道,跟吃了辣条一下,停不下来...
    彭道宽阅读 859评论 1 0
  • 我是一个不喜读书的人,无论是读书时,除了必要的考试所需(当然,如此可推断出我是一个正正经经的理科生),还是在这几年...
    ZeroFan阅读 146评论 0 0
  • 年少时,对家乡没有特别的感触,总期盼外面更精彩的世界;而今,家乡总寓意着浓浓的人情味儿,成了我们内心的一方净土,一...
    Sarah66阅读 93评论 0 0