欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

修改vue源码实现动态路由缓存的方法

程序员文章站 2022-06-22 14:06:23
动态路由 官网解读 :我们经常需要把某种模式匹配到的所有路由,全都映射到同个组件。例如,我们有一个 user 组件,对于所有 id 各不相同的用户,都要使用这个组件来渲染。那么,我们...

动态路由

官网解读 :我们经常需要把某种模式匹配到的所有路由,全都映射到同个组件。例如,我们有一个 user 组件,对于所有 id 各不相同的用户,都要使用这个组件来渲染。那么,我们可以在 vue-router 的路由路径中使用“动态路径参数”(dynamic segment) 来达到这个效果。

即如果你有一个 盘点录入单 路由,但你想通过不同的传不同的 id 来加载 checkinputinfo 这个组件,若采用 params 方式,这时只需要在 path 后面配置 /:taskid 即可实现 checkinputinfo/1 checkinputinfo/2 这样的路由,同时可以通过 this.$route.params.taskid 来获取当前路由的 taskid

{
  path: 'checkinputinfo/:taskid',
  meta: {
   title: '盘点录入单'
  },
  name: 'checkinputinfo',
  component: () => import('@/view/check/checkinputinfo.vue')
 }

类似的,同样也可使用 query 方式,这时只需要在 path 后面配置 :taskid 即可实现 checkinputinfo?taskid=1 checkinputinfo?taskid=2 这样的路由,同时可以通过 this.$route.query.taskid 来获取当前路由的 taskid

{
  path: 'checkinputinfo:taskid',
  meta: {
   title: '盘点录入单'
  },
  name: 'checkinputinfo',
  component: () => import('@/view/check/checkinputinfo.vue')
 }

vue-router 通过配置 params query 来实现动态路由,并可通过 this.$route.xx 来获取当前的 params query ,省去了直接操作或处理 window.location ,还是挺方便的。

注意 :当使用路由参数时,例如从 /user/foo 导航到 /user/bar,原来的组件实例会被复用。因为两个路由都渲染同个组件,比起销毁再创建,复用则显得更加高效。不过,这也意味着组件的生命周期钩子不会再被调用。

解读:在不使用 keep-alive 的情况下,我们每次加载路由,这时会重新 render 当前路由挂载的 component ,但若这两个路由是同一个路由组件配置的动态路由, vue 为了性能设计了不会重新 render

这显然不符合我们的预期,那么该如何在动态路由下拥有完整的生命周期呢?答案是 keep-alive

keep-alive

官网解读 :keep-alive 包裹动态组件时,会缓存不活动的组件实例,而不是销毁它们。和 transition 相似,keep-alive 是一个抽象组件:它自身不会渲染一个 dom 元素,也不会出现在组件的父组件链中。在 2.2.0 及其更高版本中,activated 和 deactivated 将会在 树内的所有嵌套组件中触发。当组件在 内被切换,它的 activated 和 deactivated 这两个生命周期钩子函数将会被对应执行。

keep-alive通过缓存vnode的方式解决了spa最为关键的性能问题。以下,我就按步骤来分析以下:

一、路由触发路由组件重新render的问题

1、不缓存模式:

<router-view></router-view>

修改vue源码实现动态路由缓存的方法

每次切换都会重新 render ,执行整个生命周期,每次切换时,重新 render ,重新请求,,必然不满足需求。

2、缓存模式:

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

修改vue源码实现动态路由缓存的方法

只是在进入当前路由的第一次 render ,来回切换不会重新执行生命周期,且能缓存 router-view 的数据。

二、router-view 数据缓存问题

keep-alive 采用 render 函数来创建 vnode ,一下是 vue v2.5.10 keep-alive.js render()

render () {
  const slot = this.$slots.default
  const vnode: vnode = getfirstcomponentchild(slot)
  const componentoptions: ?vnodecomponentoptions = vnode && vnode.componentoptions
  if (componentoptions) {
   // check pattern
   const name: ?string = getcomponentname(componentoptions)
   const { include, exclude } = this
   if (
    // not included
    (include && (!name || !matches(include, name))) ||
    // excluded
    (exclude && name && matches(exclude, name))
   ) {
    return vnode
   }

   const { cache, keys } = this
   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.data.keepalive = true
  }
  return vnode || (slot && slot[0])
 }
}

render 是获取到 vnode ,若 cache[key] 存在,则:

vnode.componentinstance = cache[key].componentinstance

否则,将 vnode 保存在 cache 里:

cache[key] = vnode

于是当时用 keep-alive 时,我们就可以保存每个 route-view 的数据。

动态路由缓存问题及如何实现

一、bug表象

最开始其实是不知道这个 bug 的,也是通过现象反推,然后由源码解决这个问题的,那就先从现象说起:

动态路由缓存的的具体表现在:

由动态路由配置的路由只能缓存一份数据。 keep-alive 动态路由只有第一个会有完整的生命周期,之后的路由只会触发 actived deactivated 这两个钩子。 一旦更改动态路由的某个路由数据,期所有同路由下的动态路由数据都会同步更新。

我们的期望其实是在使用 keep-alive 的情况下,动态路由能有非动态的表现,即拥有 完整的生命周期各自的数据缓存

二、发掘问题关键

入手 keep-alive 源码发现,其实问题就出现在这一步:

if (
 // not included
 (include && (!name || !matches(include, name))) ||
 // excluded
 (exclude && name && matches(exclude, name))
) {
 return vnode
}

通过上面的表象其实可以探究出, router-view 其实是已经缓存了,而且一个动态路由的 router-view 都是通过了 if 判断返回了 vnode 。那么再看一下这个 name 是什么:

function getcomponentname (opts: ?vnodecomponentoptions): ?string {
 return opts && (opts.ctor.options.name || opts.tag)
}
const name: ?string = getcomponentname(componentoptions)

这里的 opts 其实对应的就是 vuecomponent $options ,而 this.$options.name 不就是对应着得 .vue 文件里声明的 name 属性。然后又想到,怪不得配置路由的时候要求提供的 name 属性要和组件内部的 name 值保持一致。

看到这里,问题已经水落石出了,因为动态路由配置的组件相同, getcomponentname 每次返回相同 name ,然后 render() 去缓存了相同的 vnode ,且只能缓存了一份。既然如此,只要能正确的缓存 vnode 和取出 vnode ,动态路由情况下, keep-alive 依然能正常运行。

修改vue源码

上面说到了是因为动态路由组件名的问题,如果将缓存的 key 设置为唯一不就行了吗?

于是在 router-view 上配置key,key取得师path,永远唯一:

<keep-alive :include="cachelist">
 <router-view :key="$route.path"></router-view>
</keep-alive>

然后修改 keep-alive.js 源码,如下(因为放假的关系不详细说了,直接贴源码,实现的人就是我,也是第一个,github上此bug目前还是open状态):

/* 
*@flow
*modify by lk 20190624
*/

import { isregexp, remove } from 'shared/util'
import { getfirstcomponentchild } from 'core/vdom/helpers/index'

type vnodecache = { [key: string]: ?vnode };

function getcomponentname (opts: ?vnodecomponentoptions): ?string {
 return opts && (opts.ctor.options.name || opts.tag)
}

function matches (pattern: string | regexp | array<string>, key: string | number): boolean {
 if (array.isarray(pattern)) {
  return pattern.indexof(key) > -1
 } else if (typeof pattern === 'string') {
  return pattern.split(',').indexof(key) > -1
 } else if (isregexp(pattern)) {
  return pattern.test(key)
 }
 /* istanbul ignore next */
 return false
}

function prunecache (keepaliveinstance: any, filter: function) {
 const { cache, keys, _vnode } = keepaliveinstance
 for (const key in cache) {
  const cachednode: ?vnode = cache[key]
  if (cachednode) {
   // const name: ?string = getcomponentname(cachednode.componentoptions)
   if (key && !filter(key)) {
    prunecacheentry(cache, key, keys, _vnode)
   }
  }
 }
}

function prunecacheentry (
 cache: vnodecache,
 key: string,
 keys: array<string>,
 current?: vnode
) {
 const cached = cache[key]
 if (cached && (!current || cached.tag !== current.tag)) {
  cached.componentinstance.$destroy()
 }
 cache[key] = null
 remove(keys, key)
}

const patterntypes: array<function> = [string, regexp, array]

export default {
 name: 'keep-alive',
 abstract: true,

 props: {
  include: patterntypes,
  exclude: patterntypes,
  max: [string, number]
 },

 created () {
  this.cache = object.create(null)
  this.keys = []
 },

 destroyed () {
  for (const key in this.cache) {
   prunecacheentry(this.cache, key, this.keys)
  }
 },

 mounted () {
  this.$watch('include', val => {
   prunecache(this, key => matches(val, key))
  })
  this.$watch('exclude', val => {
   prunecache(this, key => !matches(val, key))
  })
 },

 render () {
  const slot = this.$slots.default
  const vnode: vnode = getfirstcomponentchild(slot)
  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
  const componentoptions: ?vnodecomponentoptions = vnode && vnode.componentoptions
  if (componentoptions) {
   // check pattern
   const name: ?string = getcomponentname(componentoptions)
   const { include, exclude } = this
   if (
    // not included
    (include && (!key || !matches(include, key))) ||
    // excluded
    (exclude && key && matches(exclude, key))
   ) {
    return vnode
   }

   const { cache, keys } = this

   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.data.keepalive = true
  }
  return vnode || (slot && slot[0])
 }
}

如何集成

因为放假赶车的关系,粗略说一下,有问题直接在底下评论:

一、修改package.json:

npm install时不下载 vue ,修改 packjson.js 改为本地的 vue:"vue": "file:./vue2.5.0/"

"dependencies": {
 "axios": "^0.18.0",
 "clipboard": "^2.0.0",
 "codemirror": "^5.38.0",
 "countup": "^1.8.2",
 "cropperjs": "^1.2.2",
 "dayjs": "^1.7.7",
 "echarts": "^4.0.4",
 "html2canvas": "^1.0.0-alpha.12",
 "iview": "^3.2.2",
 "iview-area": "^1.5.17",
 "js-cookie": "^2.2.0",
 "simplemde": "^1.11.2",
 "sortablejs": "^1.7.0",
 "tree-table-vue": "^1.1.0",
 "v-org-tree": "^1.0.6",
 "vue": "file:./vue2.5.0/",
 "vue-i18n": "^7.8.0",
 "vue-router": "^3.0.1",
 "vuedraggable": "^2.16.0",
 "vuex": "^3.0.1",
 "wangeditor": "^3.1.1",
 "xlsx": "^0.13.3"
},

二、修改所有本地 import vue 为本地文件:

// import vue from 'vue'
import vue from '../vue-2.5.10/src/core/index'

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。