unplugin-vue-router 中自定义路由元信息的使用指南

在使用 unplugin-vue-router 进行 Vue 项目开发时，开发者可能会遇到如何在路由守卫中正确访问自定义元信息的问题。本文将详细介绍两种在 unplugin-vue-router 中定义和使用路由元信息的方法。

方法一：使用 <route> 块定义元信息

在 Vue 单文件组件中，可以通过 <route> 块来定义路由元信息：

<route lang="json">
{
  "meta": {
    "name": "example",
    "requiresAuth": true
  }
}
</route>

这种方法简洁明了，适合简单的元信息定义场景。但需要注意的是，在某些情况下可能需要刷新项目才能使元信息生效。

方法二：使用 definePage 方法

另一种更可靠的方式是在 <script setup> 中使用 definePage 方法来定义路由元信息：

<script setup lang="ts">
definePage({
  meta: { 
    requiresAuth: true,
    // 可以添加其他自定义元信息
  },
});
</script>

这种方法具有以下优势：

1. 类型安全，可以获得 TypeScript 的类型提示
2. 定义方式更符合 Vue 3 的组合式 API 风格
3. 无需担心刷新问题，元信息会立即生效

在路由守卫中使用元信息

定义好元信息后，可以在路由守卫中轻松访问：

router.beforeEach((to) => {
  console.log(to.meta); // 输出定义的所有元信息
  
  if (to.meta.requiresAuth) {
    // 执行认证检查逻辑
  }
});

最佳实践建议

1. 对于简单项目，可以使用 <route> 块定义元信息
2. 对于中大型项目，推荐使用 definePage 方法，以获得更好的类型支持和代码组织
3. 如果使用 <route> 块时元信息未生效，尝试重启开发服务器
4. 保持元信息命名一致，便于团队协作和维护

通过合理使用这两种方法，开发者可以轻松实现路由级别的权限控制和其他基于元信息的逻辑处理。