11个JavaScript代码重构优秀实践

模式和重构之间有着一种与生俱来的关系。从某种角度来看,设计模式的目的就是为许多重构行为提供目标。

为蟠龙等地区用户提供了全套网页设计制作服务,及蟠龙网站建设行业解决方案。主营业务为成都网站设计、网站制作、蟠龙网站设计,以传统方式定制建设网站,并提供域名空间备案等一条龙服务,秉承以专业、用心的态度为用户提供真诚的服务。我们深信只要达到每一位用户的要求,就会得到认可,从而选择与我们长期合作。这样,我们也可以走得更远!

1. 提炼函数

在JavaScript开发中,我们大部分时间都在与函数打交道,所以我们希望这些函数有着良好的命名,函数体内包含的逻辑清晰明了。如果一个函数过长,不得不加上若干注释才能让这个函数显得易读一些,那这些函数就很有必要进行重构。

如果在函数中有一段代码可以被独立出来,那我们最好把这些代码放进另外一个独立的函数中。这是一种很常见的优化工作,这样做的好处主要有以下几点。

  • 避免出现超大函数。
  • 独立出来的函数有助于代码复用。
  • 独立出来的函数更容易被覆写。
  • 独立出来的函数如果拥有一个良好的命名,它本身就起到了注释的作用。

比如在一个负责取得用户信息的函数里面,我们还需要打印跟用户信息有关的log,那么打印log的语句就可以被封装在一个独立的函数里:

 
 
 
 
  1. var getUserInfo = function(){
  2.     ajax( 'http:// xxx.com/userInfo', function( data ){
  3.         console.log( 'userId: ' + data.userId );
  4.         console.log( 'userName: ' + data.userName );
  5.         console.log( 'nickName: ' + data.nickName );
  6.     });
  7. };
  8. 改成:
  9. var getUserInfo = function(){
  10.     ajax( 'http:// xxx.com/userInfo', function( data ){
  11.         printDetails( data );
  12.     });
  13. };
  14. var printDetails = function( data ){
  15.     console.log( 'userId: ' + data.userId );
  16.     console.log( 'userName: ' + data.userName );
  17.     console.log( 'nickName: ' + data.nickName );
  18. };

2. 合并重复的条件片段

如果一个函数体内有一些条件分支语句,而这些条件分支语句内部散布了一些重复的代码,那么就有必要进行合并去重工作。假如我们有一个分页函数paging,该函数接收一个参数currPage,currPage表示即将跳转的页码。在跳转之前,为防止currPage传入过小或者过大的数字,我们要手动对它的值进行修正,详见如下伪代码:

 
 
 
 
  1. var paging = function( currPage ){
  2.     if ( currPage <= 0 ){
  3.         currPage = 0;
  4.         jump( currPage );    // 跳转
  5.     }else if ( currPage >= totalPage ){
  6.         currPage = totalPage;
  7.         jump( currPage );    // 跳转
  8.     }else{
  9.         jump( currPage );    // 跳转
  10.     }
  11. };

可以看到,负责跳转的代码jump( currPage )在每个条件分支内都出现了,所以完全可以把这句代码独立出来:

 
 
 
 
  1. var paging = function( currPage ){
  2.     if ( currPage <= 0 ){
  3.         currPage = 0;
  4.     }else if ( currPage >= totalPage ){
  5.         currPage = totalPage;
  6.     }
  7.     jump( currPage );    // 把jump函数独立出来
  8. };

3. 把条件分支语句提炼成函数

在程序设计中,复杂的条件分支语句是导致程序难以阅读和理解的重要原因,而且容易导致一个庞大的函数。假设现在有一个需求是编写一个计算商品价格的getPrice函数,商品的计算只有一个规则:如果当前正处于夏季,那么全部商品将以8折出售。代码如下:

 
 
 
 
  1. var getPrice = function( price ){
  2.     var date = new Date();
  3.     if ( date.getMonth() >= 6 && date.getMonth() <= 9 ){    // 夏天
  4.         return price * 0.8;
  5.     }
  6.     return price;
  7. };

观察这句代码:

 
 
 
 
  1. if ( date.getMonth() >= 6 && date.getMonth() <= 9 ){
  2.     // ...
  3. }

这句代码要表达的意思很简单,就是判断当前是否正处于夏天(7~10月)。尽管这句代码很短小,但代码表达的意图和代码自身还存在一些距离,阅读代码的人必须要多花一些精力才能明白它传达的意图。其实可以把这句代码提炼成一个单独的函数,既能更准确地表达代码的意思,函数名本身又能起到注释的作用。代码如下:

 
 
 
 
  1. var isSummer = function(){
  2.     var date = new Date();
  3.     return date.getMonth() >= 6 && date.getMonth() <= 9;
  4. };
  5. var getPrice = function( price ){
  6.     if ( isSummer() ){    // 夏天
  7.         return price * 0.8;
  8.     }
  9.     return price;
  10. };

4. 合理使用循环

在函数体内,如果有些代码实际上负责的是一些重复性的工作,那么合理利用循环不仅可以完成同样的功能,还可以使代码量更少。下面有一段创建XHR对象的代码,为了简化示例,我们只考虑版本9以下的IE浏览器,代码如下:

 
 
 
 
  1. var createXHR = function(){
  2.     var xhr;
  3.     try{
  4.         xhr = new ActiveXObject( 'MSXML2.XMLHttp.6.0' );
  5.     }catch(e){
  6.         try{
  7.             xhr = new ActiveXObject( 'MSXML2.XMLHttp.3.0' );
  8.         }catch(e){
  9.             xhr = new ActiveXObject( 'MSXML2.XMLHttp' );
  10.         }
  11.     }
  12.     return xhr;
  13. };
  14. var xhr = createXHR();

下面我们灵活地运用循环,可以得到跟上面代码一样的效果:

 
 
 
 
  1. var createXHR = function(){
  2. var versions= [ 'MSXML2.XMLHttp.6.0ddd', 'MSXML2.XMLHttp.3.0', 'MSXML2.XMLHttp' ];
  3.     for ( var i = 0, version; version = versions[ i++ ]; ){
  4.         try{
  5.             return new ActiveXObject( version );
  6.         }catch(e){
  7.         }
  8.     }
  9. };
  10. var xhr = createXHR();

5. 提前让函数退出代替嵌套条件分支

许多程序员都有这样一种观念:“每个函数只能有一个入口和一个出口。”现代编程语言都会限制函数只有一个入口。但关于“函数只有一个出口”,往往会有一些不同的看法。

下面这段伪代码是遵守“函数只有一个出口的”的典型代码:

 
 
 
 
  1. var del = function( obj ){
  2.     var ret;
  3.     if ( !obj.isReadOnly ){    // 不为只读的才能被删除
  4.         if ( obj.isFolder ){    // 如果是文件夹
  5.             ret = deleteFolder( obj );
  6.         }else if ( obj.isFile ){    // 如果是文件
  7.             ret = deleteFile( obj );
  8.         }
  9.     }
  10.     return ret;
  11. };

嵌套的条件分支语句绝对是代码维护者的噩梦,对于阅读代码的人来说,嵌套的if、else语句相比平铺的if、else,在阅读和理解上更加困难,有时候一个外层if分支的左括号和右括号之间相隔500米之远。用《重构》里的话说,嵌套的条件分支往往是由一些深信“每个函数只能有一个出口的”程序员写出的。但实际上,如果对函数的剩余部分不感兴趣,那就应该立即退出。引导阅读者去看一些没有用的else片段,只会妨碍他们对程序的理解。

于是我们可以挑选一些条件分支,在进入这些条件分支之后,就立即让这个函数退出。要做到这一点,有一个常见的技巧,即在面对一个嵌套的if分支时,我们可以把外层if表达式进行反转。重构后的del函数如下:

 
 
 
 
  1. var del = function( obj ){
  2.     if ( obj.isReadOnly ){    // 反转if表达式
  3.         return;
  4.     }
  5.     if ( obj.isFolder ){
  6.         return deleteFolder( obj );
  7.     }
  8.     if ( obj.isFile ){
  9.         return deleteFile( obj );
  10.     }
  11. };

6. 传递对象参数代替过长的参数列表

有时候一个函数有可能接收多个参数,而参数的数量越多,函数就越难理解和使用。使用该函数的人首先得搞明白全部参数的含义,在使用的时候,还要小心翼翼,以免少传了某个参数或者把两个参数搞反了位置。如果我们想在第3个参数和第4个参数之中增加一个新的参数,就会涉及许多代码的修改,代码如下:

 
 
 
 
  1. var setUserInfo = function( id, name, address, sex, mobile, qq ){
  2.     console.log( 'id= ' + id );
  3.     console.log( 'name= ' +name );
  4.     console.log( 'address= ' + address );
  5.     console.log( 'sex= ' + sex );
  6.     console.log( 'mobile= ' + mobile );
  7.     console.log( 'qq= ' + qq );
  8. };
  9. setUserInfo( 1314, 'sven', 'shenzhen', 'male', '137********', 377876679 )

这时我们可以把参数都放入一个对象内,然后把该对象传入setUserInfo 函数,setUserInfo函数需要的数据可以自行从该对象里获取。现在不用再关心参数的数量和顺序,只要保证参数对应的key值不变就可以了:

 
 
 
 
  1. var setUserInfo = function( obj ){
  2.     console.log( 'id= ' + obj.id );
  3.     console.log( 'name= ' + obj.name );
  4.     console.log( 'address= ' + obj.address );
  5.     console.log( 'sex= ' + obj.sex );
  6.     console.log( 'mobile= ' + obj.mobile );
  7.     console.log( 'qq= ' + obj.qq );
  8. };
  9. setUserInfo({
  10.     id: 1314,
  11.     name: 'sven',
  12.     address: 'shenzhen',
  13.     sex: 'male',
  14.     mobile: '137********',
  15.     qq: 377876679
  16. });

7. 尽量减少参数数量

如果调用一个函数时需要传入多个参数,那这个函数是让人望而生畏的,我们必须搞清楚这些参数代表的含义,必须小心翼翼地把它们按照顺序传入该函数。而如果一个函数不需要传入任何参数就可以使用,这种函数是深受人们喜爱的。在实际开发中,向函数传递参数不可避免,但我们应该尽量减少函数接收的参数数量。下面举个非常简单的示例。有一个画图函数draw,它现在只能绘制正方形,接收了3个参数,分别是图形的width、heigth以及square:

 
 
 
 
  1. var draw = function( width, height, square ){};

但实际上正方形的面积是可以通过width和height计算出来的,于是我们可以把参数square从draw函数中去掉:

 
 
 
 
  1. var draw = function( width, height ){
  2.     var square = width * height;
  3. };

假设以后这个draw函数开始支持绘制圆形,我们需要把参数width和height换成半径radius, 但图形的面积square始终不应该由客户传入,而是应该在draw函数内部,由传入的参数加上一定的规则计算得来。此时,我们可以使用策略模式,让draw函数成为一个支持绘制多种图形的函数。

8. 少用三目运算符

有一些程序员喜欢大规模地使用三目运算符,来代替传统的if、else。理由是三目运算符性能高,代码量少。不过,这两个理由其实都很难站得住脚。

即使我们假设三目运算符的效率真的比if、else高,这点差距也是完全可以忽略不计的。在实际的开发中,即使把一段代码循环一百万次,使用三目运算符和使用if、else的时间开销处在同一个级别里。

同样,相比损失的代码可读性和可维护性,三目运算符节省的代码量也可以忽略不计。让JS文件加载更快的办法有很多种,如压缩、缓存、使用CDN和分域名等。把注意力只放在使用三目运算符节省的字符数量上,无异于一个300斤重的人把超重的原因归罪于头皮屑。

如果条件分支逻辑简单且清晰,这无碍我们使用三目运算符:

 
 
 
 
  1. var global = typeof window !== "undefined" ? window : this;

但如果条件分支逻辑非常复杂,如下段代码所示,那我们最好的选择还是按部就班地编写if、else。if、else语句的好处很多,一是阅读相对容易,二是修改的时候比修改三目运算符周围的代码更加方便:

 
 
 
 
  1. if ( !aup || !bup ) {
  2.     return a === doc ? -1 :
  3.         b === doc ? 1 :
  4.         aup ? -1 :
  5.         bup ? 1 :
  6.         sortInput ?
  7.         ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) :
  8.         0;
  9. }

9. 合理使用链式调用

经常使用jQuery的程序员相当习惯链式调用方法,在JavaScript中,可以很容易地实现方法的链式调用,即让方法调用结束后返回对象自身,如下代码所示:

 
 
 
 
  1. var User = function(){
  2.     this.id = null;
  3.     this.name = null;
  4. };
  5. User.prototype.setId = function( id ){
  6.     this.id = id;
  7.     return this;
  8. };
  9. User.prototype.setName = function( name ){
  10.     this.name = name;
  11.     return this;
  12. };
  13. console.log( new User().setId( 1314 ).setName( 'sven' ) );

或者:

 
 
 
 
  1. var User = {
  2.     id: null,
  3.     name: null,
  4.     setId: function( id ){
  5.         this.id = id;
  6.         return this;
  7.     },
  8.     setName: function( name ){
  9.         this.name = name;
  10.         return this;
  11.     }
  12. };
  13. console.log( User.setId( 1314 ).setName( 'sven' ) );

使用链式调用的方式并不会造成太多阅读上的困难,也确实能省下一些字符和中间变量,但节省下来的字符数量同样是微不足道的。链式调用带来的坏处就是在调试的时候非常不方便,如果我们知道一条链中有错误出现,必须得先把这条链拆开才能加上一些调试log或者增加断点,这样才能定位错误出现的地方。

如果该链条的结构相对稳定,后期不易发生修改,那么使用链式调用无可厚非。但如果该链条很容易发生变化,导致调试和维护困难,那么还是建议使用普通调用的形式:

 
 
 
 
  1. var user = new User();
  2. user.setId( 1314 );
  3. user.setName( 'sven' );

10. 分解大型类

在HTML5版“街头霸王”的第一版代码中,负责创建游戏人物的Spirit 类非常庞大,不仅要负责创建人物精灵,还包括了人物的攻击、防御等动作方法,代码如下:

 
 
 
 
  1. var Spirit = function( name ){
  2.     this.name = name;
  3. };
  4. Spirit.prototype.attack = function( type ){    // 攻击
  5.     if ( type === 'waveBoxing' ){
  6.         console.log( this.name + ': 使用波动拳' );
  7.     }else if( type === 'whirlKick' ){
  8.         console.log( this.name + ': 使用旋风腿' );
  9.     }
  10. };
  11. var spirit = new Spirit( 'RYU' );
  12. spirit.attack( 'waveBoxing' );      // 输出:RYU: 使用波动拳
  13. spirit.attack( 'whirlKick' );    // 输出:RYU: 使用旋风腿

后来发现,Spirit.prototype.attack这个方法实现是太庞大了,实际上它完全有必要作为一个单独的类存在。面向对象设计鼓励将行为分布在合理数量的更小对象之中:

 
 
 
 
  1. var Attack = function( spirit ){
  2.     this.spirit = spirit;
  3. };
  4. Attack.prototype.start = function( type ){
  5.     return this.list[ type ].call( this );
  6. };
  7. Attack.prototype.list = {
  8.     waveBoxing: function(){
  9.         console.log( this.spirit.name + ': 使用波动拳' );
  10.     },
  11.     whirlKick: function(){
  12.         console.log( this.spirit.name + ': 使用旋风腿' );
  13.     }
  14. };

现在的Spirit类变得精简了很多,不再包括各种各样的攻击方法,而是把攻击动作委托给Attack类的对象来执行,这段代码也是策略模式的运用之一:

 
 
 
 
  1. var Spirit = function( name ){
  2.     this.name = name;
  3.     this.attackObj = new Attack( this );
  4. };
  5. Spirit.prototype.attack = function( type ){    // 攻击
  6.     this.attackObj.start( type );
  7. };
  8. var spirit = new Spirit( 'RYU' );
  9. spirit.attack( 'waveBoxing' );    // 输出:RYU: 使用波动拳
  10. spirit.attack( 'whirlKick' );    // 输出:RYU: 使用旋风

11. 用return退出多重循环

假设在函数体内有一个两重循环语句,我们需要在内层循环中判断,当达到某个临界条件时退出外层的循环。我们大多数时候会引入一个控制标记变量:

 
 
 
 
  1. var func = function(){
  2.     var flag = false;
  3.     for ( var i = 0; i < 10; i++ ){
  4.         for ( var j = 0; j < 10; j++ ){
  5.             if ( i * j >30 ){
  6.                 flag = true;
  7.                 break;
  8.             }
  9.         }
  10.         if ( flag === true ){
  11.             break;
  12.         }
  13.     }
  14. };

第二种做法是设置循环标记:

 
 
 
 
  1. var func = function(){
  2.     outerloop:
  3.     for ( var i = 0; i < 10; i++ ){
  4.         innerloop:
  5.         for ( var j = 0; j < 10; j++ ){
  6.             if ( i * j >30 ){
  7.                 break outerloop;
  8.             }
  9.         }
  10.     }
  11. };

这两种做法无疑都让人头晕目眩,更简单的做法是在需要中止循环的时候直接退出整个方法:

 
 
 
 
  1. var func = function(){
  2.     for ( var i = 0; i < 10; i++ ){
  3.         for ( var j = 0; j < 10; j++ ){
  4.             if ( i * j >30 ){
  5.                 return;
  6.             }
  7.         }
  8.     }
  9. };

当然用return直接退出方法会带来一个问题,如果在循环之后还有一些将被执行的代码呢?如果我们提前退出了整个方法,这些代码就得不到被执行的机会:

 
 
 
 
  1. var func = function(){
  2.     for ( var i = 0; i < 10; i++ ){
  3.         for ( var j = 0; j < 10; j++ ){
  4.             if ( i * j >30 ){
  5.                 return;
  6.             }
  7.         }
  8.     }
  9.     console.log( i );    // 这句代码没有机会被执行
  10. };

为了解决这个问题,我们可以把循环后面的代码放到return后面,如果代码比较多,就应该把它们提炼成一个单独的函数:

 
 
 
 
  1. var print = function( i ){
  2.     console.log( i );
  3. };
  4. var func = function(){
  5.     for ( var i = 0; i < 10; i++ ){
  6.         for ( var j = 0; j < 10; j++ ){
  7.             if ( i * j >30 ){
  8.                 return print( i );
  9.             }
  10.         }
  11.     }
  12. };
  13. func();

本文转载自微信公众号「大迁世界」,可以通过以下二维码关注。转载本文请联系大迁世界公众号。

本文标题:11个JavaScript代码重构优秀实践
网站路径:http://www.shufengxianlan.com/qtweb/news41/270441.html

网站建设、网络推广公司-创新互联,是专注品牌与效果的网站制作,网络营销seo公司;服务项目有等

广告

声明:本网站发布的内容(图片、视频和文字)以用户投稿、用户转载内容为主,如果涉及侵权请尽快告知,我们将会在第一时间删除。文章观点不代表本网站立场,如需处理请联系客服。电话:028-86922220;邮箱:631063699@qq.com。内容未经允许不得转载,或转载时需注明来源: 创新互联