@jiangood/springboot-admin-starter 0.0.3 → 0.0.5

package/src/framework/utils/EventBusUtils.ts

@@ -0,0 +1,143 @@
+/**
+ * 事件总线工具类 (Static Utility Class 模式) - 所有方法和状态均为静态
+ * forked form https://github.com/scottcorgan/tiny-emitter
+ */
+
+// --- 内部类型定义 ---
+
+/** 定义事件回调的结构 */
+interface StaticEventEntry<T extends any[]> {
+    fn: (...args: T) => void;
+    ctx?: any;
+}
+
+/** 定义用于 once 的特殊回调，用于在 off 时查找原始回调 */
+type StaticOnceCallback<T extends any[]> = ((...args: T) => void) & {
+    __callback?: ((...args: T) => void);
+};
+
+/** 定义事件映射的类型 */
+interface StaticEventStack {
+    [key: string]: StaticEventEntry<any[]>[];
+}
+
+/**
+ * 静态事件总线工具类
+ * 所有方法和状态均通过静态属性直接访问。
+ */
+export class EventBusUtils {
+    // 静态内部状态
+    private static __stack: StaticEventStack = {};
+
+    /**
+     * 静态工具类，无需实例化，因此构造函数私有化防止意外创建实例。
+     */
+    private constructor() {
+        // 静态工具类，无须实现
+    }
+
+    /**
+     * 注册事件监听器
+     * @param name 事件名称
+     * @param callback 事件回调函数
+     * @param ctx 回调函数的 this 上下文
+     */
+    public static on<T extends any[] = []>(
+        name: string,
+        callback: (...args: T) => void,
+        ctx?: any
+    ): void { // 静态方法通常不返回 this
+        if (!EventBusUtils.__stack[name]) {
+            EventBusUtils.__stack[name] = [];
+        }
+
+        (EventBusUtils.__stack[name] as StaticEventEntry<T>[]).push({
+            fn: callback as (...args: any[]) => void,
+            ctx
+        });
+    }
+
+    /**
+     * 注册只触发一次的事件监听器
+     * @param name 事件名称
+     * @param callback 事件回调函数
+     * @param ctx 回调函数的 this 上下文
+     */
+    public static once<T extends any[] = []>(
+        name: string,
+        callback: (...args: T) => void,
+        ctx?: any
+    ): void {
+        const listener: StaticOnceCallback<T> = (...args) => {
+            // 触发后立即移除
+            EventBusUtils.off(name, listener as unknown as ((...args: T) => void));
+            callback.apply(ctx, args);
+        };
+
+        // 存储原始回调，方便 off 时查找
+        listener.__callback = callback;
+
+        return EventBusUtils.on(name, listener, ctx);
+    }
+
+    /**
+     * 触发事件
+     * @param name 事件名称
+     * @param args 传递给回调函数的参数
+     */
+    public static emit<T extends any[] = []>(
+        name: string,
+        ...args: T
+    ): void {
+        const list = EventBusUtils.__stack[name] as StaticEventEntry<T>[];
+
+        if (list !== undefined) {
+            // 使用 slice(0) 确保在回调中 off 不会影响当前循环
+            list.slice(0).forEach(entry => {
+                entry.fn.apply(entry.ctx, args);
+            });
+        }
+    }
+
+    /**
+     * 移除事件监听器
+     * @param name 事件名称
+     * @param callback 可选：要移除的特定回调函数。如果省略，则移除该事件名的所有监听器。
+     */
+    public static off<T extends any[] = []>(
+        name: string,
+        callback?: ((...args: T) => void)
+    ): void {
+        const list = EventBusUtils.__stack[name];
+
+        if (list === undefined) {
+            return;
+        }
+
+        // 移除所有监听器
+        if (callback === undefined) {
+            delete EventBusUtils.__stack[name];
+            return;
+        }
+
+        // 移除特定监听器
+        const liveEvents = list.filter(
+            entry =>
+                // 排除当前回调
+                entry.fn !== callback &&
+                // 排除 once 包装的回调，通过 __callback 匹配原始回调
+                (entry.fn as StaticOnceCallback<T>).__callback !== callback
+        );
+
+        if (liveEvents.length !== 0) {
+            EventBusUtils.__stack[name] = liveEvents;
+        } else {
+            delete EventBusUtils.__stack[name];
+        }
+    }
+}
+
+/* 推荐的使用方式：直接通过类名调用静态方法 */
+// import { EventBusUtils } from './EventBusUtils';
+// EventBusUtils.on('myStaticEvent', (data) => console.log(data));
+// EventBusUtils.emit('myStaticEvent', { status: 'ok' });

package/src/framework/utils/MessageUtils.tsx

@@ -0,0 +1,182 @@
+import {Input, message, Modal, notification} from 'antd';
+import type {ModalFuncProps} from 'antd/es/modal/interface';
+import type {ArgsProps, NotificationPlacement} from 'antd/es/notification/interface';
+import React from 'react';
+import {ThemeUtils} from './system/ThemeUtils';
+
+
+let color =  ThemeUtils.getColor('primary-color');
+const buttonStyles = {
+    root: {
+        backgroundColor: color
+    }
+}
+
+/**
+ * 消息工具类 (MsgUtils)
+ * 封装了 Ant Design 的 Modal, message, 和 notification 静态方法
+ */
+export class MessageUtils {
+    // --- Antd Modal 封装 (Alert/Confirm/Prompt) ---
+
+    /**
+     * 弹出 Alert 提示框
+     */
+    static alert(content: React.ReactNode, config?: Omit<ModalFuncProps, 'content' | 'icon' | 'onOk' | 'onCancel'>) {
+        Modal.info({
+            title: '提示',
+            content,
+            okText: '确定',
+            icon: null,
+            okButtonProps: {
+                styles: buttonStyles
+            },
+            ...config,
+        });
+    }
+
+    /**
+     * 弹出 Confirm 确认框
+     */
+    static confirm(content: React.ReactNode, config?: Omit<ModalFuncProps, 'content' | 'icon' | 'onOk' | 'onCancel'>) {
+        return new Promise((resolve) => {
+            Modal.confirm({
+                title: '确认操作',
+                content,
+                okText: '确定',
+                cancelText: '取消',
+                onOk: () => resolve(true),
+                onCancel: () => resolve(false),
+                okButtonProps: {
+                    styles: buttonStyles
+                },
+                ...config,
+            });
+        })
+
+    }
+
+    /**
+     * 弹出 Prompt 输入框对话框
+     */
+    static prompt(message: React.ReactNode, initialValue?: string, placeholder?: string, config?: Omit<ModalFuncProps, 'content' | 'title' | 'icon' | 'onOk'>) {
+        return new Promise((resolve) => {
+            const ref = React.createRef()
+            Modal.confirm({
+                icon: null,
+                title: '提示',
+                content: <div>
+                    <div style={{marginBottom: 4}}>{message}</div>
+                    <Input ref={ref} placeholder={placeholder}/>
+                </div>,
+                okText: '确定',
+                cancelText: '取消',
+                onOk: () => {
+                    const inputInstance = ref.current;
+                    const inputElement = inputInstance.input;
+                    const inputValue = inputElement.value;
+                    resolve(inputValue)
+                },
+                onCancel: () => {
+                    resolve()
+                },
+                okButtonProps: {
+                    styles: buttonStyles
+                },
+                ...config,
+            });
+        })
+    }
+
+    // --- Antd message 封装 (全局通知/Loading) ---
+
+    /**
+     * 成功消息
+     */
+    static success(content: React.ReactNode, duration: number = 3) {
+        message.success(content, duration);
+    }
+
+    /**
+     * 错误消息
+     */
+    static error(content: React.ReactNode, duration: number = 3) {
+        message.error(content, duration);
+    }
+
+    /**
+     * 警告消息
+     */
+    static warning(content: React.ReactNode, duration: number = 3) {
+        message.warning(content, duration);
+    }
+
+    /**
+     * 通用消息
+     */
+    static info(content: React.ReactNode, duration: number = 3) {
+        message.info(content, duration);
+    }
+
+    /**
+     * 弹出 Loading 提示
+     */
+    static loading(content: React.ReactNode = '正在加载...', duration?: number) {
+        return message.loading({content, duration: duration === undefined ? 0 : duration});
+    }
+
+    /**
+     * 立即关闭所有 message 提示
+     */
+    static hideAll() {
+        message.destroy();
+    }
+
+    // --- Antd Notification 封装 (通知提醒框) ---
+
+    /**
+     * 弹出右上角通知提醒框
+     */
+    static notify(
+        message: React.ReactNode,
+        description: React.ReactNode,
+        type: 'success' | 'error' | 'info' | 'warning' | 'open' | 'config' = 'open',
+        placement: NotificationPlacement = 'topRight',
+        config?: Omit<ArgsProps, 'message' | 'description' | 'placement'>,
+    ) {
+        const notifyFunc = notification[type];
+        notifyFunc({
+            message,
+            description,
+            placement,
+            ...config,
+        });
+    }
+
+    /**
+     * 弹出成功通知
+     */
+    static notifySuccess(message: React.ReactNode, description: React.ReactNode, placement?: NotificationPlacement, config?: Omit<ArgsProps, 'message' | 'description' | 'placement'>) {
+        MessageUtils.notify(message, description, 'success', placement, config);
+    }
+
+    /**
+     * 弹出失败通知
+     */
+    static notifyError(message: React.ReactNode, description: React.ReactNode, placement?: NotificationPlacement, config?: Omit<ArgsProps, 'message' | 'description' | 'placement'>) {
+        MessageUtils.notify(message, description, 'error', placement, config);
+    }
+
+    /**
+     * 弹出警告通知
+     */
+    static notifyWarning(
+        message: React.ReactNode,
+        description: React.ReactNode,
+        placement?: NotificationPlacement,
+        config?: Omit<ArgsProps, 'message' | 'description' | 'placement'>,
+    ) {
+        MessageUtils.notify(message, description, 'warning', placement, config);
+    }
+}
+

package/src/framework/utils/ObjectUtils.ts

@@ -0,0 +1,113 @@
+/**
+ * ObjectUtils 提供了对对象进行操作的静态方法，例如安全地获取嵌套属性和复制属性。
+ */
+export class ObjectUtils {
+
+    /**
+     * 🎯 安全地获取深度嵌套的对象属性的值。
+     * 如果属性链中的任何一级为 undefined 或 null，getDefinition 函数会返回一个默认值，而不是抛出错误。
+     *
+     * @template TObj 目标对象的类型。
+     * @template TDefault 默认值的类型。
+     * @param obj 要查找属性的对象。
+     * @param path 属性路径，可以是点分隔的字符串（如 'a.b.c'）或字符串数组（如 ['a', '0', 'b', 'c']）。
+     * @param defaultValue 如果属性不存在或路径中有 null/undefined 值时返回的默认值。
+     * @returns 属性的值，如果找不到则返回 defaultValue。
+     *
+     * @example
+     * const obj = { 'a': [{ 'b': { 'c': 3 } }] };
+     * const value = ObjectUtils.getDefinition(obj, 'a[0].b.c', 0); // 3
+     * const missing = ObjectUtils.getDefinition(obj, 'a[1].d', 'default'); // 'default'
+     */
+    static get<TObj extends object, TDefault = unknown>(
+        obj: TObj | null | undefined,
+    path: string | (keyof TObj)[],
+    defaultValue: TDefault | undefined = undefined
+): unknown | TDefault {
+
+    // 路径处理：将 'a[0].b.c' 转换为 ['a', '0', 'b', 'c'] 以支持数组索引
+    // 注意：这里简化处理，只处理点分隔符，如果需要完整的 lodash getDefinition 行为，需要更复杂的正则解析。
+    const pathArray: string[] = Array.isArray(path)
+        ? path.map(String) // 确保路径段都是字符串
+        : path.split('.');
+
+    let result: any = obj;
+
+    // 遍历路径
+    for (const segment of pathArray) {
+    // 如果当前结果是 null 或 undefined，则后续路径无法访问，返回默认值
+    if (result == null) {
+    return defaultValue;
+}
+
+// 尝试访问属性
+// 使用 segment 作为索引，TypeScript 默认这里是合法的
+result = result[segment];
+}
+
+// 如果最终结果是 null 或 undefined，则返回默认值；否则返回结果
+return result !== null && result !== undefined ? result : defaultValue;
+}
+
+
+/**
+ * 📋 复制对象属性，仅复制源对象 (source) 中 **存在** 且目标对象 (target) 中 **也有** 对应属性的那些值。
+ * 主要用于根据目标对象的结构来过滤和填充数据。
+ *
+ * @param source 源对象。
+ * @param target 目标对象。
+ * @returns void
+ */
+static copyPropertyIfPresent<TSource extends object, TTarget extends object>(
+    source: TSource | null | undefined,
+    target: TTarget | null | undefined
+): void {
+    if (!source || !target || typeof source !== 'object' || typeof target !== 'object') {
+    return;
+}
+
+// 遍历目标对象的键，确保我们只复制目标对象上已有的属性
+const keys = Object.keys(target) as (keyof TTarget)[];
+
+for (const key of keys) {
+    // 检查源对象是否有这个属性
+    if (Object.hasOwn(source, key)) {
+        // 因为目标对象和源对象都被约束为 object，所以这里的类型转换是相对安全的
+        const value = (source as any)[key];
+        (target as any)[key] = value;
+    }
+}
+}
+
+
+/**
+ * 📝 复制对象属性，将源对象 (source) 中 **非 undefined** 的属性值复制到目标对象 (target) 对应的属性上。
+ * 仅复制目标对象 (target) 中 **已有** 的属性，如果源对象中的值是 undefined 则不复制。
+ *
+ * @param source 源对象。
+ * @param target 目标对象。
+ * @returns void
+ */
+static copyProperty<TSource extends object, TTarget extends object>(
+    source: TSource | null | undefined,
+    target: TTarget | null | undefined
+): void {
+    if (!source || !target || typeof source !== 'object' || typeof target !== 'object') {
+    return;
+}
+
+// 遍历目标对象的键
+const keys = Object.keys(target) as (keyof TTarget)[];
+
+for (const key of keys) {
+    // 尝试从源对象获取值
+    const value = (source as any)[key];
+
+    // 只有当值明确不是 undefined 时才复制（即允许复制 null 或其他 falsy 值）
+    if (value !== undefined) {
+        (target as any)[key] = value;
+    }
+}
+}
+
+}

package/src/framework/utils/StorageUtils.ts

@@ -0,0 +1,67 @@
+import { DateUtils } from "./DateUtils";
+
+/**
+ * 存储工具类
+ * 使用 localStorage 进行数据的存取，并包含时间戳和默认值处理。
+ */
+export class StorageUtils {
+
+    /**
+     * 从 localStorage 获取数据。
+     * @param key 存储的键。
+     * @param defaultValue 如果找不到键或值，返回的默认值 (默认为 null)。
+     * @returns 存储的值或默认值。
+     */
+    static get<T>(key: string, defaultValue: T | null = null): T | null {
+        // 尝试从 localStorage 获取原始字符串
+        const vStr = localStorage.getItem(key);
+
+        // 如果没有存储项
+        if (vStr == null) {
+            return defaultValue;
+        }
+
+        try {
+            // 解析存储的项
+            const item: { createTime: number; data: T } = JSON.parse(vStr);
+
+            // 返回实际存储的数据
+            return item.data;
+
+        } catch (error) {
+            // 如果 JSON 解析失败 (例如，存储的值不是一个包含 createTime 和 data 的有效 JSON 结构)
+            console.error(`Error parsing storage item for key: ${key}`, error);
+            return defaultValue;
+        }
+    }
+
+    /**
+     * 将数据存储到 localStorage。
+     * 如果值为 null 或 undefined，则删除该键。
+     * @param key 存储的键。
+     * @param value 要存储的值。
+     */
+    static set<T>(key: string, value: T | null | undefined): void {
+        // 如果值为 null 或 undefined，则删除该键
+        if (value == null) {
+            localStorage.removeItem(key);
+            return;
+        }
+
+        // 构造包含时间戳的对象
+        const item = {
+            createTime: DateUtils.now(), // 假设 DateUtil.now() 返回 number 类型的时间戳
+            data: value
+        };
+
+        try {
+            // 序列化对象
+            const dataStr = JSON.stringify(item);
+            // 存储到 localStorage
+            localStorage.setItem(key, dataStr);
+        } catch (error) {
+            // 捕获 JSON.stringify 错误 (例如，如果 value 包含循环引用)
+            console.error(`Error stringifying storage value for key: ${key}`, error);
+        }
+    }
+}