前端须知——结构型模式——装饰者模式

Myth丶恋晨 2022-08-28 01:58 147阅读 0赞

## 定义 ##

> 在不改变元对象的基础上，通过对其进行包装拓展（添加属性方法）

> 装饰者模式可以动态的给某个对象添加一些额外的职责，而不会影响从这个类中派生出的其他对象

装饰者(decorator)模式能够在不改变对象自身的基础上，在程序运行期间给对像动态的添加职责。与继承相比，装饰者是一种更轻便灵活的做法。可以当脚本运行时，在子类中增加行为会影响原有类所有的实例，而装饰者却不然。取而代之的是它能给不同对象各自添加新行为

## 模拟传统面向对象语言的装饰者模式 ##

首先要提出来的是，作为一门解释执行的语言，给JavaScript中的对象动态添加或者改变职责是一件再简单不过的事情，虽然这种做法改动了对象自身，跟传统定义中的装饰者模式并不一样，但这无疑更符合JavaScript的语言特色。代码如下：

var obj = {
        
        name: 'sven',
        address: '杭州市'
    };
    obj.address = obj.address + '江干区';

传统面向对象语言中的装饰者模式在JavaScript中适用的场景并不多，如上面代码所示，通常我们并不太介意改动对象自身。尽管如此，但是我们还是稍微模拟一下传统面向对象语言中的装饰者模式实现。

假设我们在编写一个飞机大战的游戏，随着经验值的增加，我们操作的飞机对象可以升级成更厉害的飞机，一开始这些飞机只能发射普通的子弹，升到第二级时可以发射导弹，升到第三级时可以发射原子弹。

// 建立一架飞机
    var Plane = function(){
        }
    // 飞机有发射普通子弹的方法
    Plane.prototype.fire = function(){
        
        console.log( '发射普通子弹' );
    }

接下来增加两个装饰类，分别是导弹和原子弹：

导弹类和原子弹类的构造函数都接受参数plane对象，并且保存好这个参数，在它们的fire方法中，除了执行自身的操作之外，还调用plane对象的fire方法。

这种给对象动态增加职责的方式，并没有真正地改动对象自身，而是将对象放入另一个对象之中，这些对象以一条链的方式进行引用，形成一个聚合对象。这些对象都拥有相同的接口（fire方法），当请求达到链中的某个对象时，这个对象会执行自身的操作，随后把请求转发给链中的下一个对象。

因为装饰者对象和它所装饰的对象拥有一致的接口，所以它们对使用该对象的客户来说是透明的，被装饰的对象也并不需要了解它曾经被装饰过，这种透明性使得我们可以递归地嵌套任意多个装饰者对象。

最后看看测试结果：

var plane = new Plane();
    plane = new MissileDecorator( plane );
    plane = new AtomDecorator( plane );
    plane.fire();
    // 分别输出： 发射普通子弹、发射导弹、发射原子弹

## JavaScript的装饰者 ##

JavaScript语言动态改变对象相当容易，我们可以直接改写对象或者对象的某个方法，并不需要使用“类”来实现装饰者模式，代码如下：

### 装饰函数 ###

在JavaScript中，几乎一切都是对象，其中函数又被称为一等对象。在平时的开发工作中，也许大部分时间都在和函数打交道。在JavaScript中可以很方便地给某个对象扩展属性和方法，但却很难在不改动某个函数源代码的情况下，给该函数添加一些额外的功能。在代码的运行期间，我们很难切入某个函数的执行环境。

要想为函数添加一些功能，最简单粗暴的方式就是直接改写该函数，但这是最差的办法，直接违反了开放-封闭原则

var a = function(){
        
        alert (1);
    }
    // 改成：
    var a = function(){
        
        alert (1);
        alert (2);
    }

很多时候我们不想去碰原函数，也许原函数是由其他同事编写的，里面的实现非常杂乱。甚至在一个古老的项目中，这个函数的源代码被隐藏在一个我们不愿碰触的阴暗角落里。现在需要一个办法，在不改变函数源代码的情况下，能给函数增加功能，这正是开放-封闭原则给我们指出的光明道路。

通过保存原引用的方式就可以改写某个函数：

var a = function(){
        
        alert (1);
    }
    var _a = a;
    a = function(){
        
        _a();
        alert (2);
    }
    a();

这是实际开发中很常见的一种做法，比如我们想给window绑定onload事件，但是又不确定这个事件是不是已经被其他人绑定过，为了避免覆盖掉之前的window.onload函数中的行为，我们一般都会先保存好原先的window.onload，把它放入新的window.onload里执行：

这样的代码当然是符合开放-封闭原则的，我们在增加新功能的时候，确实没有修改原来的window.onload代码，但是这种方式存在以下两个问题。

1.  必须维护\_onload这个中间变量，虽然看起来并不起眼，但如果函数的装饰链较长，或者需要装饰的函数变多，这些中间变量的数量也会越来越多。
2.  其实还遇到了this被劫持的问题，在window.onload的例子中没有这个烦恼，是因为调用普通函数\_onload时，this也指向window，跟调用window.onload时一样（函数作为对象的方法被调用时，this指向该对象，所以此处this也只指向window）。

现在把window.onload换成document.getElementById，代码如下:

var _getElementById = document.getElementById;
    document.getElementById = function( id ){
        
        alert (1);
        return _getElementById( id ); // (1)
    }
    var button = document.getElementById( 'button' );

执行这段代码，我们看到在弹出alert(1)之后，紧接着控制台抛出了异常：

// 输出： Uncaught TypeError: Illegal invocation

异常发生在(1) 处的\_getElementById(id)这句代码上，此时\_getElementById是一个全局函数，当调用一个全局函数时，this是指向window的，而document.getElementById方法的内部实现需要使用this引用，this在这个方法内预期是指向document，而不 是window, 这是错误发生的原因，所以使用现在的方式给函数增加功能并不保险。

改进后的代码可以满足需求，我们要手动把document当作上下文this传入\_getElementById：

var _getElementById = document.getElementById;
    document.getElementById = function(){
        
        alert (1);
        return _getElementById.apply( document, arguments );
    }
    var button = document.getElementById( 'button' );

但这样做显然很不方便，下面我们引入AOP，来提供一种完美的方法给函数动态增加功能。

### 用AOP装饰函数 ###

首先给出Function.prototype.before方法和Function.prototype.after方法：

Function.prototype.before = function( beforefn ){
        
        var __self = this; // 保存原函数的引用
        return function(){
         // 返回包含了原函数和新函数的"代理"函数
            beforefn.apply( this, arguments ); // 执行新函数，且保证this不被劫持，新函数接受的参数
            // 也会被原封不动地传入原函数，新函数在原函数之前执行
            return __self.apply( this, arguments ); // 执行原函数并返回原函数的执行结果，
            // 并且保证this不被劫持
        }
    }
    Function.prototype.after = function( afterfn ){
        
        var __self = this;
        return function(){
        
            var ret = __self.apply( this, arguments );
            afterfn.apply( this, arguments );
            return ret;
        }
    };

Function.prototype.before接受一个函数当作参数，这个函数即为新添加的函数，它装载了新添加的功能代码。

接下来把当前的this保存起来，这个this指向原函数，然后返回一个“代理”函数，这个“代理”函数只是结构上像代理而已，并不承担代理的职责（比如控制对象的访问等）。它的工作是把请求分别转发给新添加的函数和原函数，且负责保证它们的执行顺序，让新添加的函数在原函数之前执行（前置装饰），这样就实现了动态装饰的效果。

我们注意到，通过Function.prototype.apply来动态传入正确的this，保证了函数在被装饰之后，this不会被劫持。

Function.prototype.after的原理跟Function.prototype.before一模一样，唯一不同的地方在于让新添加的函数在原函数执行之后再执行。  
下面来试试用Function.prototype.before的威力:

Function.prototype.before = function( beforefn ){
        
        var __self = this;
        return function(){
        
            beforefn.apply( this, arguments );
            return __self.apply( this, arguments );
        }
    }
    document.getElementById = document.getElementById.before(function(){
        
        alert (1);
    });
    var button = document.getElementById( 'button' );
    console.log( button );

再回到window.onload的例子，看看用Function.prototype.after来增加新的window.onload事件是多么简单：

值得提到的是，上面的AOP实现是在Function.prototype上添加before和after方法，但许多人不喜欢这种污染原型的方式，那么我 们可以做一些变通，把原函数和新函数都作为参数传入before或者after方法：

#### AOP的应用实例 ####

用AOP装饰函数的技巧在实际开发中非常有用。不论是业务代码的编写，还是在框架层面，我们都可以把行为依照职责分成粒度更细的函数，随后通过装饰把它们合并到一起，这有助于我们编写一个松耦合和高复用性的系统。

##### **数据统计上报** #####

分离业务代码和数据统计代码，无论在什么语言中，都是AOP的经典应用之一。在项目开发的结尾阶段难免要加上很多统计数据的代码，这些过程可能让我们被迫改动早已封装好的函数。

比如页面中有一个登录button，点击这个button会弹出登录浮层，与此同时要进行数据上报，来统计有多少用户点击了这个登录button：

var showLogin = function(){
        
        console.log( '打开登录浮层' );
        log( this.getAttribute( 'tag' ) );
    }
    var log = function( tag ){
        
        console.log( '上报标签为: ' + tag );
        // (new Image).src = 'http:// xxx.com/report?tag=' + tag; // 真正的上报代码略
    }
    document.getElementById( 'button' ).onclick = showLogin;

我们看到在showLogin函数里，既要负责打开登录浮层，又要负责数据上报，这是两个层面的功能，在此处却被耦合在一个函数里。使用AOP分离之后，代码如下：

Function.prototype.after = function( afterfn ){
        
        var __self = this;
        return function(){
        
            var ret = __self.apply( this, arguments );
            afterfn.apply( this, arguments );
            return ret;
        }
    };
    var showLogin = function(){
        
        console.log( '打开登录浮层' );
    }
    var log = function(){
        
        console.log( '上报标签为: ' + this.getAttribute( 'tag' ) );
    }
    showLogin = showLogin.after( log ); // 打开登录浮层之后上报数据
    document.getElementById( 'button' ).onclick = showLogin;

##### **用AOP动态改变函数的参数** #####

观察Function.prototype.before方法：

Function.prototype.before = function( beforefn ){
        
        var __self = this;
        return function(){
        
            beforefn.apply( this, arguments ); // (1)
            return __self.apply( this, arguments ); // (2)
        }
    }

从这段代码的(1)处和(2)处可以看到，beforefn和原函数self共用一组参数列表arguments，当我们在beforefn的函数体内改变 arguments的时候，原函数self接收的参数列表自然也会变化。

下面的例子展示了如何通过Function.prototype.before方法给函数func的参数param动态地添加属性b：

现在有一个用于发起ajax请求的函数，这个函数负责项目中所有的ajax异步请求：

var ajax = function( type, url, param ){
        
        console.dir(param);
        // 发送ajax请求的代码略
    };
    ajax( 'get', 'http:// xxx.com/userinfo', {
         name: 'sven' } );

上面的伪代码表示向后台cgi发起一个请求来获取用户信息，传递给cgi的参数是\{ name: ‘sven’ \}。

ajax函数在项目中一直运转良好，跟cgi的合作也很愉快。直到有一天，我们的网站遭受了CSRF攻击。解决CSRF攻击最简单的一个办法就是在HTTP请求中带上一个Token参数。

假设我们已经有一个用于生成Token的函数

var getToken = function(){
        
        return 'Token';
    }

现在的任务是给每个ajax请求都加上Token参数：

var ajax = function( type, url, param ){
        
        param = param || {
        };
        Param.Token = getToken(); // 发送ajax请求的代码略...
    };

虽然已经解决了问题，但我们的ajax函数相对变得僵硬了，每个从ajax函数里发出的请求都自动带上了Token参数，虽然在现在的项目中没有什么问题，但如果将来把这个函数移植到其他项目上，或者把它放到一个开源库中供其他人使用，Token参数都将是多余的。  
  也许另一个项目不需要验证Token，或者是Token的生成方式不同，无论是哪种情况，都必须重新修改ajax函数。

为了解决这个问题，先把ajax函数还原成一个干净的函数：

var ajax= function( type, url, param ){
        
        console.log(param); // 发送ajax请求的代码略
    };

然后把Token参数通过Function.prototyte.before装饰到ajax函数的参数param对象中：

从ajax函数打印的log可以看到，Token参数已经被附加到了ajax请求的参数中：

{
        name: "sven", Token: "Token"}

明显可以看到，用AOP的方式给ajax函数动态装饰上Token参数，保证了ajax函数是一个相对纯净的函数，提高了ajax函数的可复用性，它在被迁往其他项目的时候，不需要做任何修改。

##### **区分装饰者模式和代理模式** #####

装饰者模式和代理模式的结构看起来非常相像，这两种模式都描述了怎样为对象提供一定程度上的间接引用，它们的实现部分都保留了对另外一个对象的引用，并且向那个对象发送请求。

代理模式和装饰者模式最重要的区别在于它们的意图和设计目的。代理模式的目的是，当直接访问本体不方便或者不符合需要时，为这个本体提供一个替代者。本体定义了关键功能，而代理提供或拒绝对它的访问，或者在访问本体之前做一些额外的事情。装饰者模式的作用就是为对象动态加入行为。换句话说，代理模式强调一种关系（Proxy与它的实体之间的关系），这种关系可以静态的表达，也就是说，这种关系在一开始就可以被确定。而装饰者模式用于一开始不能确定对象的全部功能时。代理模式通常只有一层代理-本体的引用，而装饰者模式经常会形成一条长长的装饰链。

在虚拟代理实现图片预加载的例子中，本体负责设置img节点的src，代理则提供了预加载的功能，这看起来也是“加入行为”的一种方式，但这种加入行为的方式和装饰者模式的偏重点是不一样的。装饰者模式是实实在在的为对象增加新的职责和行为，而代理做的事情还是跟本体一样，最终都是设置src。但代理可以加入一些“聪明”的功能，比如在图片真正加载好之前，先使用一张占位的loading图片反馈给客户。

## 结语 ##

通过数据上报、统计函数的执行时间、动态改变函数参数例子，我们了解了装饰函数，它是JavaScript中独特的装饰者模式。这种模式在实际开发中非常有用，除了上面提到的例子，它在框架开发中也十分有用。作为框架作者，我们希望框架里的函数提供的是一些稳定而方便移植的功能，那些个性化的功能可以在框架之外动态装饰上去，这可以避免为了让框架拥有更多的功能，而去使用 一些if、else语句预测用户的实际需要。