99 lines
2.7 KiB
TypeScript
99 lines
2.7 KiB
TypeScript
/**
|
|
* 存储键名管理器模块
|
|
*
|
|
* 提供智能的版本化存储键管理和数据迁移功能
|
|
*
|
|
* ## 主要功能
|
|
*
|
|
* - 自动生成当前版本的存储键名
|
|
* - 检测当前版本数据是否存在
|
|
* - 查找其他版本的同名存储数据
|
|
* - 自动将旧版本数据迁移到当前版本
|
|
* - 数据迁移日志记录
|
|
* - 迁移失败的错误处理
|
|
*
|
|
* ## 使用场景
|
|
*
|
|
* - Pinia Store 持久化插件中获取存储键
|
|
* - 应用版本升级时自动迁移用户数据
|
|
* - 避免版本升级导致的数据丢失
|
|
* - 实现平滑的版本过渡
|
|
*
|
|
* ## 工作流程
|
|
*
|
|
* 1. 优先使用当前版本的存储键
|
|
* 2. 如果当前版本无数据，查找其他版本的同名数据
|
|
* 3. 找到旧版本数据后自动迁移到当前版本
|
|
* 4. 返回当前版本的存储键供使用
|
|
*
|
|
* @module utils/storage/storage-key-manager
|
|
* @author Art Design Pro Team
|
|
*/
|
|
/** 直连 storage-config，避免经 barrel 再 import storage.ts → userStore → store 形成循环 */
|
|
import { StorageConfig } from '@/utils/storage/storage-config'
|
|
|
|
/**
|
|
* 存储键名管理器
|
|
* 负责处理版本化的存储键名生成和数据迁移
|
|
*/
|
|
export class StorageKeyManager {
|
|
/**
|
|
* 获取当前版本的存储键名
|
|
*/
|
|
private getCurrentVersionKey(storeId: string): string {
|
|
return StorageConfig.generateStorageKey(storeId)
|
|
}
|
|
|
|
/**
|
|
* 检查当前版本的数据是否存在
|
|
*/
|
|
private hasCurrentVersionData(key: string): boolean {
|
|
return localStorage.getItem(key) !== null
|
|
}
|
|
|
|
/**
|
|
* 查找其他版本的同名存储键
|
|
*/
|
|
private findExistingKey(storeId: string): string | null {
|
|
const storageKeys = Object.keys(localStorage)
|
|
const pattern = StorageConfig.createKeyPattern(storeId)
|
|
|
|
return storageKeys.find((key) => pattern.test(key) && localStorage.getItem(key)) || null
|
|
}
|
|
|
|
/**
|
|
* 将数据从旧版本迁移到当前版本
|
|
*/
|
|
private migrateData(fromKey: string, toKey: string): void {
|
|
try {
|
|
const existingData = localStorage.getItem(fromKey)
|
|
if (existingData) {
|
|
localStorage.setItem(toKey, existingData)
|
|
console.info(`[Storage] 已迁移数据: ${fromKey} → ${toKey}`)
|
|
}
|
|
} catch (error) {
|
|
console.warn(`[Storage] 数据迁移失败: ${fromKey}`, error)
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 获取持久化存储的键名（支持自动数据迁移）
|
|
*/
|
|
getStorageKey(storeId: string): string {
|
|
const currentKey = this.getCurrentVersionKey(storeId)
|
|
|
|
// 优先使用当前版本的数据
|
|
if (this.hasCurrentVersionData(currentKey)) {
|
|
return currentKey
|
|
}
|
|
|
|
// 查找并迁移其他版本的数据
|
|
const existingKey = this.findExistingKey(storeId)
|
|
if (existingKey) {
|
|
this.migrateData(existingKey, currentKey)
|
|
}
|
|
|
|
return currentKey
|
|
}
|
|
}
|