| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234 |
- import type { DeepPartial } from '@vben-core/typings';
- import type { InitialOptions, Preferences } from './types';
- import { markRaw, reactive, readonly, watch } from 'vue';
- import { StorageManager } from '@vben-core/shared/cache';
- import { isMacOs, merge } from '@vben-core/shared/utils';
- import {
- breakpointsTailwind,
- useBreakpoints,
- useDebounceFn,
- } from '@vueuse/core';
- import { defaultPreferences } from './config';
- import { updateCSSVariables } from './update-css-variables';
- const STORAGE_KEYS = {
- MAIN: 'preferences',
- LOCALE: 'preferences-locale',
- THEME: 'preferences-theme',
- } as const;
- class PreferenceManager {
- private cache: StorageManager;
- private debouncedSave: (preference: Preferences) => void;
- private initialPreferences: Preferences = defaultPreferences;
- private isInitialized = false;
- private state: Preferences;
- constructor() {
- this.cache = new StorageManager();
- this.state = reactive<Preferences>(
- this.loadFromCache() || { ...defaultPreferences },
- );
- this.debouncedSave = useDebounceFn(
- (preference) => this.saveToCache(preference),
- 150,
- );
- }
- /**
- * 清除所有缓存的偏好设置
- */
- clearCache = () => {
- Object.values(STORAGE_KEYS).forEach((key) => this.cache.removeItem(key));
- };
- /**
- * 获取初始化偏好设置
- */
- getInitialPreferences = () => {
- return this.initialPreferences;
- };
- /**
- * 获取当前偏好设置(只读)
- */
- getPreferences = () => {
- return readonly(this.state);
- };
- /**
- * 初始化偏好设置
- * @param options - 初始化配置项
- * @param options.namespace - 命名空间,用于隔离不同应用的配置
- * @param options.overrides - 要覆盖的偏好设置
- */
- initPreferences = async ({ namespace, overrides }: InitialOptions) => {
- // 防止重复初始化
- if (this.isInitialized) {
- return;
- }
- // 使用命名空间初始化存储管理器
- this.cache = new StorageManager({ prefix: namespace });
- // 合并初始偏好设置
- this.initialPreferences = merge({}, overrides, defaultPreferences);
- // 加载缓存的偏好设置并与初始配置合并
- const cachedPreferences = this.loadFromCache() || {};
- const mergedPreference = merge(
- {},
- cachedPreferences,
- this.initialPreferences,
- );
- // 更新偏好设置
- this.updatePreferences(mergedPreference);
- // 设置监听器
- this.setupWatcher();
- // 初始化平台标识
- this.initPlatform();
- this.isInitialized = true;
- };
- /**
- * 重置偏好设置到初始状态
- */
- resetPreferences = () => {
- // 将状态重置为初始偏好设置
- Object.assign(this.state, this.initialPreferences);
- // 保存偏好设置至缓存
- this.saveToCache(this.state);
- // 直接触发 UI 更新
- this.handleUpdates(this.state);
- };
- /**
- * 更新偏好设置
- * @param updates - 要更新的偏好设置
- */
- updatePreferences = (updates: DeepPartial<Preferences>) => {
- // 深度合并更新内容和当前状态
- const mergedState = merge({}, updates, markRaw(this.state));
- Object.assign(this.state, mergedState);
- // 根据更新的值执行更新
- this.handleUpdates(updates);
- // 保存到缓存
- this.debouncedSave(this.state);
- };
- /**
- * 处理更新
- * @param updates - 更新的偏好设置
- */
- private handleUpdates(updates: DeepPartial<Preferences>) {
- const { theme, app } = updates;
- if (
- theme &&
- (Object.keys(theme).length > 0 || Reflect.has(theme, 'fontSize'))
- ) {
- updateCSSVariables(this.state);
- }
- if (
- app &&
- (Reflect.has(app, 'colorGrayMode') || Reflect.has(app, 'colorWeakMode'))
- ) {
- this.updateColorMode(this.state);
- }
- }
- /**
- * 初始化平台标识
- */
- private initPlatform() {
- document.documentElement.dataset.platform = isMacOs() ? 'macOs' : 'window';
- }
- /**
- * 从缓存加载偏好设置
- * @returns 缓存的偏好设置,如果不存在则返回 null
- */
- private loadFromCache(): null | Preferences {
- return this.cache.getItem<Preferences>(STORAGE_KEYS.MAIN);
- }
- /**
- * 保存偏好设置到缓存
- * @param preference - 要保存的偏好设置
- */
- private saveToCache(preference: Preferences) {
- this.cache.setItem(STORAGE_KEYS.MAIN, preference);
- this.cache.setItem(STORAGE_KEYS.LOCALE, preference.app.locale);
- this.cache.setItem(STORAGE_KEYS.THEME, preference.theme.mode);
- }
- /**
- * 监听状态和系统偏好设置的变化
- */
- private setupWatcher() {
- if (this.isInitialized) {
- return;
- }
- // 监听断点,判断是否移动端
- const breakpoints = useBreakpoints(breakpointsTailwind);
- const isMobile = breakpoints.smaller('md');
- watch(
- () => isMobile.value,
- (val) => {
- this.updatePreferences({
- app: { isMobile: val },
- });
- },
- { immediate: true },
- );
- // 监听系统主题偏好设置变化
- window
- .matchMedia('(prefers-color-scheme: dark)')
- .addEventListener('change', ({ matches: isDark }) => {
- // 仅在自动模式下跟随系统主题
- if (this.state.theme.mode === 'auto') {
- // 先应用实际的主题
- this.updatePreferences({
- theme: { mode: isDark ? 'dark' : 'light' },
- });
- // 再恢复为 auto 模式,保持跟随系统的状态
- this.updatePreferences({
- theme: { mode: 'auto' },
- });
- }
- });
- }
- /**
- * 更新页面颜色模式(灰色、色弱)
- * @param preference - 偏好设置
- */
- private updateColorMode(preference: Preferences) {
- const { colorGrayMode, colorWeakMode } = preference.app;
- const dom = document.documentElement;
- dom.classList.toggle('invert-mode', colorWeakMode);
- dom.classList.toggle('grayscale-mode', colorGrayMode);
- }
- }
- const preferencesManager = new PreferenceManager();
- export { PreferenceManager, preferencesManager };
|