keep-alive 组件级缓存

前言

      在Vue构建的单页面应用（SPA）中，路由模块通常使用vue-router。vue-router不保存被切换组件的状态，

它进行push或者replace时，旧组件会被销毁，而新组件会被新建，走一遍完整的生命周期。

但有时候，咱们有一些需求，好比跳转到详情页面时，须要保持列表页的滚动条的深度，等返回的时候依然在这个位置，这样能够提升用户体验。

在Vue中，对于这种“页面缓存”的需求，咱们可使用keep-alive组件来解决这个需求。

keep-alive

keep-alive是个抽象组件（或称为功能型组件），实际上不会被渲染在DOM树中。

它的做用是在内存中缓存组件（不让组件销毁），等到下次再渲染的时候，还会保持其中的全部状态，而且会触发activated钩子函数。

由于缓存的须要一般出如今页面切换时，因此常与router-view一块儿出现：

<keep-alive>
    <router-view />
</keep-alive>

可使用keep-alive组件的 include/exclude属性。

include属性表示要缓存的组件名（即组件定义时的name属性），

接收的类型为 string、 RegExp或 string数组；

exclude属性有着相反的做用，匹配到的组件不会被缓存。

假如可能出如今同一router-view的N个页面中，我只想缓存列表页和详情页，那么能够这样写：

<keep-alive :include="['Home', 'User']">
  <router-view />
</keep-alive>

vue实现前进刷新，后退不刷新

但愿实现前进刷新、后退不刷新的效果。即加载过的界面能缓存起来（返回不用从新加载），关闭的界面能被销毁掉（再进入时从新加载）。

例如对a->b->c 前进（b,c）刷新，c->b->a 后退（b,a）不刷新

知道路由是前进仍是后退就行了，

这样的话我就能在后退的时候让from路由的keepAlive置为false ，

to路由的keepAlive置为ture，就能在再次前进时，从新加载以前这个keepAlive被置为false的路由了

可是這個须要集合鈎子函數來是實現

// App.vue

<div class="app">
    <keep-alive>
      <router-view v-if="$route.meta.keepAlive"></router-view>
    </keep-alive>
    <router-view v-if="!$route.meta.keepAlive"></router-view>
</div>

下面在router/index.js即咱们的路由文件中，定义meta信息：

// list是咱们的搜索结果页面
{      
    path: '/list',  
    name: 'List',      
    component: resolve => require(['@/pages/list'], resolve),    
    meta: {        
        isUseCache: false,  // 这个字段的意思稍后再说      
        keepAlive: true  // 经过此字段判断是否须要缓存当前组件  
    }    
}

 

说这以前，先简单说一下和缓存相关的vue钩子函数。

设置了keepAlive缓存的组件：

       第一次进入：beforeRouterEnter ->created->…->activated->…->deactivated

       后续进入时：beforeRouterEnter ->activated->deactivated

 

能够看出，只有第一次进入该组件时，才会走created钩子，而须要缓存的组件中activated是每次都会走的钩子函数。

因此，咱们要在这个钩子里面去判断，当前组件是须要使用缓存的数据仍是从新刷新获取数据。思路有了，下面咱们来实现

// list组价的activated钩子
 activated() {
    // isUseCache为false时才从新刷新获取数据
    // 由于对list使用keep-alive来缓存组件，因此默认是会使用缓存数据的         
    if(!this.$route.meta.isUseCache){            
        this.list = []; // 清空原有数据
        this.onLoad(); // 这是咱们获取数据的函数
    } 
}

这里的isUseCache 其实就是咱们用来判断是否须要使用缓存数据的字段，咱们在list的路由的meta中已经默认设置为false，因此第一次进入list时是获取数据的。

当咱们从详情页返回时，咱们把list页面路由的isUseCache设置成true，这样咱们在返回list页面时会使用缓存数据

// 详情页面的beforeRouteLeave钩子函数
beforeRouteLeave (to, from, next) {        
    if (to.name == 'List') {
        to.meta.isUseCache = true;    
    }        
    next();
}

咱们这里是在即将离开detail页面前判断是否返回的列表页。

若是是返回list页面，则把list页面路由的isUseCache字段设置成true。为何这样设置呢？

由于咱们对list组件使用的keep-alive进行缓存组件，其默认就是使用缓存的。

而咱们又在list组件的actived钩子函数中进行了判断：

   只有在list页面的isUseCache==false时才会清空原有数据并从新获取数据。

  因此此处设置isUseCache为true，此时返会list页面是不会从新获取数据的，而是使用的缓存数据。

  detail返回list能够缓存数据了，那么search前往list页面时怎么让list页面不使用缓存数据而是获取新数据呢？咱们从新回到list的activated钩子中：

// list组价的activated钩子
 activated() {
    // isUseCache为false时才从新刷新获取数据
    // 由于对list使用keep-alive来缓存组件，因此默认是会使用缓存数据的         
    if(!this.$route.meta.isUseCache){            
        this.list = []; // 清空原有数据
        this.onLoad(); // 这是咱们获取数据的函数
        this.$route.meta.isUseCache = false;    } 
}

咱们加了一行this.$route.meta.isUseCache=false;也就是从detail返回list后，将list的isUseCache字段为false，

而从detail返回list前，咱们设置了list的isUseCache为true。

因此，只有从detail返回list才使用缓存数据，而其余页面进入list是从新刷新数据的。

至此，一个前进刷新、后退返回的功能基本完成了

场景还原实际

好比，若是这个详情页是个订单详情，那么在订单详情页可能会有删除订单的操做。

那么删除订单操做后会返回订单列表页，是须要列表页从新刷新的。

那么咱们须要此时在订单详情页进行是否要刷新的判断。简单改造一下详情页：

data () {    
    return {
        isDel: false  // 是否进行了删除订单的操做       
    }
},
beforeRouteLeave (to, from, next) {        
    if (to.name == 'List') {
        // 根据是否删除了订单的状态，进行判断list是否须要使用缓存数据
        to.meta.isUseCache = !this.isDel;                
    }        
    next();    
},
methods: {        
    deleteOrder () {       
        // 这里是一些删除订单的操做

        // 将状态变为已删除订单
        // 因此beforeRouteLeave钩子中就会将list组件路由的isUseCache设置为false    
        // 因此此时再返回list时，list是会从新刷新数据的 
        this.isDel = true; 
        this.$router.go(-1)
    }
}

 

另外用Vuex来实现后退功能

然後在一篇博客中看到是用Vuex來寫的，因此這邊也本身demo了下：

就是下面的代碼了：

 

实现条件缓存：全局的include数组

只须要将B动态地从include数组中增长/删除就好了

      在Vuex中定义一个全局的缓存数组，待传给include：

 

export default {
  namespaced: true,
  state: {
    keepAliveComponents: [] // 缓存数组
  },
  mutations: {
    keepAlive (state, component) {
      // 注：防止重复添加（固然也可使用Set）
      !state.keepAliveComponents.includes(component) && 
        state.keepAliveComponents.push(component)
    },
    noKeepAlive (state, component) {
      const index = state.keepAliveComponents.indexOf(component)
      index !== -1 &&
        state.keepAliveComponents.splice(index, 1)
    }
  }
}

   在父页面中定义keep-alive，并传入全局的缓存数组：

// App.vue

<div class="app">
  <!--传入include数组-->
  <keep-alive :include="keepAliveComponents">
    <router-view></router-view>
  </keep-alive>
</div>

export default {
  computed: {
    ...mapState({
      keepAliveComponents: state => state.global.keepAliveComponents
    })
  }
}

 缓存：在路由配置页中，约定使用meta属性keepAlive，值为true表示组件须要缓存。

在全局路由钩子beforeEach中对该属性进行处理，这样一来，每次进入该组件，都进行缓存：

const router = new Router({
  routes: [
    {
      path: '/A/B',
      name: 'B',
      component: B,
      meta: {
        title: 'B页面',
        keepAlive: true // 这里指定B组件的缓存性
      }
    }
  ]
})

router.beforeEach((to, from, next) => {
  // 在路由全局钩子beforeEach中，根据keepAlive属性，统一设置页面的缓存性
  // 做用是每次进入该组件，就将它缓存
  if (to.meta.keepAlive) {
    store.commit('global/keepAlive', to.name)
  }
})

取消缓存的时机：对缓存组件使用路由的组件层钩子beforeRouteLeave。

由于B->A->B时不须要缓存B，因此能够认为：当B的下一个页面不是C时取消B的缓存，那么下次进入B组件时B就是全新的：

export default {
  name: 'B',
  created () {
      // ...设置滚动条在最顶部
  },
  beforeRouteLeave (to, from, next) {
    // 若是下一个页面不是详情页（C），则取消列表页（B）的缓存
    if (to.name !== 'C') {
        this.$store.commit('global/noKeepAlive', from.name)
    }
    next()
  }
}

由于B的条件缓存，是B本身的职责，因此最好把该业务逻辑写在B的内部，而不是A中，这样不至于让组件之间的跳转关系变得混乱。

一个须要注意的细节：由于keep-alive组件的include数组操做的对象是组件名、而不是路由名，

所以咱们定义每个组件时，都要显式声明name属性，不然缓存不起做用。并且，一个显式的name对Vue devtools有提示做用。