在 Ruby、CoffeeScript 以及後來的 JavaScript 版本中,函數可以直接宣告預設參數:
function myFunc(param1, param2 = "second string") {
console.log(param1, param2);
}
// Outputs: "first string" and "second string"
myFunc("first string");
// Outputs: "first string" and "second string version 2"
myFunc("first string", "second string version 2");
但在支援這種語法之前的年代,我們只能用既有工具模擬。以下幾種方式至今仍常出現在舊專案裡。
function myFunc(param1, param2) {
if (param2 === undefined) {
param2 = "second string";
}
console.log(param1, param2);
}
// Outputs: "first string" and "second string version 2"
myFunc("first string", "second string version 2");
原理很簡單:被省略的參數在函數內部讀取時一律是 undefined。參數只有一兩個時,這是最直白的解法。但參數一多,就會變得很囉嗦。
改用單一設定物件傳入,有兩個好處:呼叫端可讀性提高,每個參數都有明確名稱;同時預設值可以集中管理。
function myFunc(paramObject) {
var defaultParams = {
param1: "first string",
param2: "second string",
param3: "third string"
};
var finalParams = defaultParams;
// We iterate over each property of the paramObject
for (var key in paramObject) {
// If the current property wasn't inherited, proceed
if (paramObject.hasOwnProperty(key)) {
// If the current property is defined,
// add it to finalParams
if (paramObject[key] !== undefined) {
finalParams[key] = paramObject[key];
}
}
}
console.log(finalParams.param1,
finalParams.param2,
finalParams.param3);
}
myFunc({param1: "My own string"});
這段程式碼有兩個關鍵細節:hasOwnProperty 用來排除原型鏈上繼承来的屬性,避免誤把 Object.prototype 的擴充吃進來;!== undefined 判斷則確保呼叫端不會用 undefined 覆蓋掉預設值。
上述邏輯寫多了難免覺得笨重,好在 jQuery 與 Underscore 都提供了 extend 這類合併方法。用 Underscore 改寫:
function myFunc(paramObject) {
var defaultParams = {
param1: "first string",
param2: "second string",
param3: "third string"
};
var finalParams = _.extend(defaultParams, paramObject);
console.log(finalParams.param1,
finalParams.param2,
finalParams.param3);
}
// Outputs:
// "My own string" and "second string" and "third string"
myFunc({param1: "My own string"});
一行取代整個迴圈,這就是抽象化帶來的價值。
ES6 之後,原生語法已經可以直接勝任:function myFunc(param1, param2 = "second string") {};若參數眾多,則用解構加上預設值,例如 function myFunc({ param1 = "first string", param2 = "second string" } = {}) {},同時兼具可讀性與彈性。