Javascript 对象方式实现命名参数调用(上):原理和手动实现

Python / Ruby 等脚本语言具备了一种采用命名参数的来进行函数调用的方式。这对于参数数目很多并且大部分都有缺省值的情况下非常方便。不仅如此,这样的方式也解耦了参数调用的顺序。如下所示

Python 的例子:

def help(name='untitled',age=18,sex='M'):
   print(name,age,sex)
help(age=25,name='john');

程序输出:

john M 25

好了,不管如何,这是Python。咱现在关心的是Javascript。Javascript 的函数调用方式虽然已经足够灵活,但遗憾的是,唯独没有此语法支持。不过天无绝人之路,大家很快就找到了一种类此的替代方案——字面量对象方式。因为这种方式仅仅是看上去语法像而已,所以姑且称之为伪命名参数方式。看代码就明白了:
(本文的javascript 运行环境为node.js,并且为了有重点的说明问题,故意省去了该有的错误和异常处理。):

    function help(params){
        console.log(params.name,params.sex, param.age);
    }
    help( {name: "john" , age:25 , sex:'M' } );

程序的输出和将会和python的一模一样。
看上去已经有点像了,但似乎少了点什么?没错,缺省值。这里没有缺省值的支持,必须每个需要的参数都写进去,缺一不可。
这显然不是咱想象中的,有办法么?有,javascript 非常灵活,没有做不到只有想不到。看代码:

function help(params){
    var defaultParams={name: "untitled" , age:18 , sex:'M' } ;// 声明缺省值对象
    for ( pn in defaultParams){//迭代默认值对象,当传入的命名参数对象没有相应的属性时,把默认值加上去
        if (params[pn]===undefined){
            params[pn]=defaulaParams[pn];//传入的命名参数对象没有在default上的属性。即,使用缺省值
        }
    }
    //至此,params 上需要的属性已经齐全。
    console.log(params.name,params.sex, param.age) ;
}
help( {name: "john" , age:25  } );

这次的输出也和上次一样。也使用了sex的默认值'M'。
现在,越来越像了。但还有几点 python 的命名参数不一样:

  1. 参数必须用 {} 括起来,表示一个对象,不像参数列表。
  2. 参数的赋值在语法上是用 ":" ,而不是 "="。

如果你觉得,这是无伤大雅的事情。那可以跳过下面这一段,如果你和笔者一样好奇,就姑且看一下下面的这一段。
有没有连上面两点也一样呢? 因为javascript 的语法的关系,类此 help(age=25,name="john"); 在javascript 中是不符合语法的,除非把他们当字符串。因为字符串中的内容不收语法的限制。那看上去调用就像这样。
help( "name= 'john' , age=25 " );
很遗憾的是,这个双引号不能再省略了。我们在上面代码的基础上加上字符串方式的支持,还是看代码:

function help(params){
    if (typeof params === "string"){
        //用正则表达式把其中的 "=" 变换为":"
         ... //下文会谈到,我们最终不会用这样的方式。咱就不实现了,如果你感兴趣,可以自己尝试一下 :-)
        eval ("params={"+ps+"}");// 执行字符串形式的javascript,产生参数对象
    }
    //支持params已经变成等值的参数对象了。
    var defaultParams={name: "untitled" , age:18 , sex:'M' } ;
    for ( pn in defaultParams){  
        if (params[pn]===undefined){
            params[pn]=defaulaParams[pn];  
        }
    }
    console.log(params.name,params.sex, param.age) ;
}

其实,大家可以看出来,仅仅为使用"=" 就需要采用正则表达式来替换。如果此函数被反复频繁调用,将非常影响效率,但如果保留":"形式,则上述代码中的查找替换部分就完全不需要了。而且性能相差无几。所以,我们姑且使用":" 吧。 我们整理一下目前的代码(注释就不再赘述了):

function help(params){
    if (typeof params === "string"){
        eval ("params={"+ps+"}");
    }
    var defaultParams={name: "untitled" , age:18 , sex:'M' } ;
    for ( pn in defaultParams){  
        if (params[pn]===undefined){
            params[pn]=defaulaParams[pn];  
        }
    }
    console.log(params.name,params.sex, param.age) ;
}

Ok!我们已经可以支持可以在javascript中采用命名参数的方式来调用函数了。但,生活总是不完美的。因为,我们发现,现在我们只能用这种方式调用函数了。而原先最直观的参数列表方式却不能用了。嗯?

“生存还是毁灭,这是一个值得考虑的问题;默然忍受命运的暴虐的毒箭,或是挺身反抗人世间的无涯的苦难,通过斗争把它们扫清,这两种行为,哪一种更高贵?” ——哈姆雷特

我们只有拿起我们的javascript,尝试一下恢复这种能力,而同时又具备上述的命名参数方式。我想,我们可以。
我们可以先简单的认为:如果传入一个参数,并且参数是对象或可以转换为对象的字符串时,采用命名参数方式。否则采用参数列表方式。也许,大家会说,那没有参数或一个参数的函数怎么办。这个,这种情况,咱还需要命名参数么?如果实在需要,当然也有办法,但现在先不考虑这样的情况。还是一个原因,排除干扰,让代码易懂先。
为了缩减代码量,我们使用大名鼎鼎的underscore 库。感兴趣的可以去其官方网站看看。看代码咯:

var _=require("underscore-node");// 大名鼎鼎的underscore 库。
function help(params){
    var defaultParams={name: "untitled" , age:18 , sex:'M' } ;
    if (arguments.lengyh>1){  //参数列表方式,顺序和defaultParams 的顺序一致
        // 我们当然可以再实现一次函数的逻辑。这个例子里就是调用console.log(name,sex,age)。但如果函数的逻辑很复杂,这就不是我们想要的。
        // 办法是把argument 转换为命名参数对象即可
        params=_.object(_.keys(defaultParams),arguments);
    }
    if (typeof params === "string"){
        eval ("params={"+params+"}");
    }
    params=_.defaults(params,defaultParams);
    /* 采用上述的underscore 的defaults 代替
    for ( pn in defaultParams){  
        if (params[pn]===undefined){
        params[pn]=defaulaParams[pn];  
        }
    }
    */
    console.log(params.name,params.sex, param.age) ;
}

好了,现在参数列表方式也支持了,而且——还支持默认值。如果调用时参数列表不全,也会用默认值补全,这可不是javascript 的通常行为 undefined 能比的。
Cool!

顺手牵羊
我们知道 arguments 就是类似数组的对象。上面咱们已经把他搞定了。那普通的数组方式岂不也一样?那就一道实现一下:

var _=require("underscore-node");
function help(params){
    var defaultParams={name: "untitled" , age:18 , sex:'M' } ;
    if (arguments.lengyh>1){ 
        params=_.object(_.keys(defaultParams),arguments);
    }else{
        if (typeof params === "string"){//注意,这里没有处理仅仅传入第一个参数,而第一个参数也是字符串的情况。
            eval ("params={"+params+"}");
        }else if (Array.isArray(params)){   //array 也是object,不能用typeof 方式
                    params= _.object(_.keys(defaultParams),params);
            }
        params=_.defaults(params,defaultParams);
    }
    console.log(params.name,params.sex, param.age) ;
}

现在我们多了一种数组调用方式,而且默认值机制一样工作,像这样:
help( [ 'john' , 25] );

**我们到哪里了? **
我们实现了伪命名参数调用方式,支持默认值;同时也支持原来的参数列表方式,也支持默认值;最后还顺便实现了数组方式,还是支持默认值。这里,咱再申明一次啊。上面的代码主要用来说明实现原理,没有完善的异常情况和响应的错误处理。如果直接用在项目中需要完善后再使用。

“含着眼泪欢呼雀跃, 看不见你就等于看不见全世界。”——夏茗悠

也许,大家又发现了一个不是问题的问题。没错,上面的代码中只有最后一行是真正的业务逻辑。而且,当写第一个函数时,大家肯定兴高采烈。第二个大家就有点疑惑了。十个,二十个…… 没有人可以做到,尤其是程序员们。
我希望有这样一个东西:

function helpRaw(params){ //命名参数版本
   console.log(params.name,params.sex, param.age) ;
}
var help=makeSuperFunction(helpRaw, {name: "untitled" , age:18 , sex:'M' } /*默认值*/);
help({name:'john', sex:'M'});
help("name:'john', sex:'M'");
help('john',25);
help(['john',25]);

好了,现在的help 可以支持上面讨论的所有调用方式。这真的可以?
嘿嘿,我上面说过啥?

javascript 非常灵活,没有做不到只有想不到。下一篇,我们就来实现这个makeSuperFunction 。

推荐阅读更多精彩内容