vue項目中實現緩存的最佳方案詳解

2019-11-19 11:11:50

字體：大中小

來源：轉載

供稿：網友

需求

在開發vue的項目中有遇到了這樣一個需求：一個視頻列表頁面，展示視頻名稱和是否收藏，點擊進去某一項觀看，可以收藏或者取消收藏，返回的時候需要記住列表頁面的頁碼等狀態，同時這條視頻的收藏狀態也需要更新, 但是從其他頁面進來視頻列表頁面的時候不緩存這個頁面，也就是進入的時候是視頻列表頁面的第一頁

一句話總結一下： pageAList->pageADetail->pageAList, 緩存pageAList, 同時該視頻的收藏狀態如果發生變化需要更新，其他頁面->pageAList, pageAList不緩存

在網上找了很多別人的方法，都不滿足我們的需求

然后我們團隊幾個人搗鼓了幾天，還真的整出了一套方法，實現了這個需求

實現后的效果

無圖無真相，用一張gif圖來看一下實現后的效果吧！??！

操作流程：

首頁->pageAList, 跳轉第二頁 ->首頁-> pageAList，頁碼顯示第一頁，說明從其他頁面進入pageAList, pageAList頁面沒有被緩存
pageAList，跳轉到第三頁，點擊視頻22 -> 進入視頻詳情頁pageADetail，點擊收藏，收藏成功，點擊返回 -> pageAList顯示的是第三頁，并且視頻22的收藏狀態從未收藏變成已收藏，說明從pageADetail進入pageAList，pageAList頁面緩存了，并且更新了狀態

說明：

二級緩存: 也就是從A->B->A，緩存A
三級緩存：A->B->C->B->A, 緩存A，B 因為項目里面絕大部分是二級緩存，這里我們就做二級緩存，但是這不代表我的這個緩存方法不適用三級緩存，三級緩存后面我也會講如何實現

實現二級緩存

用vue-cli2的腳手架搭建了一個項目，用這個項目來說明如何實現

先來看看項目目錄

刪除了無用的components目錄和assets目錄，新增了src/pages目錄和src/store目錄, pages頁面用來存放頁面組件， store不多說，存放vuex相關的東西,新增了server/app.js目錄，用來啟動后臺服務

1. 前提條件

項目引入vue，vuex, vue-router，axios等vue全家桶
引入element-ui，只是為了項目美觀，畢竟本人懶癌晚期，不想自己寫樣式
在config/index.js里面配置前端代理

引入express，啟動后臺，后端開3003端口，給前端提供api支持來看看服務端代碼server/app.js,非常簡單，就是造了30條數據，寫了3個接口，幾十行文件直接搭建了一個node服務器，簡單粗暴解決數據模擬問題，會mock用mock也行

const express = require('express')// const bodyParser = require('body-parser')const app = express()let allList = Array.from({length: 30}, (v, i) => ({ id: i, name: '視頻' + i, isCollect: false}))// 后臺設置允許跨域訪問// 前后端都是本地localhost，所以不需要設置cors跨域，如果是部署在服務器上，則需要設置// app.all('*', function (req, res, next) {// res.header('Access-Control-Allow-Origin', '*')// res.header('Access-Control-Allow-Headers', 'X-Requested-With')// res.header('Access-Control-Allow-Methods', 'PUT,POST,GET,DELETE,OPTIONS')// res.header('X-Powered-By', ' 3.2.1')// res.header('Content-Type', 'application/json;charset=utf-8')// next()// })app.use(express.json())app.use(express.urlencoded({extended: false}))// 1 獲取所有的視頻列表app.get('/api/getVideoList', function (req, res) { let query = req.query let currentPage = query.currentPage let pageSize = query.pageSize let list = allList.slice((currentPage - 1) * pageSize, currentPage * pageSize) res.json({ code: 0, data: {  list,  total: allList.length } })})// 2 獲取某一條視頻詳情app.get('/api/getVideoDetail/:id', function (req, res) { let id = Number(req.params.id) let info = allList.find(v => v.id === id) res.json({ code: 0, data: info })})// 3 收藏或者取消收藏視頻app.post('/api/collectVideo', function (req, res) { let id = Number(req.body.id) let isCollect = req.body.isCollect allList = allList.map((v, i) => { return v.id === id ? {...v, isCollect} : v }) res.json({code: 0})})const PORT = 3003app.listen(PORT, function () { console.log('app is listening port' + PORT)})

2. 路由配置

在路由配置里面把需要緩存的路由的meta添加keepAlive屬性，值為true, 這個想必大家都知道，是緩存路由組件的
在我們項目里面，需要緩存的路由是pageAList，所以這個路由的meta的keepAlive設置成true,其他路由正常寫，路由文件src/router/index.js如下：

import Vue from 'vue'import Router from 'vue-router'import home from '../pages/home'import pageAList from '../pages/pageAList'import pageADetail from '../pages/pageADetail'import pageB from '../pages/pageB'import main from '../pages/main'Vue.use(Router)export default new Router({ routes: [ {  path: '/',  name: 'main',  component: main,  redirect: '/home',  children: [  {   path: 'home',   name: 'home',   component: home  },  {   path: 'pageAList',   name: 'pageAList',   component: pageAList,   meta: {   keepAlive: true   }  },  {   path: 'pageB',   component: pageB  }  ] }, {  path: '/pageADetail',  name: 'pageADetail',  component: pageADetail } ]})

3. vuex配置

vuex的store.js里面存儲一個名為excludeComponents的數組,這個數組用來操作需要做緩存的組件

state.js

const state = { excludeComponents: [] }export default state

同時在mutations.js里面加入兩個方法， addExcludeComponent是往excludeComponents里面添加元素的，removeExcludeComponent是往excludeComponents數組里面移除元素

注意： 這兩個方法的第二個參數是數組或者組件name

mutations.js

const mutations = { addExcludeComponent (state, excludeComponent) { let excludeComponents = state.excludeComponents if (Array.isArray(excludeComponent)) {  state.excludeComponents = [...new Set([...excludeComponents, ...excludeComponent])] } else {  state.excludeComponents = [...new Set([...excludeComponents, excludeComponent])] } }, // excludeComponent可能是組件name字符串或者數組 removeExcludeComponent (state, excludeComponent) { let excludeComponents = state.excludeComponents if (Array.isArray(excludeComponent)) {  for (let i = 0; i < excludeComponent.length; i++) {  let index = excludeComponents.findIndex(v => v === excludeComponent[i])  if (index > -1) {   excludeComponents.splice(index, 1)  }  } } else {  for (let i = 0, len = excludeComponents.length; i < len; i++) {  if (excludeComponents[i] === excludeComponent) {   excludeComponents.splice(i, 1)   break  }  } } state.excludeComponents = excludeComponents }}export default mutations

4. keep-alive包裹router-view

將App.vue的router-view用keep-alive組件包裹， main.vue的路由也需要這么包裹，這點非常重要，因為pageAList組件是從它們的router-view中匹配的

<keep-alive :exclude="excludeComponents"><som-component></some-component></keep-alive>這個寫法大家應該不會陌生，這也是尤大神官方推薦的緩存方法, exclude屬性值可以是組件名稱字符串(組件選項的name屬性)或者數組，代表不緩存這些組件，所以vuex里面的addExcludeComponent是代表要緩存組件，addExcludeComponent代表不緩存組件，這里稍微有點繞，請牢記這個規則，這樣接下來你就不會被繞進去了。

App.vue

<template> <div id="app"> <keep-alive :exclude="excludeComponents">  <router-view v-if="$route.meta.keepAlive"></router-view> </keep-alive> <router-view v-if="!$route.meta.keepAlive"></router-view> </div></template><script>export default { name: 'App', computed: { excludeComponents () {  return this.$store.state.excludeComponents } }}</script

main.vue

<template> <div> <ul>  <li v-for="nav in navs" :key="nav.name">  <router-link :to="nav.name">{{nav.title}}</router-link>  </li> </ul> <keep-alive :exclude="excludeComponents">  <router-view v-if="$route.meta.keepAlive"></router-view> </keep-alive> <router-view v-if="!$route.meta.keepAlive"></router-view> </div></template><script>export default { name: 'main.vue', data () { return {  navs: [{  name: 'home',  title: '首頁'  }, {  name: 'pageAList',  title: 'pageAList'  }, {  name: 'pageB',  title: 'pageB'  }] } }, methods: { }, computed: { excludeComponents () {  return this.$store.state.excludeComponents } }, created () { }}</script>

接下來的兩點設置非常重要

5. 一級組件

對于需要緩存的一級路由pageAList，添加兩個路由生命周期鉤子beforeRouteEnter和beforeRouteLeave

import {getVideoList} from '../api'export default { name: 'pageAList', // 組件名稱，和組件對應的路由名稱不需要相同 data () { return {  currentPage: 1,  pageSize: 10,  total: 0,  allList: [],  list: [] } }, methods: { getVideoList () {  let params = {currentPage: this.currentPage, pageSize: this.pageSize}  getVideoList(params).then(r => {  if (r.code === 0) {   this.list = r.data.list   this.total = r.data.total  }  }) }, goIntoVideo (item) {  this.$router.push({name: 'pageADetail', query: {id: item.id}}) }, handleCurrentPage (val) {  this.currentPage = val  this.getVideoList() } }, beforeRouteEnter (to, from, next) { next(vm => {  vm.$store.commit('removeExcludeComponent', 'pageAList')  next() }) }, beforeRouteLeave (to, from, next) { let reg = /pageADetail/ if (reg.test(to.name)) {  this.$store.commit('removeExcludeComponent', 'pageAList') } else {  this.$store.commit('addExcludeComponent', 'pageAList') } next() }, activated () { this.getVideoList() }, mounted () { this.getVideoList() }}

beforeRouteEnter,進入這個組件pageAList之前，在excludeComponents移除當前組件，也就是緩存當前組件，所以任何路由跳轉到這個組件，這個組件其實都是被緩存的，都會觸發activated鉤子
beforeRouteLeave：離開當前頁面，如果跳轉到pageADetail,那么就需要在excludeComponents移除當前組件pageAList，也就是緩存當前組件，如果是跳轉到其他頁面，就需要把pageAList添加進去excludeComponents，也就是不緩存當前組件
獲取數據的方法getVideoList在mounted或者created鉤子里面調取，如果二級路由更改數據，一級路由需要更新，那么就需要在activated鉤子里再獲取一次數據，我們這個詳情可以收藏，改變列表的狀態，所以這兩個鉤子都使用了

6. 二級組件

對于需要緩存的一級路由的二級路由組件pageADetail，添加beforeRouteLeave路由生命周期鉤子

在這個beforeRouteLeave鉤子里面，需要先清除一級組件的緩存狀態，如果跳轉路由匹配到一級組件，再緩存一級組件

beforeRouteLeave (to, from, next) { let componentName = '' // 離開詳情頁時,將pageAList添加到exludeComponents里，也就是將需要緩存的頁面pageAList置為不緩存狀態 let list = ['pageAList'] this.$store.commit('addExcludeComponent', list) // 緩存組件路由名稱到組件name的映射 let map = new Map([['pageAList', 'pageAList']]) componentName = map.get(to.name) || '' // 如果離開的時候跳轉的路由是pageAList，將pageAList從exludeComponents里面移除，也就是要緩存pageAList this.$store.commit('removeExcludeComponent', componentName) next() }

7.實現方法總結

進入了pageAList，就在beforeRouteEnter里緩存了它，離開當前組件的時候有兩種情況：

1 跳轉進去pageADetail，在pageAList的beforeRouteLeave鉤子里面緩存pageAList，從pageADetail離開的時候，也有兩種情況

(1) 回到pageAList，那么在pageADetail的beforeRouteLeave鉤子里面緩存了pageAList，所以這就是從pageAList-pageADetail-pageAList的時候，pageAList可以被緩存，還是之前的頁碼狀態

(2) 進入其他路由，在pageADetail的beforeRouteLeave鉤子里面清除了pageAList的緩存

2 跳轉到非pageADetail的頁面，在pageAList的beforeRouteLeave鉤子里面清除pageAList的緩存

方案評估

自認為用這個方案來實現緩存，最終的效果非常完美了

缺點：