实现一个ts单例模式基类(支持代码提示、禁止二次实例化)

另一种实现方式的传送门:【TS】另一种实现typescript单例模式的方式(支持代码提示,禁止二次实例化) - 简书 (jianshu.com)

先贴出我的代码,后面再讲讲为什么要这么做:

class Singleton {
    // 实例
    private static _instance: Singleton;
    // 是否是通过getInstance实例化
    private static _instantiateByGetInstance: boolean = false;
    
    /**
     * 获取实例
     */
    public static getInstance<T extends Singleton>(this: (new () => T) | typeof Singleton): T {
        const _class = this as typeof Singleton;
        if (!_class._instance) {
            _class._instantiateByGetInstance = true;
            _class._instance = new _class();
            _class._instantiateByGetInstance = false;
        }
        return _class._instance as T;
    }
    
    /**
     * 构造函数
     * @protected
     */
    protected constructor() {
        if (!(this.constructor as typeof Singleton)._instantiateByGetInstance) {
            throw new Error("Singleton class can't be instantiated more than once.");
        }
    }
}

我在网上搜索了一遍,大多数文章里的ts单例模式或多或少是不够完美的,我的单例模式有以下几个优点:

  1. 子类可以直接继承此Singleton类,无需其他多余代码,比如
class TestClass extends Singleton {
    
}
  1. 支持IDE代码提示
class TestClass extends Singleton {
    testFunc() {
        
    }
}
代码提示
  1. 禁止使用new关键字实例化


    禁止实例化

接下来讲讲为什么要这么写

  • getInstance有泛型参数T,它需要继承Singleton,使用的时候不需要添加泛型参数,当然加上也没问题,比如:TestClass.getInstance<TestClass>()
  • ts函数参数列表中的第一项可以为this。这个this只是用于手动告诉ts编译器它的类型,实际并不需要传入。
  • this参数的类型为(new () => T) | typeof Singleton联合类型。new () => T表示某个构造函数类型,由于TestClass继承自Singleton,同时getInstance是静态方法,所以这里的new () => T代表的是TestClass类。使用了new () => T,就能告诉编辑器当前使用了哪个类,但是这样一来构造函数使用protected或者private修饰时会在编译阶段报错,可能会提示Cannot assign a 'protected' constructor type to a 'public' constructor type.,意思是无法将“protected”构造函数类型分配给“public”构造函数类型。这时候我们可以指定this的类型为(new () => T) | typeof Singleton联合类型。typeof Singleton表示Singleton类的类型,因为在类的内部可以实例化受保护的或者私有的构造函数,从而规避掉上述错误。
  • 将构造函数用protected修饰依然无法避免某些大聪明在子类内部实例化,所以构造函数内部使用了_instantiateByGetInstance判断是否是通过getInstance方法进行实例化的。当然这个问题只能在运行期间被发现。
class TestClass extends Singleton {
    testFunc() {
        new TestClass();
    }
}
抛出错误
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容