在 Ruby、CoffeeScript 以及後來的 JavaScript 版本中,函式可以直接宣告預設參數,寫起來非常乾淨:
function myFunc(param1, param2 = "second string") {
console.log(param1, param2);
}
// 輸出:"first string" 與 "second string"
myFunc("first string");
// 輸出:"first string" 與 "second string version 2"
myFunc("first string", "second string version 2");然而在支援 ES6 之前的 JavaScript 裡,這個寫法無效。那時我們只能用現有的語彙自己湊出來。本文整理幾種做法,從最樸素到最實用。
function myFunc(param1, param2) {
if (param2 === undefined) {
param2 = "second string";
}
console.log(param1, param2);
}
// 輸出:"first string" 與 "second string version 2"
myFunc("first string", "second string version 2");關鍵事實是:被省略的參數在函式內部讀取時,一律是 undefined。因此只要判斷是否為 undefined,就能補上預設值。
注意這裡用 === 而非 ==,也沒有用 if (!param2)。原因是後者會把 0、空字串、false、null 全部誤判為「沒傳」,而這些都是合法的值。
只有一個參數時,這招綽綽有餘;但參數一多,連續寫好幾行 if 就很囉嗦了。
參數多於一個時,更好的作法是收在一個物件裡傳入。除了寫法乾淨,還有個附加好處:每個參數都有明確名稱,呼叫端不必記順序。
function myFunc(paramObject) {
var defaultParams = {
param1: "first string",
param2: "second string",
param3: "third string"
};
var finalParams = defaultParams;
// 走訪傳入物件的每個屬性
for (var key in paramObject) {
// 若不是繼承而來,才處理
if (paramObject.hasOwnProperty(key)) {
// 若該屬性有值,就覆寫預設值
if (paramObject[key] !== undefined) {
finalParams[key] = paramObject[key];
}
}
}
console.log(finalParams.param1,
finalParams.param2,
finalParams.param3);
}
myFunc({param1: "My own string"});這裡有兩個容易忽略的細節。第一是 hasOwnProperty 檢查:for...in 會連原型鏈上的屬性一起走訪,少了這道檢查,被污染的原型屬性就會混進來。第二是把 defaultParams 直接指派給 finalParams,兩者指向同一個物件,因此覆寫 finalParams 等於改動 defaultParams——在這個例子中無妨,但如果函式會被反覆呼叫且 defaultParams 定義在外部,就會產生平預不到的狀態污染。較安全的寫法是複製一份。
這段程式確實有點笨重。若這種模式在專案裡到處出現,值得抽成一個共用的工具函式。
好消息是 jQuery 與 Underscore 都提供了現成的合併方法。以下用 Underscore 的 extend 改寫同一個需求:
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);
}
// 輸出:
// "My own string" 與 "second string" 與 "third string"
myFunc({param1: "My own string"});一行取代整個迴圈,語意也更清楚:把傳入值合併到預設值上。
如果執行環境允許 ES6 以上,上面所有內容都可以壓成一行:
function myFunc(param1, param2 = "second string", param3 = "third string") {
console.log(param1, param2, param3);
}物件參數的預設值則可以用解構搭配預設指定:
function myFunc({
param1 = "first string",
param2 = "second string",
param3 = "third string"
} = {}) {
console.log(param1, param2, param3);
}
myFunc({ param1: "My own string" });外層的 = {} 是為了讓「完全不傳參數」時也能正常運作,否則解構 undefined 會丟錯。
理解 ES5 時代的手寫做法仍有意義:它讓你明白語法糖背後究竟做了什麼,也能在維護舊專案時派上用場。而在新專案中,直接用原生預設參數就好。