Vue / 系统课时

管理页面缓存

管理页面缓存

本课建立一套可控的页面缓存机制:由路由元信息决定哪些页面进入 KeepAlive,由 Pinia 维护缓存名单,并分别处理参数变化、手动刷新与退出登录后的清理。完成后,返回列表页可保留现场,又不会让旧数据永久滞留。

学习目标

  • 使用路由元信息声明页面缓存策略
  • 让 KeepAlive 与组件名称稳定匹配
  • 正确处理参数更新、强制刷新和缓存清理

明确缓存边界

页面缓存适合保留筛选条件、分页位置、滚动位置和临时表单状态,但不等于接口数据永远有效。缓存身份应使用稳定的组件名,路由参数变化则由页面主动监听并重新请求数据。

场景 推荐处理
列表页返回后保留现场 使用 KeepAlive 缓存组件实例
同一详情页参数变化 保留实例,监听参数并重新加载
用户点击刷新 清除当前实例后重新创建
退出登录或权限变化 清空全部缓存

路由与 KeepAlive 页面缓存控制流程

声明路由缓存策略

在需要缓存的路由上写入 keepAlive 与 cacheName。cacheName 必须与页面组件的 name 完全一致,否则 KeepAlive 的 include 无法命中。

ts
// src/router/modules/user.ts
export const userRoutes = [
  {
    path: '/users',
    name: 'UserList',
    component: () => import('@/views/user/UserListPage.vue'),
    meta: {
      title: '用户列表',
      keepAlive: true,
      cacheName: 'UserListPage'
    }
  },
  {
    path: '/users/:id',
    name: 'UserDetail',
    component: () => import('@/views/user/UserDetailPage.vue'),
    meta: {
      title: '用户详情',
      keepAlive: true,
      cacheName: 'UserDetailPage'
    }
  }
]

生效行为:进入标记为 keepAlive 的路由时,布局层会把对应 cacheName 加入缓存名单;未标记的页面仍正常渲染,但离开后不会保留实例。

管理缓存名单与刷新版本

Store 维护 KeepAlive 的 include 数组。手动刷新时,先移除名称并等待一次渲染,再递增版本号和重新加入,确保当前实例真正被替换。

ts
// src/stores/pageCache.ts
import { defineStore } from 'pinia'
import { nextTick, reactive, ref } from 'vue'

export const usePageCacheStore = defineStore('page-cache', () => {
  const cachedNames = ref<string[]>([])
  const versions = reactive<Record<string, number>>({})

  function add(name: string) {
    if (name && !cachedNames.value.includes(name)) {
      cachedNames.value.push(name)
    }
  }

  function remove(name: string) {
    cachedNames.value = cachedNames.value.filter(item => item !== name)
  }

  function versionOf(name: string) {
    return versions[name] ?? 0
  }

  async function refresh(name: string) {
    const shouldRestore = cachedNames.value.includes(name)
    remove(name)
    await nextTick()

    versions[name] = versionOf(name) + 1
    if (shouldRestore) {
      add(name)
    }
  }

  function clear() {
    cachedNames.value = []
    Object.keys(versions).forEach(name => delete versions[name])
  }

  return { cachedNames, add, remove, versionOf, refresh, clear }
})

refresh 不是重新调用接口的别名,而是销毁并重建组件实例。只想更新数据时,应调用页面自己的查询函数,避免丢失不必要的界面状态。

在布局中接入 KeepAlive

下面的布局根据当前路由同步缓存名单,并把版本号加入动态组件的 key。这是片段示例,依赖项目已经注册 Vue Router 与 Pinia。

vue
<!-- src/layouts/AdminLayout.vue -->
<script setup lang="ts">
import { computed, watch } from 'vue'
import { useRoute } from 'vue-router'
import { usePageCacheStore } from '@/stores/pageCache'

const route = useRoute()
const cacheStore = usePageCacheStore()

const cacheName = computed(() =>
  typeof route.meta.cacheName === 'string' ? route.meta.cacheName : ''
)

watch(
  () => route.fullPath,
  () => {
    if (route.meta.keepAlive && cacheName.value) {
      cacheStore.add(cacheName.value)
    }
  },
  { immediate: true }
)

async function refreshCurrentPage() {
  if (cacheName.value) {
    await cacheStore.refresh(cacheName.value)
  }
}
</script>

<template>
  <button type="button" @click="refreshCurrentPage">
    刷新当前页
  </button>

  <RouterView v-slot="{ Component, route: slotRoute }">
    <KeepAlive :include="cacheStore.cachedNames">
      <component
        :is="Component"
        :key="`${String(slotRoute.name)}-${cacheStore.versionOf(cacheName)}`"
      />
    </KeepAlive>
  </RouterView>
</template>

预期结果

text
从用户列表进入详情再返回:列表组件不会重新创建,筛选和滚动状态仍保留
点击“刷新当前页”:当前缓存实例被销毁并重新创建
调用 cacheStore.clear():全部页面缓存名单和刷新版本被清空

实际路由名称和页面状态会因项目配置不同而变化,但组件创建与销毁行为应与上述结果一致。

处理路由参数变化

缓存详情页时,/users/1 切换到 /users/2 可能复用同一个组件实例,因此不能只依赖 onMounted。页面应监听参数,并在参数变化时重新加载数据。以下为片段示例,依赖现有的 getUserDetail 接口模块。

vue
<!-- src/views/user/UserDetailPage.vue -->
<script setup lang="ts">
import { ref, watch } from 'vue'
import { useRoute } from 'vue-router'
import { getUserDetail } from '@/api/user'

defineOptions({ name: 'UserDetailPage' })

const route = useRoute()
const userName = ref('')

watch(
  () => route.params.id,
  async id => {
    if (typeof id !== 'string') return
    const data = await getUserDetail(id)
    userName.value = data.name
  },
  { immediate: true }
)
</script>

<template>
  <section>
    <h2>用户详情</h2>
    <p>{{ userName }}</p>
  </section>
</template>

预期结果

text
连续访问两个不同用户 ID:页面名称随参数重新加载
组件实例保持复用:其他可保留的局部状态不会全部重置

清理缓存的时机

退出登录、租户切换、角色权限变化或关闭业务标签页时,应主动调用 cacheStore.clear() 或 cacheStore.remove(name)。否则旧组件可能继续保存上一身份的筛选条件或敏感数据。

不要把所有页面都加入缓存。高频列表、编辑草稿等页面收益明显;实时看板、一次性详情和依赖强权限上下文的页面,通常更适合每次进入重新创建。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

管理页面缓存

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通