一次又一次,我發現很多 bug 的根源都是同一件事:沒有真正理解 JavaScript 的函式是怎麼運作的。順帶一提,這些程式碼有不少是我自己寫的。JavaScript 帶有函式語言的特性,一旦選擇正視它,就會發現傳統的直覺在這裡並不完全適用。
本文用一個簡單的函式把五種呼叫方式逐一走過。表面上它們看起來和 C# 的函式沒什麼不同,但實際上存在關鍵差異,忽略這些差異正是難以追蹤的 bug 來源。
先建立一個接下來會用到的範例函式,它只回傳當下的 this 與兩個傳入參數:
<script type="text/javascript">
function makeArray(arg1, arg2) {
return [ this, arg1, arg2 ];
}
</script>
這是最直覺也最常見的寫法:
makeArray('one', 'two'); // => [ window, 'one', 'two' ]
等一下——window 怎麼會跑出來?為什麼 this 是它?
原因在於 JavaScript 有一個全域物件。那些看起來散落在程式碼各處、寫在函式外面的宣告,其實都處於全域物件的上下文中。在瀏覽器環境裡,這個全域物件就對應到 window。也就是說,makeArray 並不是一個「游離的函式」,而是全域物件的一個方法:
alert(typeof window.methodThatDoesntExist); // => undefined alert(typeof window.makeArray); // => function
因此下面這兩種寫法完全等價:
makeArray('one', 'two');
window.makeArray('one', 'two'); // => [ window, 'one', 'two' ]
之所以說這「很不幸」,是因為它讓宣告的函式預設變成全域成員,而全域命名空間污染是公認的不良實務。
規則一:直接呼叫 myFunction() 時,this 會指向預設的全域物件(瀏覽器中的 window)。
把函式當成物件的方法來呼叫,情況就完全不同:
var arrayMaker = {
someProperty: 'some value here',
make: makeArray
};
arrayMaker.make('one', 'two'); // => [ arrayMaker, 'one', 'two' ]
arrayMaker['make']('one', 'two'); // => [ arrayMaker, 'one', 'two' ]
this 變成了物件本身。函式的定義顯然沒被改動,為什麼行為卻不同?因為在 JavaScript 裡,函式只是一種普通的資料型別——嚴格說是一個物件,可以被傳遞、被複製。把 makeArray 指派給 make 屬性時,等同於寫成:
var arrayMaker = {
someProperty: 'some value here',
make: function (arg1, arg2) {
return [ this, arg1, arg2 ];
}
};
規則二:使用 obj.myFunction() 或 obj['myFunction']() 這種方法呼叫語法時,this 的值就是 obj。
這是 bug 最集中的地方。看這段程式碼:
<input type="button" value="Button 1" id="btn1" />
<input type="button" value="Button 2" id="btn2" />
<input type="button" value="Button 3" id="btn3" onclick="buttonClicked();" />
<script type="text/javascript">
function buttonClicked() {
var text = (this === window) ? 'window' : this.id;
alert(text);
}
var button1 = document.getElementById('btn1');
var button2 = document.getElementById('btn2');
button1.onclick = buttonClicked;
button2.onclick = function() { buttonClicked(); };
</script>
點 btn1 會顯示「btn1」,因為這是方法呼叫,this 指向所屬物件(那個按鈕元素)。
點 btn2 會顯示「window」,因為 buttonClicked 是被直接呼叫的,而不是以 obj.buttonClicked() 的形式——這和 btn3 寫在標籤裡的行為一致。
這正是為什麼像 jQuery 這樣的函式庫很有價值:當你用它綁定事件時,函式庫會幫你重寫 this,確保它指向觸發事件的元素:
$('#btn1').click(function() {
alert(this.id); // jQuery 保證 this 是該按鈕
});
寫 JavaScript 寫得越多,就越常需要把函式傳來傳去,並在不同上下文中執行它——就像 jQuery 處理事件那樣。這時候往往需要手動重置 this。好消息是,既然函式是物件,它就帶有若干預先定義的方法,其中 apply 與 call 正是為此而生:
var gasGuzzler = { year: 2008, model: 'Dodge Bailout' };
makeArray.apply(gasGuzzler, [ 'one', 'two' ]); // => [ gasGuzzler, 'one', 'two' ]
makeArray.call(gasGuzzler, 'one', 'two'); // => [ gasGuzzler, 'one', 'two' ]
兩者效果相同,差別只在參數形式:apply 接受一個陣列,call 則把參數逐一列出。實務上 apply 通常更方便,因為參數本來就常以陣列形式存在。
規則三:想在不把函式複製成方法的前提下重設 this,用 myFunction.apply(obj) 或 myFunction.call(obj)。
JavaScript 沒有 class 這個概念。任何自訂型別都需要一個初始化函式,並透過原型物件定義其方法:
// 宣告建構函式
function ArrayMaker(arg1, arg2) {
this.someProperty = 'whatever';
this.theArray = [ this, arg1, arg2 ];
}
// 宣告原型方法
ArrayMaker.prototype = {
someMethod: function () { alert('someMethod called'); },
getArray: function () { return this.theArray; }
};
var am = new ArrayMaker('one', 'two');
var other = new ArrayMaker('first', 'second');
am.getArray(); // => [ am, 'one', 'two' ]
這裡最關鍵的是函式呼叫前面的那個 new。少了它,函式就會像直接呼叫那樣執行,而 this 指向全域物件——你在建構函式裡設定的屬性全都會被掛到 window 上,這顯然不是你要的。更麻煩的是,由於建構函式沒有回傳值,忘記寫 new 會導致相關變數被賦值為 undefined。
正因如此,慣例上建構函式以大寫字母開頭,作為提醒。帶著這份小心,建構函式裡的程式碼和其他語言的初始化邏輯其實沒什麼兩樣:this 就是即將被建立出來的物件。
規則四:當函式被當作建構函式呼叫(MyFunction()),執行環境會把 this 指向新建立的物件。
理解這五種呼叫方式的差別,能幫你避開大量難纏的 bug。而避免這些 bug 的第一步,永遠是隨時清楚知道:此刻我的 this 到底是什麼。