Fantastic-admin 官方文档

Appearance

页面保活 ​

开启页面保活的前提条件：页面组件必须设置 name ，并且确保 name 唯一。

可以考虑将路由 name 和组件 name 设置成一致，方便记忆。

vue
<script setup lang="ts">
defineOptions({
  // 组件名
  name: 'ComponentName',
})
</script>

说明

页面保活和标签栏并无直接关系，但为了更好的使用体验，我们提供了一些最佳实践方案作为参考。

基础用法 ​

只需要在路由的 meta 对象里配置 keepAlive 属性，即可开启页面保活，该属性接受以下 3 种类型：

  • boolean
  • string
  • string[]

注意

当类型为 string 或 string[] 时，设置的值为路由的 name 。

boolean 很好理解，当设置为 true 时，该页面一旦被访问，就会被保活，这也是大部分同类框架的方案。

例如有一个新闻管理的模块，我们把新闻列表页设置为 keepAlive: true 后并访问，然后从新闻列表页点击某条记录进入新闻详情页，这时候再从新闻详情页返回新闻列表页时，新闻列表页上的数据是不会重新加载，而是保留了当时离开时的状态。

但这个方案也有一个弊端，就是该页面一旦访问就永久被保活住了，如果用户从新闻列表页进入的不是新闻详情页，而是其它模块的页面，这时候其实是不希望新闻列表页被保活的。这种情况下，框架支持设置 string 和 string[] 两个类型的参数值。

怎么理解呢？还是用上面的例子，如果有两个模块，一个新闻管理，一个用户管理。当从新闻列表页进入新闻详情页的时候，需要对新闻列表页进行保活，而从新闻列表页进入用户列表页，则不需要对新闻列表页进行保活，我们就可以对新闻列表页的路由设置成：

ts
const routes: RouteRecordRaw = {
  path: '/news',
  children: [
    {
      path: 'list',
      name: 'NewsList'
      meta: {
        title: '新闻列表',
        keepAlive: 'NewsDetail',
      },
    },
    {
      path: 'detail/:id',
      name: 'NewsDetail',
      meta: {
        title: '新闻详情',
        menu: false,
        activeMenu: '/news/list',
      },
    },
  ],
}

这表示从新闻列表页进入新闻详情页时，新闻列表页才会被保活，进入其它任何页面都不会保活。

当然也可将 keepAlive 设置成 name 数组。

ts
const routes: RouteRecordRaw = {
  path: '/news',
  children: [
    {
      path: 'list',
      name: 'NewsList'
      meta: {
        title: '新闻列表',
        keepAlive: ['NewsDetail', 'NewsCreate'],
      },
    },
    {
      path: 'detail/:id',
      name: 'NewsDetail',
      meta: {
        title: '新闻详情',
        menu: false,
        activeMenu: '/news/list',
      },
    },
    {
      path: 'create',
      name: 'NewsCreate',
      meta: {
        title: '新增新闻',
        menu: false,
        activeMenu: '/news/list',
      },
    },
  ],
}

这样就表示从新闻列表页进入新闻详情页或新增新闻页时，新闻列表页才会被保活，进入其它任何页面都不会保活。

上面这个示例可以看到，在管理员列表搜索栏输入搜索条件，点击进入编辑管理员后并切换回管理员列表，搜索条件依然存在，页面保活有效。接着切换到部门列表后再切换回管理员列表，搜索条件依然存在，页面保活失效。

高级用法 ​

如果开启了标签栏，同时也配置了标签页合并，那么你需要在路由 meta 元信息里配置 noKeepAlive 属性，该属性接受以下 2 种类型：

  • string
  • string[]

注意

noKeepAlive 这个属性必须和 keepAlive 同时设置时才会生效。

例如有一个新闻管理的模块，并且使用了标签页合并，这时我们从新闻列表页进入新增新闻页后，进行了一些数据填写，再点开其它模块的页面，例如用户列表页，此时标签栏里会有 2 个标签页，分别是新增新闻和用户列表，这时候从用户列表页切换回新增新闻页。

如果想让新增新闻页保持住离开时的状态，需要设置 keepAlive: true ，因为从新闻列表页跳转到其它任何页面，都需要将它进行保活住。但这个时候问题来了，如果从新增新闻页返回新闻列表页时，是需要清除保活的，所以框架提供了另一个参数 noKeepAlive ，来看下面的路由配置。

ts
const routes: RouteRecordRaw = {
  path: '/news',
  children: [
    {
      path: 'list',
      name: 'NewsList'
      meta: {
        title: '新闻列表',
        keepAlive: true,
      },
    },
    {
      path: 'create',
      name: 'NewsCreate',
      meta: {
        title: '新增新闻',
        menu: false,
        activeMenu: '/news/list',
        keepAlive: true,
        noKeepAlive: 'NewsList',
        tabMerge: 'activeMenu',
      },
    },
  ],
}

上面这个示例可以看到，从管理员列表点击进入编辑管理员，修改表单并返回管理员列表，再次进入编辑管理员，页面保活失效。再次修改表单并切换到部门列表，然后切换回编辑管理员，修改过的表单依然存在，页面保活有效。

Copyright © 2020-present Fantastic-admin