Lion项目中的Singleton Manager技术解析-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00371/article/details/148944746

Lion项目中的Singleton Manager技术解析

前言

在现代前端开发中，模块化和组件化已经成为主流开发模式。然而，在某些场景下，我们需要确保某些类或对象在整个应用中保持单例状态。特别是在大型项目中，当不同版本的依赖包同时存在时，如何维护单例的正确性就成为一个技术挑战。本文将深入解析Lion项目中的Singleton Manager解决方案。

什么是Singleton Manager

Singleton Manager是Lion项目中提供的一个工具，它解决了在多版本依赖环境下保持单例一致性的问题。它的核心功能是确保从不同文件位置加载的单例实例始终保持单例特性。

典型应用场景

想象这样一个场景：

你的应用有两个页面
页面A使用overlays包的1.x版本
页面B使用overlays包的2.x版本（嵌套安装）

在这种情况下，overlays包中的OverlaysManager需要保持单例特性，但由于版本不同，默认情况下会创建两个不同的实例，导致状态不一致。

安装与基本使用

安装方法

npm install --save singleton-manager

重要提示：必须确保系统中只安装了一个版本的singleton-manager。

基本使用示例

方案一：使用相同的单例实例

import { singletonManager } from 'singleton-manager';
import { mySingleton } from 'my-singleton'; // 同时存在1.x和2.x版本

// 为两个版本设置相同的单例实例
singletonManager.set('my-singleton::index.js::1.x', mySingleton);
singletonManager.set('my-singleton::index.js::2.x', mySingleton);

方案二：创建兼容版本

import { singletonManager } from 'singleton-manager';
import { MySingleton } from 'my-singleton';

// 创建兼容两个版本的子类
class CompatibleSingleton extends MySingleton {
  // 添加向前或向后兼容代码
}
const compatibleSingleton = new CompatibleSingleton();

// 设置兼容实例
singletonManager.set('my-singleton::index.js::1.x', compatibleSingleton);
singletonManager.set('my-singleton::index.js::2.x', compatibleSingleton);

应用中使用

在你的应用中，需要在加载单例或任何使用它的功能之前，先加载上述配置代码：

import './managed-my-singleton.js'; // 先加载配置
import { mySingleton } from 'my-singleton'; // 现在会使用配置的单例

关键注意事项

覆盖版本是应用级关注点：组件或功能模块不应使用此功能。如果多次为同一个键调用set方法，只有第一次设置的值会被保留。
单例键命名规范：键需要保证在包内唯一，推荐格式为<package>::<unique-variable>::<semver-range>。

正确示例：
- overlays::overlays::1.x
- @scope/overlays::overlays::1.x
- overlays::overlays::0.10.x
错误示例：
- overlays (太泛泛)
- overlays::overlays (缺少版本)
- overlays::1.x (缺少包名和唯一变量)

实现原理

Singleton Manager的工作原理是通过一个全局管理器来维护单例实例。当应用代码请求单例时，管理器会检查是否已经为该键注册了实例，如果有则返回注册的实例，否则返回默认实例。

单例维护者最佳实践

如果你是单例的维护者，应该检查是否设置了singleton manager版本，如果是则返回它而不是默认实例：

import { singletonManager } from 'singleton-manager';
import { MySingleton } from './src/MySingleton.js';

export const overlays = 
  singletonManager.get('my-singleton/my-singleton.js::1.x') || new MySingleton();

高级应用场景

场景一：简单兼容

当两个版本间的差异只是方法重命名时，可以通过创建兼容子类来解决：

class CompatibleOverlaysManager extends OverlaysManager {
  blockingBody() { this.block(); }  // 兼容2.x
  unBlockingBody() { this.unBlock(); }  // 兼容2.x
}

场景二：复杂兼容

当两个版本间的差异涉及属性类型变化等不兼容修改时，可以创建两个实例并通过数据同步保持一致性：

const compatibleManager1 = new CompatibleManager1(); // 1.x版本兼容
const compatibleManager2 = new CompatibleManager2(); // 2.x版本兼容

// 设置两个版本的不同实例
singletonManager.set('overlays::overlays::1.x', compatibleManager1);
singletonManager.set('overlays::overlays::2.x', compatibleManager2);

// 在实例间同步重要数据