路由概览
本文档描述 HayFrp Console 5.0(
HayFrp-Console-5.0)全部前端路由、组件映射、Meta 与权限要求。路由全部懒加载(
() => import('@/views/Xxx.vue')),统一定义于src/router/index.ts。
路由一览表
| 路径 | 组件 | 页面名称 | 功能描述 | 权限要求 |
|---|---|---|---|---|
/ | Landing.vue | 首页 | 系统总流量、今日流量、在线客户端、节点网络、功能导航(全屏滚动) | 公开(隐藏侧边栏) |
/login | Login.vue | 登录 | 账号密码登录、二维码扫码登录、忘记密码,登录后按 redirect 回跳 | 仅未登录 |
/register | Register.vue | 注册 | 用户名 / 邮箱 / 密码注册,邮箱验证码与密码强度提示 | 仅未登录 |
/dashboard | Dashboard.vue | 控制台 | 账户概览、流量统计与趋势、隧道配额、每日签到 | 需要登录 |
/proxies | Proxies.vue | 隧道管理 | 隧道增删改查、启停、强制下线、配置导出、简单启动 | 需要登录 |
/lobby | Lobby.vue | 联机大厅 | 房间卡片墙、开房、加入房间、实时状态、连接密钥、房间聊天 | 需要登录 |
/settings | UserSettings.vue | 用户设置 | 修改用户名、改密码、绑定 QQ、重置 Frp Token、通知设置、申请服务商 | 需要登录 |
/customize | Customize.vue | 面板个性化 | 主题色、顶部 / 卡片背景色、紧凑模式、动画、二次元风格 | 需要登录 |
/nodes | Nodes.vue | 节点列表 | 节点列表与探针详情、负载、实时流量、节点分布地图 | 公开 |
/download | Download.vue | 下载 | 按平台下载 frpc / frps / 启动器 / Cli | 公开 |
/about | About.vue | 关于 | 版本信息、服务商列表、技术栈、开发时间线 | 公开 |
/sp | ServiceProvider.vue | 服务商控制台 | 服务商独立登录、节点服务器管理、公告、申请审批 | 需要登录(且为服务商) |
/bind | Bind.vue | 绑定账户 | 通过 ?csrf= 参数触发 HayFrp 账户绑定 | 公开 |
/launcher | Launcher.vue | 启动器授权 | 与本地 21100 端口的启动器通信,一键授权 | 需要登录 |
/cloud-control(别名 /rwmc_oauth) | CloudControl.vue | 云控设备 | RWMC 云设备列表、绑定、命令、日志、自启、解绑 | 需要登录 |
/:pathMatch(.*)* | NotFound.vue | 页面未找到 | 404 兜底,提供返回首页 / 上一页 | 公开 |
路由元信息 (Meta)
| 属性 | 类型 | 说明 |
|---|---|---|
titleKey | string | 页面标题的 i18n key,守卫用 i18n.global.t() 翻译后拼成 xxx - HayFrp |
requiresAuth | boolean | 是否需要登录,未登录跳 /login?redirect=原路径 |
guest | boolean | 是否仅未登录可访问,已登录会被重定向到 / |
hideSidebar | boolean | 不渲染 AppLayout 侧边栏(/、/login、/register) |
noScroll | boolean | 路由切换时不自动滚动到顶部 |
注意
新路由一律使用 titleKey,不再使用旧的 title。守卫仍保留 to.meta.title 作为兜底。
各路由 Meta 速查
| 路由名 | titleKey | requiresAuth | guest | hideSidebar | noScroll |
|---|---|---|---|---|---|
Landing | landing.heroTitle | — | — | ✅ | — |
Dashboard | menu.dashboard | ✅ | — | — | ✅ |
Login | login.title | — | ✅ | ✅ | — |
Register | register.title | — | ✅ | ✅ | — |
Proxies | menu.proxies | ✅ | — | — | ✅ |
Lobby | menu.lobby | ✅ | — | — | ✅ |
Settings | user.settings | ✅ | — | — | — |
Customize | preference.title | ✅ | — | — | — |
Nodes | menu.nodes | — | — | — | ✅ |
Download | menu.download | — | — | — | — |
About | menu.about | — | — | — | — |
ServiceProvider | serviceProvider.title | ✅ | — | — | — |
Bind | settings.bindNow | — | — | — | — |
Launcher | menu.launcher | ✅ | — | — | — |
CloudControl | menu.cloudControl | ✅ | — | — | ✅ |
NotFound | common.notFound | — | — | — | — |
路由配置文件
typescript
// src/router/index.ts(节选)
const routes = [
{
path: '/',
name: 'Landing',
component: () => import('@/views/Landing.vue'),
meta: { titleKey: 'landing.heroTitle', hideSidebar: true }
},
{
path: '/dashboard',
name: 'Dashboard',
component: () => import('@/views/Dashboard.vue'),
meta: { titleKey: 'menu.dashboard', requiresAuth: true, noScroll: true }
},
// ... 其余路由
{
path: '/:pathMatch(.*)*',
name: 'NotFound',
component: () => import('@/views/NotFound.vue'),
meta: { titleKey: 'common.notFound' }
}
]
const router = createRouter({
history: createWebHistory(), // HTML5 History 模式,URL 不带 #
routes
})路由文件结构
src/
├── router/
│ └── index.ts # 路由配置及全局守卫
├── plugins/
│ └── progressPlugin.ts # 路由切换顶部进度条
├── utils/
│ ├── token.ts # Token 读写 / 过期判断
│ └── redirect.ts # Open Redirect 防护
└── views/
├── Landing.vue # 首页
├── Login.vue # 登录
├── Register.vue # 注册
├── Dashboard.vue # 控制台
├── Proxies.vue # 隧道管理
├── Lobby.vue # 联机大厅
├── UserSettings.vue # 用户设置
├── Customize.vue # 面板个性化
├── Nodes.vue # 节点列表
├── Download.vue # 下载
├── About.vue # 关于
├── ServiceProvider.vue # 服务商控制台
├── Launcher.vue # 启动器授权
├── CloudControl.vue # 云控设备
├── Bind.vue # 绑定账户
└── NotFound.vue # 404菜单入口与路由的对应关系
侧边栏菜单定义在 src/components/AppLayout.vue,key 与路由名通过 routeMap 映射:
| 菜单 key | 路由名 | 菜单文案 key |
|---|---|---|
dashboard | Dashboard | menu.dashboard |
proxies | Proxies | menu.proxies |
nodes | Nodes | menu.nodes |
lobby | Lobby | menu.lobby |
cloud-control | CloudControl | menu.cloudControl |
launcher | Launcher | menu.launcher |
download | Download | menu.download |
about | About | menu.about |
docs | —(window.open('https://docs.hayfrp.com/')) | menu.docs |
home | Landing(未登录时追加) | menu.home |
顶栏用户菜单还提供
/customize(个性化)、/sp(服务商控制台)、/settings(用户设置)、兑换码弹窗与退出登录。