關(guān)于Vue3過渡動畫的踩坑記錄

更新時間：2021年12月26日 15:26:11 作者：黃軼黃老師

在開發(fā)中我們想要給一個組件的顯示和消失添加某種過渡動畫,可以很好的增加用戶體驗(yàn),下面這篇文章主要給大家介紹了關(guān)于Vue3過渡動畫踩坑的相關(guān)資料,需要的朋友可以參考下

背景

在我的《Vue 3 開發(fā)企業(yè)級音樂 App》課程問答區(qū)，有個同學(xué)提了個問題，在歌手列表到歌手詳情頁面到轉(zhuǎn)場動畫中，只有進(jìn)入動畫，卻沒有離場動畫：

該學(xué)生確實(shí)在這個問題上研究了有一段時間，而且從他的描述，我一時半會兒也想不出哪有問題，于是讓他把代碼傳到 GitHub 上，畢竟直接從代碼層面定位問題是最靠譜的。

問題定位

一般遇到此類問題的時候，我的第一反應(yīng)是他用的 Vue 3 版本可能有問題，畢竟 Vue 3 還在不斷迭代過程，某個版本有一些小 bug 是很正常的，于是我把他的項(xiàng)目的 Vue 3 版本升級到了最新的 3.2.26。

但運(yùn)行后發(fā)現(xiàn)，該問題仍然存在。我感到有些困惑，于是跑了一下自己課程項(xiàng)目源碼，并沒有復(fù)現(xiàn)該問題，然后我又把自己課程項(xiàng)目的 Vue 3 版本也升級到最新，仍然沒有復(fù)現(xiàn)該問題。

通過上述分析，我基本排除了 Vue 3 版本的問題。本質(zhì)上說，從歌手頁面切換到歌手詳情頁無非就是打開歌手詳情頁這個二級路由頁面，而從歌手詳情頁退回到歌手頁面無非就是移除歌手詳情頁這個二級路由頁面。于是我開始對比兩邊項(xiàng)目的歌手頁面以及詳情頁的源碼：

<!-- singer.vue -->

<template>

<div class="singer" v-loading="!singers.length">

  <index-list

    :data="singers"

    @select="selectSinger"

  ></index-list>

  <!-- 用router-view去承載二級路由 -->

<!--  <router-view :singer="selectedSinger"></router-view>-->

  <!-- vue3需要在router-view中使用transition, appear進(jìn)入時候也會有動畫 -->

  <router-view v-slot="{ Component }">

<!--  singer-detail返回動畫無效 研究  -->

    <transition appear name="slide">

      <!-- component動態(tài)組件Component就是作用域插槽中的一個屬性，這個是由router-view這個組提供的

       Component就是你的路由表中的路由組件

       exclude="singer-detail"排除不緩存數(shù)據(jù)的組件否則會緩存數(shù)據(jù)導(dǎo)致每次數(shù)據(jù)都不重新請求

       -->

        <component :is="Component"

                   :singer="selectedSinger"

        ></component>

    </transition>

  </router-view>

</div>

</template>



<!-- singer-detail.vue -->

<template>

  <!-- 因?yàn)橥ㄟ^二級路由實(shí)現(xiàn),所以放在views下 -->

  <section class="singer-detail">

    <music-list

      :songs="songs"

      :title="title"

      :pic="pic"

      :loading="loading"

    ></music-list>

  </section>

</template>

上邊是學(xué)生的代碼，接下來貼一下我項(xiàng)目的源碼：

<!-- singer.vue -->

<template>

  <div class="singer" v-loading="!singers.length">

    <index-list

      :data="singers"

      @select="selectSinger"

    ></index-list>

    <router-view v-slot="{ Component }">

      <transition appear name="slide">

        <component :is="Component" :data="selectedSinger"/>

      </transition>

    </router-view>

  </div>

</template>

<!-- singer-detail.vue -->

<template>

  <div class="singer-detail">

    <music-list

      :songs="songs"

      :title="title"

      :pic="pic"

      :loading="loading"

    ></music-list>

  </div>

</template>

經(jīng)過對比，我感覺兩邊的源碼差別并不大，除了該學(xué)生會用注釋做一些學(xué)習(xí)筆記。一時間難以找出問題，于是我祭出了殺手锏——調(diào)試源碼。因?yàn)楫吘箤τ?Vue 3 過渡動畫的實(shí)現(xiàn)原理，我還是如數(shù)家珍的。

如果執(zhí)行了退出過渡動畫，則一定會執(zhí)行 transition 組件包裹的子節(jié)點(diǎn)解析出的 leave 鉤子函數(shù)。

于是我在 leave 鉤子函數(shù)內(nèi)部加了個 debugger 斷點(diǎn)：

// @vue/runtime-core/dist/runtime.core-bundler.esm.js

leave(el, remove) {

  debugger

  const key = String(vnode.key);

  if (el._enterCb) {

    el._enterCb(true /* cancelled */);

  }

  // ...

}

接著運(yùn)行項(xiàng)目，當(dāng)我從歌手詳情頁回退到歌手頁面的時候，發(fā)現(xiàn)并沒有進(jìn)入 debugger 斷點(diǎn)，也就意味著 leave 鉤子函數(shù)壓根沒有執(zhí)行。

再往前追溯，對于即將卸載的節(jié)點(diǎn)，執(zhí)行其 leave 鉤子函數(shù)的時機(jī)是在執(zhí)行 remove 函數(shù)時，于是我在 remove 函數(shù)內(nèi)部打上斷點(diǎn)：

// @vue/runtime-core/dist/runtime.core-bundler.esm.js

const remove = vnode => {

  debugger

  const { type, el, anchor, transition } = vnode;

  if (type === Fragment) {

    removeFragment(el, anchor);

    return;

  }

  if (type === Static) {

    removeStaticNode(vnode);

    return;

  }

  const performRemove = () => {

    hostRemove(el);

    if (transition && !transition.persisted && transition.afterLeave) {

      transition.afterLeave();

    }

  };

  if (vnode.shapeFlag & 1 /* ELEMENT */ &&

    transition &&

    !transition.persisted) {

    const { leave, delayLeave } = transition;

    const performLeave = () => leave(el, performRemove);

    if (delayLeave) {

      delayLeave(vnode.el, performRemove, performLeave);

    }

    else {

      performLeave();

    }

  }

  else {

    performRemove();

  }

};

接著再次運(yùn)行項(xiàng)目，當(dāng)我從歌手詳情頁回退到歌手頁面的時候，雖然進(jìn)入了斷點(diǎn)，但也發(fā)現(xiàn)了一些代碼的邏輯問題：從 vnode 解析到了對應(yīng)的 transition 對象，由于其對應(yīng)的 type 是 Fragment，執(zhí)行進(jìn)入了下面這段邏輯：

if (type === Fragment) {

  removeFragment(el, anchor);

  return;

}

直接返回并沒有執(zhí)行后續(xù) transition 對象的 leave 鉤子函數(shù)。我繼續(xù)查看 vnode 的值，發(fā)現(xiàn)它有兩個子節(jié)點(diǎn)，一個注釋節(jié)點(diǎn)和一個 section 節(jié)點(diǎn)。我恍然大悟，原來是學(xué)生寫的注釋導(dǎo)致的問題：

<!-- singer-detail.vue -->

<template>

  <!-- 因?yàn)橥ㄟ^二級路由實(shí)現(xiàn),所以放在views下 -->

  <section class="singer-detail">

    <music-list

      :songs="songs"

      :title="title"

      :pic="pic"

      :loading="loading"

    ></music-list>

  </section>

</template>

在 Vue 的模版解析中，遇到 HTML 注釋，也會把它解析成一個注釋節(jié)點(diǎn)，可以借助 Vue 3 的模版導(dǎo)出工具看一下它編譯后的結(jié)果：

import { createCommentVNode as _createCommentVNode, resolveComponent as _resolveComponent, createVNode as _createVNode, createElementVNode as _createElementVNode, Fragment as _Fragment, openBlock as _openBlock, createElementBlock as _createElementBlock } from "vue"

const _hoisted_1 = { class: "singer-detail" }

function render(_ctx, _cache) {

  const _component_music_list = _resolveComponent("music-list")

  return (_openBlock(), _createElementBlock(_Fragment, null, [

    _createCommentVNode(" 因?yàn)橥ㄟ^二級路由實(shí)現(xiàn),所以放在views下 "),

    _createElementVNode("section", _hoisted_1, [

      _createVNode(_component_music_list, {

        songs: _ctx.songs,

        title: _ctx.title,

        pic: _ctx.pic,

        loading: _ctx.loading

      }, null, 8 /* PROPS */, ["songs", "title", "pic", "loading"])

    ])

  ], 2112 /* STABLE_FRAGMENT, DEV_ROOT_FRAGMENT */))

}

由于 Vue 3 支持了模版可以有不止一個的根節(jié)點(diǎn)，上述模版的根就會被解析成一個 Fragment 節(jié)點(diǎn)，這就導(dǎo)致了該組件在移除的時候并不會執(zhí)行對應(yīng)的過渡動畫。

進(jìn)一步分析

那么為啥 Fragment 節(jié)點(diǎn)就不需要過渡動畫呢？我找到了代碼對應(yīng)的提交注釋：

fix(fragment): perform direct remove when removing fragments This avoids trying to grab .el from hoisted child nodes (which can be created by another instance), and also skips transition check since fragment children cannot have transitions.

注釋給的解釋就是 Fragment 節(jié)點(diǎn)不可以有 transition 過渡。但這里還有一個問題，為什么這么寫不會影響進(jìn)入過渡動畫呢？

因?yàn)樵谶\(yùn)行時執(zhí)行組件 render 函數(shù)渲染組件的子樹 subTree 的時候，renderComponentRoot 函數(shù)內(nèi)部做了一些特殊處理：

function renderComponentRoot(instance) {

  let result

  // ...

  // call render funtion to get the result

  // attr merging

  // in dev mode, comments are preserved, and it's possible for a template

  // to have comments along side the root element which makes it a fragment

  let root = result;

  let setRoot = undefined;

  if ((process.env.NODE_ENV !== 'production') &&

    result.patchFlag > 0 &&

    result.patchFlag & 2048 /* DEV_ROOT_FRAGMENT */) {

    [root, setRoot] = getChildRoot(result);

  }

  // inherit transition data

  if (vnode.transition) {

    // ...

    root.transition = vnode.transition;

  }

  return result

}

在通過執(zhí)行組件實(shí)例的 render 方法拿到渲染的子樹后，在開發(fā)環(huán)境下通過 getChildRoot 函數(shù)對注釋節(jié)點(diǎn)做了一層過濾，得到結(jié)果 root，并且給它的根節(jié)點(diǎn)繼承了其 parent vnode 的 transition 對象。但是注意到，整個 renderComponentRoot 返回的還是 result 對象。

對于我們的示例 SingerDetil 歌手詳情組件，它的子樹 vnode 是一個 Fragment，但是在執(zhí)行 renderComponentRoot 的時候，由于第一個節(jié)點(diǎn)是注釋節(jié)點(diǎn)，則被過濾，只有后面的實(shí)體節(jié)點(diǎn) singer-detail 對應(yīng)的 vnode 才有 transition 屬性，因此它有進(jìn)入過渡動畫。

但是在組件移除的時候，由于組件的子樹 vnode 是一個 Fragment，因此不會有離開過渡動畫。