# 路由、菜单与权限
登录后从 `GET /admin/route-config` 读取会话可用的路由 JSON,按 `meta.order` 排序;路由树用于菜单和面包屑,展开后的页面记录注册到 Vue Router。Mock 的初始路由表位于 `packages/demo-data/src/routes.json`。外壳保留登录、个人信息和状态页。默认使用 hash 路由,例如 `/ray-template/#/orders`。
## 路由配置交互校验
修改路径、名称或页面 ID,查看共享校验器的结果。示例注册了 `overview` 页面。
::: details 查看示例源码
<<< @/examples/RouteConfigDemo.vue
:::
## 在线编辑与接口接入
有 `routes:write` 权限时,可视化和 JSON 页面从编辑接口加载完整草稿,通过 `PUT /admin/route-config` 保存,随后刷新运行路由。Mock 写入会保存在当前浏览器,也可以切换本机或内置配置。标准后端模式以远端为准,读取失败时显示错误。 若配置了只读的 `VITE_ROUTE_CONFIG_URL`,在 JSON 页面选择远程来源并点击“启用远程配置”即可恢复读取该地址。修改只读来源的草稿可以保存在本地或导出。
接口请求体为 `{ version: 1, routes: [...] }`,读取和写入响应都放在统一 `{ code, msg, data }` 包络的 `data` 中。`component` 必须是 `router/config/views.ts` 的注册 ID;新增前端页面先注册 ID,再由接口返回其路由记录。详见[服务端标准契约](./backend)。
## 常用元数据
| 字段 | 作用 |
| -------------------------- | ----------------------------------------------------------------------------------------- |
| `i18nKey` / `noLocalTitle` | 使用翻译键,或提供不经翻译的菜单标题 |
| `icon` | 使用完整分包图标名,也接受 VNode |
| `role` | 同时影响菜单与守卫;角色值类型要和会话一致 |
| `hidden`、`env` | 控制菜单显隐;不充当接口或路由权限 |
| `sameLevel` | 详情页可保留当前菜单与标签,只在面包屑补充层级 |
| `keepAlive` | 允许页面加入内容区的缓存 |
| `windowOpen` | 菜单点击时打开指定地址。 |
| `ignoreAutoResetScroll` | 允许页面保留内容区滚动位置,详见滚动工具实现。 |
| `extra` | 菜单标记的文本、图标、类型和显隐,见 [useBadge](../reference/hooks/navigation#usebadge)。 |
嵌套子路由使用相对路径时会继承父路径。内置示例按用途分组,并以绝对路径保留原有页面地址。查看 [布局与路由示例](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/packages/demo-data/src/routes.json) 里的分组及多级菜单。
## 登录和角色
默认登录页为 `/`。无会话访问业务地址时,守卫将完整地址放入登录页的 `redirect` 参数;登录后仅恢复当前角色仍有权限的已注册业务地址,保留 query 和 hash。没有有效目标时进入 `/welcome`,不会自动选择仪表盘或第一个菜单。对重定向路由,菜单和守卫都会检查入口、各级跳转和最终目标的权限。菜单隐藏的页面仍可能允许直达。接入真实业务时,在后端校验会话、权限和资源归属。
## 空工作区和状态页
`/welcome` 表示当前没有活动业务路由,展示可访问的入口。它与 `/403`、`/404`、`/500` 一样属于外壳状态页,不进入业务菜单、标签、访问历史或页面缓存。四个路径及其子路径、别名和对应名称保留给外壳,不能被本机或远端 JSON 覆盖。自定义来源无需提供 `/dashboard`,仪表盘存在时也可以设置角色权限。
所有业务标签都可以关闭,包括原首页和最后一项。关闭当前标签后切换到相邻项;关闭最后一项或全部标签进入空工作区,同时释放对应 KeepAlive 缓存。一个具体 pathname 保留一个标签,查询参数或片段变化会更新标签保存的完整地址。角色变化后,失去权限的标签与缓存会被移除,不会自动激活其他业务页。
- `/403`:已登录,但当前页面无权限。页签栏的「关闭当前页面」会返回仍有权限的上一页或已打开页签,没有可恢复的页面时回到工作区。
- `/404`:目标页面不存在;原始目标保留在 `query.from`。
- `/500`:路由解析或页面懒加载失败;只对仍存在且允许访问的 `query.from` 显示重试。
状态页始终提供返回工作区的操作;“上一页”和“重试”会先验证站内地址和权限,不直接信任历史记录或查询参数。`useAppRoot` 与旧 `appRootRoute` 偏好仅保留兼容读写,已不影响上述行为,也不再进行启动时首页校验。
## KeepAlive 排查
1. 路由设置 `meta.keepAlive: true`,并为它配置唯一 `name`。
2. TSX 的 `defineComponent({ name })` 或 SFC 的组件名应与路由名一致。检查懒加载模块是否导出了预期组件。
3. 从菜单进入,改变页内状态,切到另一个标签再返回;随后检查关闭标签、直达和刷新是否符合预期。KeepAlive 不跨浏览器刷新保留组件实例。
4. 替换布局的默认内容插槽后,应用接入方需要自行保留需要的路由渲染和缓存逻辑。
[路由契约](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/router/README.md) · [守卫实现](https://github.com/XiaoDaiGua-Ray/ray-template/blob/main/apps/admin/src/router/utils/permission.ts)