refactor: ♻️ 重构存储键命名规范

This commit is contained in:
Ray.Hao
2025-09-09 11:03:27 +08:00
parent e84d87d403
commit 070a43d540
5 changed files with 148 additions and 79 deletions

View File

@@ -6,23 +6,24 @@ import en from "element-plus/es/locale/lang/en";
import { store } from "@/store";
import { DeviceEnum } from "@/enums/settings/device.enum";
import { SidebarStatus } from "@/enums/settings/layout.enum";
import { STORAGE_KEYS } from "@/constants";
export const useAppStore = defineStore("app", () => {
// 设备类型
const device = useStorage("device", DeviceEnum.DESKTOP);
const device = useStorage(STORAGE_KEYS.DEVICE, DeviceEnum.DESKTOP);
// 布局大小
const size = useStorage("size", defaultSettings.size);
const size = useStorage(STORAGE_KEYS.SIZE, defaultSettings.size);
// 语言
const language = useStorage("language", defaultSettings.language);
const language = useStorage(STORAGE_KEYS.LANGUAGE, defaultSettings.language);
// 侧边栏状态
const sidebarStatus = useStorage("sidebarStatus", SidebarStatus.CLOSED);
const sidebarStatus = useStorage(STORAGE_KEYS.SIDEBAR_STATUS, SidebarStatus.CLOSED);
const sidebar = reactive({
opened: sidebarStatus.value === SidebarStatus.OPENED,
withoutAnimation: false,
});
// 顶部菜单激活路径
const activeTopMenuPath = useStorage("activeTopMenuPath", "");
const activeTopMenuPath = useStorage(STORAGE_KEYS.ACTIVE_TOP_MENU_PATH, "");
/**
* 根据语言标识读取对应的语言包

View File

@@ -1,9 +1,10 @@
import { store } from "@/store";
import DictAPI, { type DictItemOption } from "@/api/system/dict-api";
import { STORAGE_KEYS } from "@/constants";
export const useDictStore = defineStore("dict", () => {
// 字典数据缓存
const dictCache = useStorage<Record<string, DictItemOption[]>>("dict_cache", {});
const dictCache = useStorage<Record<string, DictItemOption[]>>(STORAGE_KEYS.DICT_CACHE, {});
// 请求队列(防止重复请求)
const requestQueue: Record<string, Promise<void>> = {};

View File

@@ -2,7 +2,7 @@ import { defaultSettings } from "@/settings";
import { SidebarColor, ThemeMode } from "@/enums/settings/theme.enum";
import type { LayoutMode } from "@/enums/settings/layout.enum";
import { applyTheme, generateThemeColors, toggleDarkMode, toggleSidebarColor } from "@/utils/theme";
import { SETTINGS_KEYS } from "@/constants";
import { STORAGE_KEYS } from "@/constants";
// 🎯 设置项类型定义
interface SettingsState {
@@ -26,34 +26,40 @@ type MutableSetting = Exclude<keyof SettingsState, "settingsVisible">;
type SettingValue<K extends MutableSetting> = SettingsState[K];
export const useSettingsStore = defineStore("setting", () => {
// 🎯 基础设置 - 非持久化
// 设置面板可见性
const settingsVisible = ref<boolean>(false);
// 🎯 持久化设置 - 使用分组常量
// 是否显示标签页视图
const showTagsView = useStorage<boolean>(
SETTINGS_KEYS.SHOW_TAGS_VIEW,
STORAGE_KEYS.SHOW_TAGS_VIEW,
defaultSettings.showTagsView
);
const showAppLogo = useStorage<boolean>(SETTINGS_KEYS.SHOW_APP_LOGO, defaultSettings.showAppLogo);
// 是否显示应用Logo
const showAppLogo = useStorage<boolean>(STORAGE_KEYS.SHOW_APP_LOGO, defaultSettings.showAppLogo);
// 是否显示水印
const showWatermark = useStorage<boolean>(
SETTINGS_KEYS.SHOW_WATERMARK,
STORAGE_KEYS.SHOW_WATERMARK,
defaultSettings.showWatermark
);
// 侧边栏配色方案
const sidebarColorScheme = useStorage<string>(
SETTINGS_KEYS.SIDEBAR_COLOR_SCHEME,
STORAGE_KEYS.SIDEBAR_COLOR_SCHEME,
defaultSettings.sidebarColorScheme
);
const layout = useStorage<LayoutMode>(SETTINGS_KEYS.LAYOUT, defaultSettings.layout as LayoutMode);
// 布局模式
const layout = useStorage<LayoutMode>(STORAGE_KEYS.LAYOUT, defaultSettings.layout as LayoutMode);
const themeColor = useStorage<string>(SETTINGS_KEYS.THEME_COLOR, defaultSettings.themeColor);
// 主题颜色
const themeColor = useStorage<string>(STORAGE_KEYS.THEME_COLOR, defaultSettings.themeColor);
const theme = useStorage<ThemeMode>(SETTINGS_KEYS.THEME, defaultSettings.theme);
// 主题模式(亮色/暗色)
const theme = useStorage<ThemeMode>(STORAGE_KEYS.THEME, defaultSettings.theme);
// 🎯 设置项映射
// 设置项映射,用于统一管理
const settingsMap = {
showTagsView,
showAppLogo,
@@ -62,7 +68,7 @@ export const useSettingsStore = defineStore("setting", () => {
layout,
} as const;
// 🎯 监听器 - 主题变化
// 监听主题变化,自动应用样式
watch(
[theme, themeColor],
([newTheme, newThemeColor]) => {
@@ -73,7 +79,7 @@ export const useSettingsStore = defineStore("setting", () => {
{ immediate: true }
);
// 🎯 监听器 - 侧边栏配色方案变化
// 监听侧边栏配色变化
watch(
[sidebarColorScheme],
([newSidebarColorScheme]) => {
@@ -82,7 +88,7 @@ export const useSettingsStore = defineStore("setting", () => {
{ immediate: true }
);
// 🎯 统一的设置更新方法 - 类型安全
// 通用设置更新方法
function updateSetting<K extends keyof typeof settingsMap>(key: K, value: SettingValue<K>): void {
const setting = settingsMap[key];
if (setting) {
@@ -90,7 +96,7 @@ export const useSettingsStore = defineStore("setting", () => {
}
}
// 🎯 主题相关的专用更新方法
// 主题更新方法
function updateTheme(newTheme: ThemeMode): void {
theme.value = newTheme;
}
@@ -107,7 +113,7 @@ export const useSettingsStore = defineStore("setting", () => {
layout.value = newLayout;
}
// 🎯 设置面板显示控制
// 设置面板控制
function toggleSettingsPanel(): void {
settingsVisible.value = !settingsVisible.value;
}
@@ -120,7 +126,7 @@ export const useSettingsStore = defineStore("setting", () => {
settingsVisible.value = false;
}
// 🎯 批量重置设置
// 重置所有设置
function resetSettings(): void {
showTagsView.value = defaultSettings.showTagsView;
showAppLogo.value = defaultSettings.showAppLogo;