状态管理与本地存储
HayFrp Console 5.0 使用 Pinia 管理全局状态:
stores/user.ts(登录态、用户信息、Token)与stores/theme.ts(主题、菜单位置、移动端检测)。此外还有少量localStorage直存项(个性化设置、语言、通知历史)。
Store 一览
| Store | 文件 | 职责 |
|---|---|---|
useUserStore | src/stores/user.ts | CSRF Token、用户信息、登录 / 登出、签到、Token 校验与过期自动登出 |
useThemeStore | src/stores/theme.ts | 深色 / 浅色主题、二次元风格、菜单位置、移动端检测 |
useUserStore
状态与方法
| 名称 | 类型 | 说明 |
|---|---|---|
csrf | Ref<string | null> | 当前 CSRF Token |
userInfo | Ref<UserInfo | null> | 用户信息(realname、sprovider 已归一化为布尔) |
isLoggedIn | ComputedRef<boolean> | !!csrf |
loadTokenFromStorage() | 方法 | 启动时调用,读 Token、判过期、安排过期定时器 |
login(user, passwd, keepcsrf?) | 方法 | 登录成功后写 Token 并 fetchUserInfo() |
fetchUserInfo() | 方法 | 调用 /user type=info 刷新用户信息 |
sign() | 方法 | 每日签到 |
logout() | 方法 | 清定时器、清状态、清 localStorage |
setToken(token) | 方法 | 写入全新 7 天有效期 |
setCsrf(token) | 方法 | 写入 Token 但保留仍在未来的旧过期时间 |
setUserInfo(info) | 方法 | 手动覆盖用户信息 |
validateToken() | 方法 | 调 /user type=csrf 校验,无效则登出 |
用户信息字段
typescript
export interface UserInfo {
id: string // 用户 ID
username: string // 用户名
token: string // FRP 连接 Token
email: string // 邮箱
traffic: string // 剩余流量(MB)
realname: boolean // 是否实名认证
proxies: string // 可创建隧道数量上限
useproxies: number // 已使用隧道数
regtime: string // 注册时间戳
signdate: string | null // 上次签到时间
totalsign: string | null // 总签到天数
totaltraffic: string | null // 总签到流量(GB)
todaytraffic: number // 今日使用流量(Bytes)
qid: string | null // QQ 号(用于头像)
sprovider: boolean // 是否为服务商
uuid: string // 唯一用户标识符
group?: string // 用户组 (user/admin/sprovider)
}响应格式兼容
后端是否存在返回 status: 200 和 status: true 两种成功格式,resolveUserInfoPayload() 同时接受两者,并兼容 data 包裹:
typescript
function resolveUserInfoPayload(res: unknown): UserInfo | null {
const response = res as Record<string, unknown>
if (response.status !== 200 && response.status !== true) return null
const payload = response.data
const raw = (payload && typeof payload === 'object' ? payload : response) as Record<string, unknown>
// 归一化字符串布尔字段,避免模板把 "false" 当 truthy
const info: Record<string, unknown> = { ...raw }
if ('realname' in info) info.realname = toBool(info.realname)
if ('sprovider' in info) info.sprovider = toBool(info.sprovider)
return info as unknown as UserInfo
}字符串布尔值
/user type=info 把 realname、sprovider 返回成字符串。若原样传入模板,"false" 会被当成 truthy,导致「未实名」显示成「已实名」。store 内已用 toBool() 归一化,模板请直接用布尔判断。
Token 过期自动登出
typescript
function scheduleTokenExpiry(expiry: number) {
clearTokenExpiryTimer()
if (!Number.isFinite(expiry)) return // 旧格式纯字符串 Token 不设过期
const delay = expiry - Date.now()
if (delay <= 0) {
logout()
return
}
tokenExpiryTimer = window.setTimeout(() => logout(), delay)
}useThemeStore
| 名称 | 类型 | 说明 |
|---|---|---|
isDark | Ref<boolean> | 是否深色模式(含 theme 的 watch,写入 html.dark) |
theme | Ref<GlobalTheme | null> | Naive UI 主题对象(darkTheme / null) |
animeStyle | Ref<boolean> | 二次元风格(html.anime-style + 预加载壁纸) |
menuPosition | Ref<'left' | 'top'> | 菜单位置(移动端强制 top) |
actualMenuPosition | ComputedRef | 实际生效的菜单位置 |
isMobile | Ref<boolean> | 是否移动端(断点 768px) |
initMobileDetection() | 方法 | 初始化移动端监听,注册 resize 与 themechange 事件 |
toggleTheme() / setDark() / setLight() | 方法 | 主题切换 |
toggleAnimeStyle() / setAnimeStyle(v) | 方法 | 二次元风格开关 |
setMenuPosition(pos) | 方法 | 设置菜单位置(移动端不允许 left) |
syncThemeFromStorage() | 方法 | 外部改动(彩蛋)后同步状态 |
typescript
const MOBILE_BREAKPOINT = 768
const isDark = ref<boolean>(localStorage.getItem('theme') === 'dark')
const animeStyle = ref<boolean>(localStorage.getItem('animeStyle') === 'true')
const theme = ref<GlobalTheme | null>(isDark.value ? darkTheme : null)
const menuPosition = ref<'left' | 'top'>(getStoredMenuPosition())
themechange事件由main.ts的控制台彩蛋(HayFrp())触发,每 500ms 切换一次明暗,store 监听后同步。
localStorage 键一览
| 键名 | 写入方 | 值 / 说明 |
|---|---|---|
csrf | utils/token.ts | JSON { token, expiry },登录态唯一来源 |
theme | stores/theme.ts | 'dark' / 'light' |
animeStyle | stores/theme.ts | 'true' / 'false' |
menuPosition | stores/theme.ts | 'left' / 'top' |
hayfrp-locale | i18n/index.ts | zh-CN / zh-TW / en-US / ja-JP / ru-RU |
customize_settings | views/Customize.vue | JSON:primaryColor、headerBg、cardBg、compactMode、showAnimations |
hayfrp_notifications | composables/useNotification.ts | 通知历史(最多 50 条) |
hayfrp_notification_enabled | composables/useNotification.ts | 'true' / 'false',通知总开关 |
hayfrp_announcement_dismissed | components/AnnouncementModal.vue | 已关闭公告的标识与时间(24 小时内不重复弹出) |
hayfrp_cn_redirect_never | components/CnRedirectModal.vue | '1' 表示「不再显示」国内域名提示(旧键 hayfrp_cn_redirect_rejected) |
cloud-control-autorun-cache | views/CloudControl.vue | 各设备最近保存的自动命令缓存 |
浏览器通知(useNotification)
src/composables/useNotification.ts 是一个模块级单例 composable:
| 导出 | 说明 |
|---|---|
isSupported | 'Notification' in window |
permission | 当前浏览器通知权限 |
notificationEnabled | 用户是否开启通知(持久化) |
notificationHistory / unreadCount | 通知历史与未读数 |
requestPermission() | 请求通知权限 |
setNotificationEnabled(enabled) | 开关通知并持久化 |
notify(title, options) | 发通知 + 写入历史(5 秒自动关闭,点击聚焦窗口) |
notifyProxyStatus(name, online) | 隧道上线 / 下线通知 |
markAllAsRead() / markAsRead(id) / clearNotifications() | 历史管理 |
formatNotificationTime(ts) | 相对时间格式化(刚刚 / x 分钟前 / x 小时前 / 日期) |
TIP
即使浏览器通知未授权或用户关闭了开关,notify() 仍会把消息写入历史,所以在通知中心里依然能看到记录。