javascript设计模式——享元模式

Posted 2020-10-17 小火柴的蓝色理想

[1]享元模式初识 [2]文件上传 [3]适用性 [4]对象池

前面的话

　　享元（flyweight）模式是一种用于性能优化的模式，“fly”在这里是苍蝇的意思，意为蝇量级。享元模式的核心是运用共享技术来有效支持大量细粒度的对象。如果系统中因为创建了大量类似的对象而导致内存占用过高，享元模式就非常有用了。在javascript中，浏览器特别是移动端的浏览器分配的内存并不算多，如何节省内存就成了一件非常有意义的事情。本文将详细介绍享元模式

 

享元模式初识

　　假设有个内衣工厂，目前的产品有50种男式内衣和50种女士内衣，为了推销产品，工厂决定生产一些塑料模特来穿上他们的内衣拍成广告照片。正常情况下需要50个男模特和50个女模特，然后让他们每人分别穿上一件内衣来拍照。不使用享元模式的情况下，在程序里也许会这样写：

var Model = function( sex, underwear){
    this.sex = sex;
    this.underwear= underwear;
};
Model.prototype.takePhoto = function(){
    console.log( \'sex= \' + this.sex + \' underwear=\' + this.underwear);
};
for ( var i = 1; i <= 50; i++ ){
    var maleModel = new Model( \'male\', \'underwear\' + i );
    maleModel.takePhoto();
};
for ( var j = 1; j <= 50; j++ ){
    var femaleModel= new Model( \'female\', \'underwear\' + j );
    femaleModel.takePhoto();
};

　　要得到一张照片，每次都需要传入sex和underwear参数，如上所述，现在一共有50种男内衣和50种女内衣，所以一共会产生100个对象。如果将来生产了10000种内衣，那这个程序可能会因为存在如此多的对象已经提前崩溃

　　下面来考虑一下如何优化这个场景。虽然有100种内衣，但很显然并不需要50个男模特和50个女模特。其实男模特和女模特各自有一个就足够了，他们可以分别穿上不同的内衣来拍照

　　现在来改写一下代码，既然只需要区别男女模特，那先把underwear参数从构造函数中移除，构造函数只接收sex参数：

var Model = function( sex ){
    this.sex = sex;
};
Model.prototype.takePhoto = function(){
    console.log( \'sex= \' + this.sex + \' underwear=\' + this.underwear);
};

　　分别创建一个男模特对象和一个女模特对象：

var maleModel = new Model( \'male\' ),
femaleModel = new Model( \'female\' );

　　给男模特依次穿上所有的男装，并进行拍照：

for ( var i = 1; i <= 50; i++ ){
    maleModel.underwear = \'underwear\' + i;
    maleModel.takePhoto();
};

　　同样，给女模特依次穿上所有的女装，并进行拍照：

for ( var j = 1; j <= 50; j++ ){
    femaleModel.underwear = \'underwear\' + j;
    femaleModel.takePhoto();
};

　　可以看到，改进之后的代码，只需要两个对象便完成了同样的功能

【内部状态与外部状态】

　　上面的这个例子便是享元模式的雏形，享元模式要求将对象的属性划分为内部状态与外部状态（状态在这里通常指属性）。享元模式的目标是尽量减少共享对象的数量，关于如何划分内部状态和外部状态，下面的几条经验提供了一些指引

　　1、内部状态存储于对象内部。

　　2、内部状态可以被一些对象共享。

　　3、内部状态独立于具体的场景，通常不会改变。

　　4、外部状态取决于具体的场景，并根据场景而变化，外部状态不能被共享

　　这样一来，便可以把所有内部状态相同的对象都指定为同一个共享的对象。而外部状态可以从对象身上剥离出来，并储存在外部

　　剥离了外部状态的对象成为共享对象，外部状态在必要时被传入共享对象来组装成一个完整的对象。虽然组装外部状态成为一个完整对象的过程需要花费一定的时间，但却可以大大减少系统中的对象数量，相比之下，这点时间或许是微不足道的。因此，享元模式是一种用时间换空间的优化模式

　　在上面的例子中，性别是内部状态，内衣是外部状态，通过区分这两种状态，大大减少了系统中的对象数量。通常来讲，内部状态有多少种组合，系统中便最多存在多少个对象，因为性别通常只有男女两种，所以该内衣厂商最多只需要2个对象

　　使用享元模式的关键是如何区别内部状态和外部状态。可以被对象共享的属性通常被划分为内部状态，如同不管什么样式的衣服，都可以按照性别不同，穿在同一个男模特或者女模特身上，模特的性别就可以作为内部状态储存在共享对象的内部。而外部状态取决于具体的场景，并根据场景而变化，就像例子中每件衣服都是不同的，它们不能被一些对象共享，因此只能被划分为外部状态

　　上面的例子还不是一个完整的享元模式，存在以下两个问题

　　1、通过构造函数显式new出了男女两个model对象，在其他系统中，也许并不是一开始就需要所有的共享对象

　　2、给model对象手动设置了underwear外部状态，在更复杂的系统中，这不是一个最好的方式，因为外部状态可能会相当复杂，它们与共享对象的联系会变得困难

　　通过一个对象工厂来解决第一个问题，只有当某种共享对象被真正需要时，它才从工厂中被创建出来。对于第二个问题，可以用一个管理器来记录对象相关的外部状态，使这些外部状态通过某个钩子和共享对象联系起来

 

文件上传

【基本版本】

　　在文件上传模块的开发中，文件上传功能虽然可以选择依照队列，一个一个地排队上传，但也支持同时选择2000个文件。每一个文件都对应着一个javascript上传对象的创建，往程序里同时new了2000个upload对象，结果可想而知，Chrome中还勉强能够支撑，IE下直接进入假死状态

　　文件支持好几种上传方式，比如浏览器插件、Flash和表单上传等，为了简化例子，先假设只有插件和Flash这两种。不论是插件上传，还是Flash上传，原理都是一样的，当用户选择了文件之后，插件和Flash都会通知调用Window下的一个全局javascript函数，它的名字是startUpload，用户选择的文件列表被组合成一个数组files塞进该函数的参数列表里，代码如下：

var id = 0;
window.startUpload = function( uploadType, files ){ // uploadType 区分是控件还是flash
    for ( var i = 0, file; file = files[ i++ ]; ){
        var uploadObj = new Upload( uploadType, file.fileName, file.fileSize );
        uploadObj.init( id++ ); // 给upload 对象设置一个唯一的id
    }
};

　　当用户选择完文件之后，startUpload函数会遍历files数组来创建对应的upload对象。接下来定义Upload构造函数，它接受3个参数，分别是插件类型、文件名和文件大小。这些信息都已经被插件组装在files数组里返回，代码如下：

var Upload = function( uploadType, fileName, fileSize ){
    this.uploadType = uploadType;
    this.fileName = fileName;
    this.fileSize = fileSize;
    this.dom= null;
};
Upload.prototype.init = function( id ){
    var that = this;
    this.id = id;
    this.dom = document.createElement( \'div\' );
    this.dom.innerhtml =
    \'<span>文件名称:\'+ this.fileName +\', 文件大小: \'+ this.fileSize +\'</span>\' +
    \'<button class="delFile">删除</button>\';
    this.dom.querySelector( \'.delFile\' ).onclick = function(){
        that.delFile();
    }
    document.body.appendChild( this.dom );
};

　　为了简化示例，暂且去掉了upload对象的其他功能，只保留删除文件的功能，对应的方法是Upload.prototype.delFile。该方法中有一个逻辑：当被删除的文件小于3000KB时，该文件将被直接删除。否则页面中会弹出一个提示框，提示用户是否确认要删除该文件，代码如下：

Upload.prototype.delFile = function(){
    if ( this.fileSize < 3000 ){
        return this.dom.parentNode.removeChild( this.dom );
    }
    if ( window.confirm( \'确定要删除该文件吗? \' + this.fileName ) ){
        return this.dom.parentNode.removeChild( this.dom );
    }
};

　　接下来分别创建3个插件上传对象和3个Flash上传对象：

startUpload( \'plugin\', [
{
    fileName: \'1.txt\',
    fileSize: 1000
},
{
    fileName: \'2.html\',
    fileSize: 3000
},
{
    fileName: \'3.txt\',
    fileSize: 5000
}
]);
startUpload( \'flash\', [
{
    fileName: \'4.txt\',
    fileSize: 1000
},
{
    fileName: \'5.html\',
    fileSize: 3000
},
{
    fileName: \'6.txt\',
    fileSize: 5000
}
]);

【享元模式重构】

　　上一节的代码是第一版的文件上传，在这段代码里有多少个需要上传的文件，就一共创建了多少个upload对象，接下来用享元模式重构它

　　首先，需要确认插件类型uploadType是内部状态，那为什么单单uploadType是内部状态呢？在文件上传的例子里，upload对象必须依赖uploadType属性才能工作，这是因为插件上传、Flash上传、表单上传的实际工作原理有很大的区别，它们各自调用的接口也是完全不一样的，必须在对象创建之初就明确它是什么类型的插件，才可以在程序的运行过程中，让它们分别调用各自的start、pause、cancel、del等方法

　　一旦明确了uploadType，无论使用什么方式上传，这个上传对象都是可以被任何文件共用的。而fileName和fileSize是根据场景而变化的，每个文件的fileName和fileSize都不一样，fileName和fileSize没有办法被共享，它们只能被划分为外部状态

　　明确了uploadType作为内部状态之后，再把其他的外部状态从构造函数中抽离出来，Upload构造函数中只保留uploadType参数：

var Upload = function( uploadType){
    this.uploadType = uploadType;
};

　　Upload.prototype.init函数也不再需要，因为upload对象初始化的工作被放在了upload-Manager.add函数里面，接下来只需要定义Upload.prototype.del函数即可：

Upload.prototype.delFile = function( id ){
    uploadManager.setExternalState( id, this ); // (1)
    if ( this.fileSize < 3000 ){
        return this.dom.parentNode.removeChild( this.dom );
    }
    if ( window.confirm( \'确定要删除该文件吗? \' + this.fileName ) ){
        return this.dom.parentNode.removeChild( this.dom );
    }
}

　　在开始删除文件之前，需要读取文件的实际大小，而文件的实际大小被储存在外部管理器uploadManager中，所以在这里需要通过uploadManager.setExternalState方法给共享对象设置正确的fileSize，上段代码中的(1)处表示把当前id对应的对象的外部状态都组装到共享对象中

　　接下来定义一个工厂来创建upload对象，如果某种内部状态对应的共享对象已经被创建过，那么直接返回这个对象，否则创建一个新的对象：

var UploadFactory = (function(){
    var createdFlyWeightObjs = {};
    return {
        create: function( uploadType){
            if ( createdFlyWeightObjs [ uploadType] ){
                return createdFlyWeightObjs [ uploadType];
            }
            return createdFlyWeightObjs [ uploadType] = new Upload( uploadType);
        }
    }
})();

　　现在来完善前面提到的uploadManager对象，它负责向UploadFactory提交创建对象的请求，并用一个uploadDatabase对象保存所有upload对象的外部状态，以便在程序运行过程中给upload共享对象设置外部状态，代码如下：

var uploadManager = (function(){
    var uploadDatabase = {};
    return {
        add: function( id, uploadType, fileName, fileSize ){
            var flyWeightObj = UploadFactory.create( uploadType );
            var dom = document.createElement( \'div\' );
            dom.innerHTML =
            \'<span>文件名称:\'+ fileName +\', 文件大小: \'+ fileSize +\'</span>\' +
            \'<button class="delFile">删除</button>\';
            dom.querySelector( \'.delFile\' ).onclick = function(){
                flyWeightObj.delFile( id );
            }

            document.body.appendChild( dom );
            uploadDatabase[ id ] = {
                fileName: fileName,
                fileSize: fileSize,
                dom: dom
            };
            return flyWeightObj ;
        },
        setExternalState: function( id, flyWeightObj ){
            var uploadData = uploadDatabase[ id ];
            for ( var i in uploadData ){
                flyWeightObj[ i ] = uploadData[ i ];
            }
        }
    }
})();

　　然后是开始触发上传动作的startUpload函数：

var id = 0;
window.startUpload = function( uploadType, files ){
    for ( var i = 0, file; file = files[ i++ ]; ){
        var uploadObj = uploadManager.add( ++id, uploadType, file.fileName, file.fileSize );
    }
};

　　最后是测试时间，运行下面的代码后，可以发现运行结果跟用享元模式重构之前一致：

startUpload( \'plugin\', [
{
    fileName: \'1.txt\',
    fileSize: 1000
},
{
    fileName: \'2.html\',
    fileSize: 3000
},
{
    fileName: \'3.txt\',
    fileSize: 5000
}
]);
startUpload( \'flash\', [
{
    fileName: \'4.txt\',
    fileSize: 1000
},
{
    fileName: \'5.html\',
    fileSize: 3000
},
{
    fileName: \'6.txt\',

    fileSize: 5000
}
]);

　　享元模式重构之前的代码里一共创建了6个upload对象，而通过享元模式重构之后，对象的数量减少为2，更幸运的是，就算现在同时上传2000个文件，需要创建的upload对象数量依然是2

 

适用性

　　享元模式是一种很好的性能优化方案，但它也会带来一些复杂性的问题，从前面两组代码的比较可以看到，使用了享元模式之后，需要分别多维护一个factory对象和一个manager对象，在大部分不必要使用享元模式的环境下，这些开销是可以避免的

　　享元模式带来的好处很大程度上取决于如何使用以及何时使用，一般来说，以下情况发生时便可以使用享元模式

　　1、一个程序中使用了大量的相似对象

　　2、由于使用了大量对象，造成很大的内存开销

　　3、对象的大多数状态都可以变为外部状态

　　4、剥离出对象的外部状态之后，可以用相对较少的共享对象取代大量对象。可以看到，文件上传的例子完全符合这四点

　　实现享元模式的关键是把内部状态和外部状态分离开来。有多少种内部状态的组合，系统中便最多存在多少个共享对象，而外部状态储存在共享对象的外部，在必要时被传入共享对象来组装成一个完整的对象。现在来考虑两种极端的情况，即对象没有外部状态和没有内部状态的时候

【没有内部状态的享元】

　　在文件上传的例子中，分别进行过插件调用和Flash调用，即startUpload(\'plugin\',[])和startUpload(flash,[])，导致程序中创建了内部状态不同的两个共享对象。在文件上传程序里，一般都会提前通过特性检测来选择一种上传方式，如果浏览器支持插件就用插件上传，如果不支持插件，就用Flash上传。那么，什么情况下既需要插件上传又需要Flash上传呢？

　　实际上这个需求是存在的，很多网盘都提供了极速上传（控件）与普通上传（Flash）两种模式，如果极速上传不好使（可能是没有安装控件或者控件损坏），用户还可以随时切换到普通上传模式，所以这里确实是需要同时存在两个不同的upload共享对象

　　但不是每个网站都必须做得如此复杂，很多小一些的网站就只支持单一的上传方式。假设我们是这个网站的开发者，不需要考虑极速上传与普通上传之间的切换，这意味着在之前的代码中作为内部状态的uploadType属性是可以删除掉的

　　在继续使用享元模式的前提下，构造函数Upload就变成了无参数的形式：

var Upload = function(){};

　　其他属性如fileName、fileSize、dom依然可以作为外部状态保存在共享对象外部。在uploadType作为内部状态的时候，它可能为控件，也可能为Flash，所以当时最多可以组合出两个共享对象。而现在已经没有了内部状态，这意味着只需要唯一的一个共享对象。现在要改写创建享元对象的工厂，代码如下：

var UploadFactory = (function(){ 
  var uploadObj;
  return {
   create: function(){ 
     if ( uploadObj ){
      return uploadObj;
    }
    return uploadObj = new Upload();
    })();
  }
}

　　管理器部分的代码不需要改动，还是负责剥离和组装外部状态。可以看到，当对象没有内部状态的时候，生产共享对象的工厂实际上变成了一个单例工厂。虽然这时候的共享对象没有内部状态的区分，但还是有剥离外部状态的过程，依然倾向于称之为享元模式

 

对象池

　　对象池维护一个装载空闲对象的池子，如果需要对象的时候，不是直接new，而是转从对象池里获取。如果对象池里没有空闲对象，则创建一个新的对象，当获取出的对象完成它的职责之后，再进入池子等待被下次获取

　　对象池的原理很好理解，比如我们组人手一本《javascript权威指南》，从节约的角度来讲，这并不是很划算，因为大部分时间这些书都被闲置在各自的书架上，所以我们一开始就只买一本，或者一起建立一个小型图书馆（对象池），需要看书的时候就从图书馆里借，看完了之后再把书还回图书馆。如果同时有三个人要看这本书，而现在图书馆里只有两本，那我们再马上去书店买一本放入图书馆

　　对象池技术的应用非常广泛，HTTP连接池和数据库连接池都是其代表应用。在Web前端开发中，对象池使用最多的场景大概就是跟DOM有关的操作。很多空间和时间都消耗在了DOM节点上，如何避免频繁地创建和删除DOM节点就成了一个有意义的话题

　　假设开发一个地图应用，地图上经常会出现一些标志地名的小气泡，叫它toolTip。在搜索附近地图的时候，页面里出现了2个小气泡。当再搜索附近的兰州拉面馆时，页面中出现了6个小气泡。按照对象池的思想，在第二次搜索开始之前，并不会把第一次创建的2个小气泡删除掉，而是把它们放进对象池。这样在第二次的搜索结果页面里，只需要再创建4个小气泡而不是6个

　　先定义一个获取小气泡节点的工厂，作为对象池的数组成为私有属性被包含在工厂闭包里，这个工厂有两个暴露对外的方法，create表示获取一个div节点，recover表示回收一个div节点：

var toolTipFactory = (function(){
    var toolTipPool = []; // toolTip 对象池
    return {
        create: function(){
            if ( toolTipPool.length === 0 ){ // 如果对象池为空
                var div = document.createElement( \'div\' ); // 创建一个dom
                document.body.appendChild( div );
                recovereturn div;
            }else{ // 如果对象池里不为空
                return toolTipPool.shift(); // 则从对象池中取出一个dom
            }
        },
        recover: function( tooltipDom ){
            return toolTipPool.push( tooltipDom ); // 对象池回收dom
        }
    }
})();

　　现在把时钟拨回进行第一次搜索的时刻，目前需要创建2个小气泡节点，为了方便回收，用一个数组ary来记录它们：

var ary = [];
for ( var i = 0, str; str = [ \'A\', \'B\' ][ i++ ]; ){
    var toolTip = toolTipFactory.create();
    toolTip.innerHTML = str;
    ary.push( toolTip );
};

　　接下来假设地图需要开始重新绘制，在此之前要把这两个节点回收进对象池：

for ( var i = 0, toolTip; toolTip = ary[ i++ ]; ){
    toolTipFactory.recover( toolTip );
};

　　再创建6个小气泡：

for ( var i = 0, str; str = [ \'A\', \'B\', \'C\', \'D\', \'E\', \'F\' ][ i++ ]; ){
    var toolTip = toolTipFactory.create();
    toolTip.innerHTML = str;
};

　　页面中出现了内容分别为A、B、C、D、E、F的6个节点，上一次创建好的节点被共享给了下一次操作。对象池跟享元模式的思想有点相似，虽然innerHTML的值A、B、C、D等也可以看成节点的外部状态，但在这里并没有主动分离内部状态和外部状态的过程

【通用对象池实现】

　　还可以在对象池工厂里，把创建对象的具体过程封装起来，实现一个通用的对象池：

var objectPoolFactory = function( createObjFn ){
    var objectPool = [];
    return {
        create: function(){
            var obj = objectPool.length === 0 ?
            createObjFn.apply( this, arguments ) : objectPool.shift();
            return obj;
        },
        recover: function( obj ){
            objectPool.push( obj );

        }
    }
};

var iframeFactory = objectPoolFactory( function(){
    var iframe = document.createElement( \'iframe\' );
    document.body.appendChild( iframe );
    iframe.onload = function(){
        iframe.onload = null; // 防止iframe 重复加载的bug
        iframeFactory.recover( iframe ); // iframe 加载完成之后回收节点
    }
    return iframe;
});

var iframe1 = iframeFactory.create();
iframe1.src = \'http:// baidu.com\';
var iframe2 = iframeFactory.create();
iframe2.src = \'http:// QQ.com\';
setTimeout(function(){
    var iframe3 = iframeFactory.create();
    iframe3.src = \'http:// 163.com\';
}, 3000 );

　　对象池是另外一种性能优化方案，它跟享元模式有一些相似之处，但没有分离内部状态和外部状态这个过程。文件上传的程序其实也可以用对象池+事件委托来代替实现

　　享元模式是为解决性能问题而生的模式，这跟大部分模式的诞生原因都不一样。在一个存在大量相似对象的系统中，享元模式可以很好地解决大量对象带来的性能问题