如何管理Vue中的緩存頁面

Posted on by 
<keep-alive>
 <router-view />
</keep-alive>

Vue中內置的<keep-alive>組件可以幫助我們在開發SPA應用時，通過把全部路由頁面進行緩存(當然也可以有針對性的緩存部分頁面)，顯著提高頁面二次訪問速度，但是也給我們在某些場景帶來瞭困擾，其中包含兩個主要矛盾：

  1. 緩存頁面如何在合適的時機被銷毀 （keep-alive組件提供瞭三個參數來動態配置緩存狀態，但是作用有限，後面分析）
  2. 同一個路徑如何緩存多個不同的頁面(同頁不同參)，比如淘寶商品頁面繼續跳轉另一個商品頁面

本文主要圍繞這兩個問題探討，後文用問題一和問題二指代。

本文默認所有頁面都是keep-alive

問題一 銷毀

當隨著業務邏輯變得復雜，路由棧也逐漸升高，理論上用戶可以無限的路由下去，不可避免的我們需要管理這些緩存在內存中的頁面數據，頁面數據包含兩部分，Vue實例和對應的Vnode。查看 Vue 源碼中src/core/components/keep-alive.js關於緩存的定義

 this.cache = Object.create(null) //用來緩存vnode cache[key] => Vnode
 this.keys = [] //用來記錄已緩存的vnode的key

緩存後並不會重用 Vnode，而是隻用它上面掛載的 Vue 實例。

if (cache[key]) {
 vnode.componentInstance = cache[key].componentInstance //僅從緩存的vnode中獲取vue實例掛在到新的vnode上
 // make current key freshest
 remove(keys, key)
 keys.push(key)
}

為什麼不用呢，因為有BUG，最早一版實現裡確實是會直接使用緩存的 Vnode。

出自src/core/components/keep-alive.js init version

export default {
 created () {
 this.cache = Object.create(null)
 },
 render () {
 const childNode = this.$slots.default[0]
 const cid = childNode.componentOptions.Ctor.cid
 if (this.cache[cid]) {
  const child = childNode.child = this.cache[cid].child //直接獲取緩存的vnode
  childNode.elm = this.$el = child.$el
 } else {
  this.cache[cid] = childNode
 }
 childNode.data.keepAlive = true
 return childNode
 },
 beforeDestroy () {
 for (const key in this.cache) {
  this.cache[key].child.$destroy()
 }
 }
}

我們需要管理的其實就是cache和keys，keep-alive提供瞭三個參數來動態管理緩存：

include - 隻有名稱匹配的組件會被緩存。
exclude - 任何名稱匹配的組件都不會被緩存。
max - 最多可以緩存多少組件實例。

它們的作用非常簡單，源碼寫的也很簡單易讀：

所以當我們想要管理這些緩存時，簡單的方案就是操作這三個參數，修改include和exclude來緩存或者清除某些緩存，但是需要註意的是它們匹配的是組件的name：

出自src/core/components/keep-alive.js

const name: ?string = getComponentName(componentOptions)

所以清除緩存是會無差別的把某個組件的所有實例全部清除，這顯然不滿足我們的需求。

max的邏輯則是超過最大值時清除棧底的緩存，

出自src/core/components/keep-alive.js：

if (this.max && keys.length > parseInt(this.max)) {
 pruneCacheEntry(cache, keys[0], keys, this._vnode)
}

我們要解決問題一，官方提供給的API走不通，我們隻能自己來瞭，我們需要的是解決兩個子問題：

  1. 什麼時候銷毀
  2. 怎麼銷毀

1. 怎麼銷毀

先看怎麼銷毀，如果想銷毀一個實例很簡單，可以直接用 this.$destroy(), 這樣可以嗎，不行，這樣緩存cache和keys中依舊保留瞭原來的vnode和key，再次訪問時就會出現問題，vnode一直被留存，但是它身上的實例已經被銷毀瞭，這時候在vue的update過程中就會再去創建一個vue實例，也就是說隻要某個keep-alive的頁面調用過一次this.$destroy()，但是沒有清理緩存數組，這個頁面之後被重新渲染時就一定會重新創建一個實例，當然重新走全部的生命周期。現象最終就是這個頁面就像是沒有被緩存一樣。

this.$destroy(); //不適合keep-alive組件

所以銷毀需要同時清理掉緩存cache和keys，下面定義瞭一個同時清除緩存的$keepAliveDestroy方法：

 const dtmp = Vue.prototype.$destroy;
 const f = function() {
 if (this.$vnode && this.$vnode.data.keepAlive) {
  if (this.$vnode.parent && this.$vnode.parent.componentInstance && this.$vnode.parent.componentInstance.cache) {
  if (this.$vnode.componentOptions) {
   var key = !isDef(this.$vnode.key)
   ? this.$vnode.componentOptions.Ctor.cid + (this.$vnode.componentOptions.tag ? `::${this.$vnode.componentOptions.tag}` : '')
   : this.$vnode.key;
   var cache = this.$vnode.parent.componentInstance.cache;
   var keys = this.$vnode.parent.componentInstance.keys;
   if (cache[key]) {
   if (keys.length) {
    var index = keys.indexOf(key);
    if (index > -1) {
    keys.splice(index, 1);
    }
   }
   delete cache[key];
   }
  }
  }
 }
 dtmp.apply(this, arguments);
 }
 Vue.prototype.$keepAliveDestroy = f;

2. 什麼時候銷毀

那麼什麼時候銷毀呢，有兩個觸發時機：

  1. replace時，頁面A –replace–> 頁面B （清除頁面A）
  2. route back時 ,頁面A –push–> 頁面B –back–> 頁面A （清除頁面B）

replace 比較簡單，我們可以直接攔截router的replace方法，在該方法中清除掉當前頁面。（這裡也有例外，比如切換Tab時，最後再說）

我們具體來看看route back這種情況，如果說我們的頁面上有一個返回鍵，那麼在這裡清除緩存是非常正確的時機，但是我們不能忽略瀏覽器自帶的返回鍵和安卓機上的物理返回鍵，這種情況考慮進來以後，僅使用返回鍵的方案就不能滿足瞭。

2.1 方案一 使用route.query 記錄當前頁面棧深度

每次push或者replace是都增加query上一個參數，來記錄當前深度

this.$router.push({
 path:"/targer",
 query:{
 stackLevel:Number(this.$route.query.stackLevel) + 1 	
 }
})

這個方案有明顯弊端，外部暴露一個參數是非常醜陋且危險的，用戶可以隨便修改，在進行網頁推廣時，業務去生產環境自己拷貝到的推廣鏈接也可能帶著一個奇怪的 https://xxx.com/foo?bar=123&stackLevel=13後綴。棄用

2.2 方案二 使用Vue實例自身記錄當前棧深度

hack掉router的push和replace方法以後,每次跳轉的時候都可以給目標頁的vm掛載一個_stackLevel,這樣就解決瞭方案一的問題，不暴露給用戶，URL中不可見，也無法修改，但是我們不能忽視瀏覽器中另一個惡魔——刷新鍵,在刷新的時候URL不會變，但是vm實例就需要重新創建瞭，那麼我們的棧深度標示也就丟失瞭。棄用

2.3 方案三 使用history.state記錄棧深度

那麼最終就是既可以對用戶不可見，又可以在刷新的時候得以保存。那就是history.state瞭，所以我們需要做的就是把stack深度保存到history.state中，它能夠完整的保存整個路由鏈條。

當我們獲取到目標頁面棧深度小於當前頁面時，我們就可以銷毀當前頁面瞭。

if(target.stack < current.stack){
 current.$keepAliveDestroy();
}

問題二 同頁不同參緩存多個實例

可以在源碼中看到 src/core/components/keep-alive.js

const key: ?string = vnode.key == null
 // same constructor may get registered as different local components
 // so cid alone is not enough (#3269)
 ? componentOptions.Ctor.cid + (componentOptions.tag ? `::${componentOptions.tag}` : '')
 : vnode.key
 if (cache[key]) {
 vnode.componentInstance = cache[key].componentInstance
 // make current key freshest
 remove(keys, key)
 keys.push(key)
 } else {
 cache[key] = vnode
 keys.push(key)
 // prune oldest entry
 if (this.max && keys.length > parseInt(this.max)) {
  pruneCacheEntry(cache, keys[0], keys, this._vnode)
 }
 }

一個vnode如果沒有key才會使用組件名，所以默認緩存中的key是組件名，如果組件相同時，我們在每個頁面都有自己的key就可以解決這個問題瞭，如何實現每個頁面擁有自己的key呢。有兩個子問題：

  1. 如何做到唯一
  2. 如何把key賦值給頁面的vnode

1. 如何做到唯一

1.1 時間戳、超大隨機數

key = Date.now()

1.2 路由棧高度+路徑名

key = vm._stack + router.currentRoute.path 這個方案利用當前的棧高度+路徑名，為什麼需要路徑名呢，因為replace的時候棧高度不變，隻是路徑名變瞭。

2. 如何把key賦值給頁面的vnode

目前有兩個方案給vue-router當前的Vnode的key來賦值：

2.1 通過route.query動態綁定Key

這個方案實現比較簡單

//綁定key
...
<router-view :key='$route.query.routerKey' />
...


//push時
this.$router.push({
 path:"/foo",
 query:{
 	routerKey: Date.now() //隨機key
 }
})

這種方式用起來非常簡單有效，但是缺點同樣也是會暴露一個奇怪的參數在URL中

2.2 通過獲取到Vnode直接賦值

在哪個階段給Vnode的key賦值呢，答案顯而易見，在keep-alive組件render函數進入前， src/core/components/keep-alive.js

...
 render () {
 const slot = this.$slots.default
 const vnode: VNode = getFirstComponentChild(slot)
...

我們可以hack掉keep-alive的render函數，然後在這之前先把slot裡的第一個子節點拿到以後，給它的key進行賦值，然後再調用 keep-alive的render：

const tmp = vm.$options.render //vm is keep-alive component instance
vm.$options.render = function() {
 const slot = this.$slots.default;
 const vnode = getFirstComponentChild(slot) // vnode is a keep-alive-component-vnode
 if (historyShouldChange) {
 if (!isDef(vnode.key)) {
  if (isReplace) {
  vnode.key = genKey(router._stack)
  } else if (isPush()) {
  vnode.key = genKey(Number(router._stack) + 1)
  } else {
  vnode.key = genKey(Number(router._stack) - 1)
  }
 }
 } else {
 // when historyShouldChange is false should rerender only, should not create new vm ,use the same vnode.key issue#7
 vnode.key = genKey(router._stack)
 }
 return tmp.apply(this, arguments)
}

總結

通過以上對於問題的分析，我們就解決瞭自動管理緩存的核心難題。本文是對開源庫 vue-router-keep-alive-helper 的一次總結，此庫是款簡單易用的keep-alive緩存自動化管理工具，從此告別Vue緩存管理難題。如果對你有用，感謝慷慨Star。

演示Demo Sample Code

Bilibili演示視頻 感謝三連。

以上就是如何管理Vue中的緩存頁面的詳細內容，更多關於vue 緩存頁面的資料請關註WalkonNet其它相關文章！

推薦閱讀：