Обробка необов'язкових параметрів у JavaScript


127

У мене є статична функція javascript, яка може приймати 1, 2 або 3 параметра:

function getData(id, parameters, callback) //parameters (associative array) and callback (function) are optional

Я знаю, що завжди можу перевірити, чи заданий параметр не визначений, але як я можу знати, якби було передано параметр чи зворотний виклик?

Який найкращий спосіб зробити це?


Приклади того, що можна передати:

1:

getData('offers');

2:

var array = new Array();
array['type']='lalal';
getData('offers',array);

3:

var foo = function (){...}
getData('offers',foo);

4:

getData('offers',array,foo);

2
Чи можете ви показати приклад того, що можна передати?
Джеймс Блек

Відповіді:


163

Ви можете знати, скільки аргументів передано вашій функції, і ви можете перевірити, чи є ваш другий аргумент функцією чи ні:

function getData (id, parameters, callback) {
  if (arguments.length == 2) { // if only two arguments were supplied
    if (Object.prototype.toString.call(parameters) == "[object Function]") {
      callback = parameters; 
    }
  }
  //...
}

Ви також можете використовувати об’єкт аргументів таким чином:

function getData (/*id, parameters, callback*/) {
  var id = arguments[0], parameters, callback;

  if (arguments.length == 2) { // only two arguments supplied
    if (Object.prototype.toString.call(arguments[1]) == "[object Function]") {
      callback = arguments[1]; // if is a function, set as 'callback'
    } else {
      parameters = arguments[1]; // if not a function, set as 'parameters'
    }
  } else if (arguments.length == 3) { // three arguments supplied
      parameters = arguments[1];
      callback = arguments[2];
  }
  //...
}

Якщо вас цікавить, погляньте на цю статтю Джона Ресіга про техніку моделювання методу перевантаження на JavaScript.


Навіщо використовувати Object.prototype.toString.call (параметри) == "[функція об'єкта]", а не typeof (параметри) === "функція"? Чи є якась важлива різниця між ними? PS В статті, яку ви згадуєте, начебто використовується остання
Томер Каган

@TomerCagan Я думаю, що це питання переваги (ish). Є кілька хороших відповідей / коментарів до теми під цим питанням.
Philiiiiiipp

75

Помилка - це означає, що ви посилаєтесь на свою функцію аргументами, які не в належному порядку ... що я б не рекомендував.

Я б рекомендував замість цього годувати об’єкт вашою функцією так:

function getData( props ) {
    props = props || {};
    props.params = props.params || {};
    props.id = props.id || 1;
    props.callback = props.callback || function(){};
    alert( props.callback )
};

getData( {
    id: 3,
    callback: function(){ alert('hi'); }
} );

Переваги:

  • вам не доведеться враховувати порядок аргументів
  • не потрібно робити перевірку типу
  • простіше визначити значення за замовчуванням, оскільки перевірка типу не потрібна
  • менше головних болів. уявіть, якщо ви додали четвертий аргумент, вам доведеться оновлювати перевірку типу кожен раз, а що робити, якщо четвертий чи послідовний також є функціями?

Недоліки:

  • час на код рефактора

Якщо у вас немає вибору, ви можете використовувати функцію, щоб визначити, чи дійсно об'єкт є функцією (див. Останній приклад).

Примітка. Це правильний спосіб виявлення функції:

function isFunction(obj) {
    return Object.prototype.toString.call(obj) === "[object Function]";
}

isFunction( function(){} )

"це працювало б 99% часу через деякі помилки ES". Чи можете ви пояснити більше? Чому це може піти не так?
jd.

Я додав правильний код для виявлення функції. Я вірю, що помилка тут: bugs.ecmascript.org/ticket/251
meder omuraliev

Я б дуже рекомендував вам годувати лише один об’єкт. Якщо ні, використовуйте метод CMS.
meder omuraliev

Ой ... чорт ... Щойно опублікував ту саму ідею.
Арніс Лапса

1
Ще один можливий недолік - відсутність інтелігенції. Я не вважаю це великою справою, але слід зазначити.
Едін

2

Тому використовуйте оператор typeof, щоб визначити, чи є другим параметром масив чи функція.

Це може дати кілька пропозицій: http://www.planetpdf.com/developer/article.asp?ContentID=testing_for_object_types_in_ja

Я не впевнений, чи це робота, чи домашнє завдання, тому наразі я не хочу давати вам відповідь, але typeof допоможе вам її визначити.


2

Ви повинні перевірити тип отриманих параметрів. Можливо, вам слід використовувати argumentsмасив, оскільки другий параметр іноді може бути "параметрами", а іноді "зворотним викликом", а іменування ним параметрів може вводити в оману.


2

Я знаю, що це досить старе питання, але я цим займався недавно. Дайте мені знати, що ви думаєте про це рішення.

Я створив утиліту, яка дозволяє мені сильно вводити аргументи і дозволяти їм бути необов'язковими. Ви в основному обертаєте свою функцію в проксі. Якщо пропустити аргумент, він не визначений . Це може стати химерним, якщо у вас є кілька необов'язкових аргументів одного типу, поруч. (Існують варіанти передачі функцій замість типів, щоб робити спеціальні перевірки аргументів, а також вказувати значення за замовчуванням для кожного параметра.)

Ось як виглядає реалізація:

function displayOverlay(/*message, timeout, callback*/) {
  return arrangeArgs(arguments, String, Number, Function, 
    function(message, timeout, callback) {
      /* ... your code ... */
    });
};

Для наочності ось що відбувається:

function displayOverlay(/*message, timeout, callback*/) {
  //arrangeArgs is the proxy
  return arrangeArgs(
           //first pass in the original arguments
           arguments, 
           //then pass in the type for each argument
           String,  Number,  Function, 
           //lastly, pass in your function and the proxy will do the rest!
           function(message, timeout, callback) {

             //debug output of each argument to verify it's working
             console.log("message", message, "timeout", timeout, "callback", callback);

             /* ... your code ... */

           }
         );
};

Ви можете переглянути проксі-код аранжування у моєму сховищі GitHub тут:

https://github.com/joelvh/Sysmo.js/blob/master/sysmo.js

Ось функція утиліти з деякими коментарями, скопійованими з сховища:

/*
 ****** Overview ******
 * 
 * Strongly type a function's arguments to allow for any arguments to be optional.
 * 
 * Other resources:
 * http://ejohn.org/blog/javascript-method-overloading/
 * 
 ****** Example implementation ******
 * 
 * //all args are optional... will display overlay with default settings
 * var displayOverlay = function() {
 *   return Sysmo.optionalArgs(arguments, 
 *            String, [Number, false, 0], Function, 
 *            function(message, timeout, callback) {
 *              var overlay = new Overlay(message);
 *              overlay.timeout = timeout;
 *              overlay.display({onDisplayed: callback});
 *            });
 * }
 * 
 ****** Example function call ******
 * 
 * //the window.alert() function is the callback, message and timeout are not defined.
 * displayOverlay(alert);
 * 
 * //displays the overlay after 500 miliseconds, then alerts... message is not defined.
 * displayOverlay(500, alert);
 * 
 ****** Setup ******
 * 
 * arguments = the original arguments to the function defined in your javascript API.
 * config = describe the argument type
 *  - Class - specify the type (e.g. String, Number, Function, Array) 
 *  - [Class/function, boolean, default] - pass an array where the first value is a class or a function...
 *                                         The "boolean" indicates if the first value should be treated as a function.
 *                                         The "default" is an optional default value to use instead of undefined.
 * 
 */
arrangeArgs: function (/* arguments, config1 [, config2] , callback */) {
  //config format: [String, false, ''], [Number, false, 0], [Function, false, function(){}]
  //config doesn't need a default value.
  //config can also be classes instead of an array if not required and no default value.

  var configs = Sysmo.makeArray(arguments),
      values = Sysmo.makeArray(configs.shift()),
      callback = configs.pop(),
      args = [],
      done = function() {
        //add the proper number of arguments before adding remaining values
        if (!args.length) {
          args = Array(configs.length);
        }
        //fire callback with args and remaining values concatenated
        return callback.apply(null, args.concat(values));
      };

  //if there are not values to process, just fire callback
  if (!values.length) {
    return done();
  }

  //loop through configs to create more easily readable objects
  for (var i = 0; i < configs.length; i++) {

    var config = configs[i];

    //make sure there's a value
    if (values.length) {

      //type or validator function
      var fn = config[0] || config,
          //if config[1] is true, use fn as validator, 
          //otherwise create a validator from a closure to preserve fn for later use
          validate = (config[1]) ? fn : function(value) {
            return value.constructor === fn;
          };

      //see if arg value matches config
      if (validate(values[0])) {
        args.push(values.shift());
        continue;
      }
    }

    //add a default value if there is no value in the original args
    //or if the type didn't match
    args.push(config[2]);
  }

  return done();
}

2

Я рекомендую вам використовувати ArgueJS .

Ви можете просто ввести свою функцію таким чином:

function getData(){
  arguments = __({id: String, parameters: [Object], callback: [Function]})

  // and now access your arguments by arguments.id,
  //          arguments.parameters and arguments.callback
}

Я вважав вашими прикладами, що ви хочете, щоб ваш idпараметр був рядком, правда? Тепер, getDataвимагає а String idі приймає необов'язкові Object parametersта Function callback. Усі випадки використання, які ви опублікували, працюватимуть як очікується.



1

Ви хочете сказати, що ви можете мати такі дзвінки: getData (id, параметри); getData (id, зворотний дзвінок)?

У цьому випадку ви, очевидно, не можете покластися на позицію, і вам потрібно покластися на аналіз типу: getType (), а потім, якщо необхідно, getTypeName ()

Перевірте, чи відповідний параметр є масивом чи функцією.


0

Я думаю, ви хочете тут використовувати typeof ():

function f(id, parameters, callback) {
  console.log(typeof(parameters)+" "+typeof(callback));
}

f("hi", {"a":"boo"}, f); //prints "object function"
f("hi", f, {"a":"boo"}); //prints "function object"

0

Якщо ваша проблема пов’язана лише з перевантаженням функції (вам потрібно перевірити, чи є параметр 'параметри' параметри, а не 'зворотний виклик'), я рекомендую вам не турбуватися про тип аргументу і
використовувати цей підхід . Ідея проста - використовуйте буквальні об'єкти для комбінування своїх параметрів:

function getData(id, opt){
    var data = voodooMagic(id, opt.parameters);
    if (opt.callback!=undefined)
      opt.callback.call(data);
    return data;         
}

getData(5, {parameters: "1,2,3", callback: 
    function(){for (i=0;i<=1;i--)alert("FAIL!");}
});

0

Це, мабуть, може бути поясненням:

function clickOn(elem /*bubble, cancelable*/) {
    var bubble =     (arguments.length > 1)  ? arguments[1] : true;
    var cancelable = (arguments.length == 3) ? arguments[2] : true;

    var cle = document.createEvent("MouseEvent");
    cle.initEvent("click", bubble, cancelable);
    elem.dispatchEvent(cle);
}

-5

Чи можете ви змінити функцію? Це не спрацює:

function doSomething(id){}
function doSomething(id,parameters){}
function doSomething(id,parameters,callback){}

8
Ні, це не спрацює. Ви не отримаєте жодних помилок, але Javascript завжди буде використовувати останню функцію, яку ви визначили.
jd.

6
Ого. Я думав, ти божевільний. Я просто тестував це. Ти правий. Мій світ просто трохи змінився для мене. Я думаю, що у мене сьогодні дуже багато JavaScript, щоб переконатися, що у мене немає нічого подібного у виробництві. Дякуємо за коментар Я дав вам +1.
Дж. Хендрікс
Використовуючи наш веб-сайт, ви визнаєте, що прочитали та зрозуміли наші Політику щодо файлів cookie та Політику конфіденційності.
Licensed under cc by-sa 3.0 with attribution required.