使用可选参数和回调来干掉JavaScript函数

时间:2013-06-29 07:38:08

标签: javascript node.js

在Node.js中,由于多种原因,习惯/推荐将回调函数作为最后一个参数传递给函数。可能还有一个或多个可选参数,我们希望在回调之前传递。您最终会看到很多非常重复的代码,例如

// receiveMessages([options], [callback])
function receiveMessages(options, callback) {
   if(typeof options === 'function'){
      callback = options;
      options = {}; // or some other sensible default
   }
   //...
 }

添加其他可选参数意味着添加额外的检查,当然:

 // through([dest], [options], [callback])
 function through(dest, options, callback) {
     if(typeof dest === 'function'){
        callback = dest;
        dest = noop();
        options = {};
     }else if(typeof options === 'function'){
        callback = options;
        options = {};
     }
     // ...
 }

修改此模式appears all over标准库。

我可以想到一些干扰它的hacky方法,但我想知道是否有人有一个特别优雅或通用的解决方案来使参数绑定到正确的位置参数。

2 个答案:

答案 0 :(得分:2)

  

在Node.js中,由于多种原因,习惯/推荐将回调函数作为最后一个参数传递给函数

我能想到的唯一原因是迫使开发者提供其他参数。

例如,function (success, error)会导致草率编程,因为懒惰的编码器会简单地省略error回调。这就是你常见function (error, success)

的原因

话虽如此,上面的约定对强制参数很有用。如果您想要可选参数,请不要这样做。处理此方案的一种方法是以下方案:

function (required1, required2, ..., callback, options)
// or
function (required1, required2, ..., options, callback)

其中每个可选参数可能会或可能不会作为options的属性提供。

编辑:实际上,这在某些节点库中使用,例如http://nodejs.org/api/fs.html#fs_fs_appendfile_filename_data_options_callback

答案 1 :(得分:2)

我想到的一件事是方法重载。从技术上讲,这在JavaScript中不受支持,但有一些方法可以实现这样的事情。 John Resig在他的博客中有一篇关于它的文章:http://ejohn.org/blog/javascript-method-overloading/

此外,这是我的实现,这与John Resig非常相似,并且受到它的高度启发:

var createFunction = (function(){
    var store = {};

    return function(that, name, func) {
        var scope, funcs, match;

        scope = store[that] || (store[that] = {});
        funcs = scope[name] || (scope[name] = {});

        funcs[func.length] = func;

        that[name] = function(){
            match = funcs[arguments.length];
            if (match !== undefined) {
                return match.apply(that, arguments);
            } else {
                throw "no function with " + arguments.length + " arguments defined";
            }
        };
    };
}());

这使您可以多次使用不同数量的参数定义相同的函数:

createFunction(window, "doSomething", function (arg1, arg2, callback) {
    console.log(arg1 + " / " + arg2 + " / " + callback);
});

createFunction(window, "doSomething", function (arg1, callback) {
    doSomething(arg1, null, callback);
});

这段代码定义了一个全局函数doSomething,一次有三个,一次有两个参数。如你所见,这种方法的第一个缺点是你必须提供一个附加函数的对象,你不能只说“在这里定义一个函数”。此外,函数声明比以前复杂一点。但您现在可以使用不同数量的参数调用函数,并在不使用重复if..else结构的情况下获得正确的结果:

doSomething("he", function(){});         //he / null / function(){}
doSomething("he", "ho", function(){});   //he / ho / function(){}

到目前为止,只有参数的数量很重要,但我可以考虑扩展它,以便对不同的数据类型做出反应,以便人们也可以区分以下内容:

function doSomething(opt1, opt2, callback){
    //some code
}

doSomething({anObject: "as opt1"}, function(){});
doSomething("a string as opt2", function(){});

尽管如此,这可能不是最好的方法,但在某些情况下它可以很方便。对于很多可选参数,我个人喜欢Pumbaa80将这些选项放在一个必需的对象参数中的答案。