unplugin-vue-router数据加载器使用注意事项

在使用unplugin-vue-router的数据加载器功能时，开发者可能会遇到数据加载器只执行一次的问题。本文将深入分析这个问题的原因，并提供正确的使用方法。

问题现象

当开发者尝试在Vue组件中使用defineBasicLoader定义数据加载器时，可能会发现以下异常情况：

1. 页面首次加载时，数据加载器没有按预期等待2秒后再渲染页面
2. 控制台只打印一次"Loading container data"日志
3. 导航到新页面时，数据加载器不再触发

根本原因

这个问题的核心在于数据加载器的定义位置。unplugin-vue-router的数据加载器必须由路由页面组件(即路由对应的组件)导出，才能正确绑定到导航生命周期中。

即使数据加载器可以在其他组件中使用，但它必须至少被一个页面组件导出，这样插件才能将其注册到路由导航守卫中。如果只在普通组件中定义而不在页面组件中导出，数据加载器将无法自动响应路由变化。

正确使用方法

1. 在页面组件中定义数据加载器

正确的做法是在路由对应的页面组件中定义并导出数据加载器：

<script lang="ts">
// 必须在页面组件中导出
export const useContainerData = defineBasicLoader("/container/[id]", async (to) => {
  console.log("Loading container data...", to.params.id);
  await new Promise((resolve) => setTimeout(resolve, 2000));
  return { id: new Date() };
});
</script>

<script lang="ts" setup>
const { isLoading, data } = useContainerData();
</script>

2. 确保路由配置正确

在路由配置文件中，需要正确设置数据加载器插件：

import { DataLoaderPlugin } from "unplugin-vue-router/data-loaders";

export const router = createRouter({
  history: createWebHistory(),
  routes: setupLayouts(routes),
});

app.use(DataLoaderPlugin, { router });
app.use(router);

3. 理解数据加载器生命周期

数据加载器的工作流程：

1. 导航开始时触发数据加载
2. 等待所有数据加载器完成
3. 完成导航并渲染组件
4. 组件内部可以使用加载好的数据

高级用法

数据失效策略

可以为数据加载器设置失效策略，控制何时重新加载数据：

defineBasicLoader("/path", async (to) => {
  // 加载数据...
  return {
    data: yourData,
    // 每次导航都重新加载
    shouldInvalidate: () => true
  };
});

手动重新加载

即使配置正确，有时也需要手动触发重新加载：

const { reload } = useContainerData();

// 手动触发重新加载
function refreshData() {
  reload();
}

总结

unplugin-vue-router的数据加载器是一个强大的功能，但需要注意：

1. 必须在页面组件中导出数据加载器
2. 确保正确配置了数据加载器插件
3. 理解其与路由导航的生命周期关系
4. 可以灵活使用自动失效和手动加载策略

遵循这些原则，可以充分发挥数据加载器在路由导航中的优势，实现流畅的数据预加载体验。