路由守卫
路由守卫实现于
src/router/index.ts,是全局前置守卫(beforeEach)。
设计要点
- 页面标题:读取
to.meta.titleKey,用i18n.global.t()翻译后拼成${标题} - HayFrp;没有titleKey时回退到to.meta.title,再回退到HayFrp。 - 登录态来源:调用
@/utils/token的readValidStoredToken(),不直接读 localStorage,也不依赖 Pinia Store,避免 Pinia 尚未初始化时的竞态问题。Token 已过期时该方法会顺手清除存储并返回null。 - Open Redirect 防护:
guest页面放行redirect_url前,必须通过isAllowedRedirectUrl()校验。
实现代码
typescript
import { createRouter, createWebHistory } from 'vue-router'
import { readValidStoredToken } from '@/utils/token'
import { isAllowedRedirectUrl } from '@/utils/redirect'
import i18n from '@/i18n'
const router = createRouter({
history: createWebHistory(),
routes
})
router.beforeEach((to, _from, next) => {
// 页面标题 - 使用 i18n key,或回退到原始 title / 默认值
const titleKey = to.meta.titleKey as string | undefined
const rawTitle = titleKey ? i18n.global.t(titleKey) : (to.meta.title as string) || 'HayFrp'
document.title = `${rawTitle} - HayFrp`
// 从 localStorage 读取并校验 Token(过期会自动清除)
const csrf = readValidStoredToken()
const isLoggedIn = !!csrf
// 需要登录但未登录 → 跳登录页并带上回跳路径
if (to.meta.requiresAuth && !isLoggedIn) {
next({ name: 'Login', query: { redirect: to.fullPath } })
}
// 访客页面但已登录 → 若带合法 redirect_url 则放行,否则回首页
else if (to.meta.guest && isLoggedIn) {
if (to.query.redirect_url && isAllowedRedirectUrl(to.query.redirect_url as string)) {
next()
} else {
next({ path: '/' })
}
}
// 其他情况放行
else {
next()
}
})权限判断逻辑
| 页面类型 | 未登录 | 已登录 |
|---|---|---|
公开页面(含 /bind) | 正常访问 | 正常访问 |
requiresAuth 页面 | 重定向 /login?redirect=原路径 | 正常访问 |
guest 页面(/login、/register) | 正常访问 | 重定向 /(带合法 redirect_url 时放行) |
路由守卫流程图
用户访问路由
│
▼
设置 document.title(titleKey → i18n 翻译)
│
▼
readValidStoredToken() → 是否有有效 Token?
│
├─ 公开页面 ──────────────────────────▶ 放行
│
├─ requiresAuth ──┬─ 无 Token ───────▶ /login?redirect=原路径
│ │
│ └─ 有 Token ───────▶ 放行
│
└─ guest ─────────┬─ 无 Token ───────▶ 放行
│
└─ 有 Token ──┬─ redirect_url 合法 ──▶ 放行
│
└─ 否则 ────────────────▶ 重定向 /Open Redirect 防护
src/utils/redirect.ts 只放行两类重定向目标:
- 与当前页面同源的 URL;
- 白名单域名的 HTTPS + 默认端口(443) URL:
verify.hayfrp.comverify.hayfrp.1zyq1.comverify.1zyq1.hayfrp.com
typescript
const ALLOWED_EXTERNAL_REDIRECT_HOSTS = new Set([
'verify.hayfrp.com',
'verify.hayfrp.1zyq1.com',
'verify.1zyq1.hayfrp.com'
])
export function isAllowedRedirectUrl(url: string | null | undefined): boolean {
if (!url) return false
try {
const urlObj = new URL(url, window.location.origin)
if (urlObj.origin === window.location.origin) return true
const isAllowedHost = ALLOWED_EXTERNAL_REDIRECT_HOSTS.has(urlObj.hostname)
const isHttps = urlObj.protocol === 'https:'
const hasDefaultPort = !urlObj.port || urlObj.port === '443'
return isAllowedHost && isHttps && hasDefaultPort
} catch {
return false
}
}
// 校验通过后向目标 URL 附加 csrf 参数;校验失败返回 null
export function buildRedirectUrlWithCsrf(redirectUrl, csrf) {
if (!isAllowedRedirectUrl(redirectUrl)) return null
const url = new URL(redirectUrl, window.location.origin)
url.searchParams.set('csrf', csrf)
return url.toString()
}登录态与 Token 存储
Token 统一由 src/utils/token.ts 管理:
| 项 | 值 / 行为 |
|---|---|
| localStorage key | csrf |
| 存储格式 | JSON { token: string, expiry: number }(expiry 为毫秒时间戳) |
| 有效期 | 7 天(TOKEN_EXPIRY_DAYS = 7) |
| 旧格式兼容 | 存量纯字符串 Token 按「永不过期」(expiry: Infinity)处理 |
| 过期清理 | readValidStoredToken() 发现过期会 removeItem('csrf') 并返回 null |
| 自动登出 | useUserStore 用 setTimeout 在 expiry 时刻调用 logout() |
扫码登录的一个坑
setCsrf() 只保留仍在未来的旧过期时间;若旧过期时间已过,则重新给 7 天。否则会算出 delay <= 0 立刻 logout(),表现为「扫码登录刚成功就被登出」。
补充守卫:顶部进度条
src/plugins/progressPlugin.ts 额外注册了 beforeEach / afterEach / onError 钩子,在路由切换时渲染顶部进度条(#route-progress),与权限守卫互不影响。它统计并发请求数(activeRequests),在 afterEach 与 onError 中收尾。
页面内权限校验
/sp 不使用路由级权限,而是在组件内判断:
| 页面 | 判断条件 | 不满足时 |
|---|---|---|
/sp | userStore.userInfo?.sprovider === true | 展示「申请成为服务商」入口,不进入控制台 |