Ajax 之旅(一):由 prototype_1.3.1 進入 JavaScript 殿堂——類別初探
還是決定冠上 Ajax 的頭銜,畢竟很多人會用這個關鍵詞搜尋。雖然我認為這只是個被炒作的概念,但不得不承認 Ajax 叫起來方便多了。寫這個系列教程的起因很簡單:經過一段時間的 Ajax 學習,我有一些體會,也越發認識到 Ajax 技術的強大,於是決定記錄下來,順便整理自己的思路。
前幾年,JavaScript 在一般人眼裡功能還很狹窄,能做的不是簡單的表單驗證,就是華而不實的網頁特效。隨著 Flash 出現,大家已不像以前那樣熱衷於 JS 特效,似乎 JS 能做的事更少了。但就在此時,Ajax 的概念冒了出來,以 Gmail 為典型代表的 Ajax 應用受到廣泛關注,一躍成為熱門技術。當 JavaScript 與 XML、DOM 模型結合起來,所能成就的事常常令人匪夷所思,有些功能甚至已能與桌面程式相媲美。
廢話不多說,就從一個 JavaScript 開發框架 prototype_1.3.1(以下簡稱 prototype)開始。以下是框架最前面的兩段程式碼:
var Prototype = {
Version: '1.3.1',
emptyFunction: function() {}
}
var Class = {
create: function() {
return function() {
this.initialize.apply(this, arguments);
}
}
}
先看以下兩種語法的差異:
var o={};
var f=function(){};
後者容易理解,等價於 function f(){},定義一個函數 f。前者則較少見:其實是建立一個物件,{} 中可指定物件成員,例如上面的 Prototype 就是一個物件,有兩個成員——版本號與一個空方法。這種不用定義類別就能直接建立物件的能力,或許只有 JS 辦得到。而後一種語法還有另一個功能:定義一個類別 f。若你在函數體中用了 this,那麼 this 後面的變數就是該類別的成員。
不僅 this 可以定義類別成員,還有一種語法:
function c(){
member1:value,
member2:function(){}
}
這等價於:
function c(){
this.member1=value;
this.member2=function(){};
}
需注意,用前一種寫法時,最後一個成員末尾不能加逗號。在 JS 裡,函數與類別沒有區別,都可以 new;new 的作用是把函數體的語句執行一遍,再傳回一個物件。若函數裡有 this,this 後面的變數會作為物件成員;若沒有,new 只是傳回一個沒有任何成員的空物件。所以你用 typeof 查看一個所謂類別的型別時,仍會傳回 function。在 JS 裡也基本沒有型別概念,所有變數宣告都用 var,即使是函數也一樣——函數其實只是一個變數。
說函數是變數,或許有人不解。試試這樣做:
function fTest(){
var a=1;
alert(a);
}
alert(fTest);
你會發現顯示的是 fTest 這個函數的函數體,所以我們可以認為:所謂函數,僅僅是 JS 引擎可以解析的一段程式碼字串,函數名變數儲存的只是這段字串。更精確地說,函數名是一個指標變數,儲存這段程式碼在記憶體中的位置。這樣就不難理解函數作為參數傳遞、作為值傳回了,這是後續會大量使用的技術。因為類別也是函數,所以理解了函數,也就理解了類別。
雖然 JS 裡函數與類別沒有區別,但類別的概念能方便我們進行程式設計,於是 prototype 很有創意地建立了一個全域物件 Class:
var Class = {
create: function() {
return function() {
this.initialize.apply(this, arguments);
}
}
}
Class 是一個全域物件,唯一方法 create 會傳回一個函數(前面已講過函數作為傳回值的機制)。傳回的函數包含一條語句:
this.initialize.apply(this, arguments);
new 一個函數時會執行函數裡的程式碼,最後傳回物件;所以當你以 Class.create() 建立函數、再 new 這個傳回的函數時,首先便會執行這條語句——這其實是為了呼叫類別的建構子。就這樣,Class 成為整個 prototype 的型別建立模型,並能把類別與函數在程式碼上區分開來。Class.create() 僅傳回一個空類別,且預設它具有 initialize 方法,所以要使用這個類別,至少需要一個建構子,這就需要用到類別的繼承。類別只是一個函數,那麼函數該如何繼承?看起來匪夷所思,但 JavaScript 辦得到,prototype 更讓它優雅——至於怎麼做到,且聽下回分解。
Ajax 之旅(二):JavaScript 中類別的深入研究——實作與繼承
上回說到類別的定義,prototype 透過一個全域物件 Class,從形式上把函數與類別區分開來。既然是類別,就有抽象類別、具體類別、類別的繼承,同時類別成員可以分為實例成員與靜態成員。下面看 prototype 如何做到這些。
先看 prototype 中的以下程式碼:
var Abstract = new Object();
Object.extend = function(destination, source) {
for (property in source) {
destination[property] = source[property];
}
return destination;
}
Object.prototype.extend = function(object) {
return Object.extend.apply(this, [this, object]);
}
第一個宣告了一個物件 Abstract。Object 其實是一個函數,沒有任何成員,所以是空類別,Abstract 也就沒有任何成員。先說明這個語法:
function.member=function(){}
此時 function 一般都是已定義過的,這條語句的作用是給 function 增加一個靜態成員 member。上面 Object.extend=…… 就是給 Object 類別增加一個靜態方法 extend。知道了如何定義靜態成員,那實例成員怎麼定義?很簡單,在類別名與成員名之間加上 prototype:
function.prototype.member=function(){}
prototype 不僅能這樣用,還可以:
function.prototype={
member1:function(){……},
member2:"abc",
member3:function(){……}
}
這樣就實作了實例成員的定義。那 prototype 代表什麼?直接用 {} 括起來表示一個物件,而 prototype 後面是一個 {} 結構,難道它也是物件?沒錯,prototype 其實也是一個物件!在 JavaScript 裡,我們可以為一個物件任意增加成員:
object.member=function(){……};
只要這樣定義,一個物件就能立刻具備 member 方法。現在我們知道 prototype 是一個物件,而 function 是一個函數或類別,那麼可以認為 prototype 是任何一個類別(函數)內部保留的一個靜態成員,用來儲存這個類別的所有成員指標,但這些成員都只是原型,未經初始化,這也符合 prototype 的原義。你可以隨時透過 prototype 這個物件來擴充成員。new 一個類別時,prototype 的成員便經初始化後賦給實例化的物件。上面 Object.prototype.extend=…… 就是給 Object 增加一個實例方法 extend,實例方法中可引用 this 指標,指向由這個類別實例化的物件本身。
繼續之前,先了解兩個語句:
for(var p in object){}
method.apply(object,arguments);
第一句:列舉一個變數的所有成員,若是函數則是所有靜態成員,若是物件則是所有實例成員,p 的型別是字串,代表成員名稱。引用成員不僅可用 variable.member,還可用 variable["member"],反之賦值亦然,這為列舉變數成員帶來很大方便。第二句:把 method 這個方法套用到 object 去執行,參數是 arguments 這個陣列。注意 method 並非 object 的成員,但可理解為執行 object.method(arguments)。這是個很重要的方法,後面會經常用到。
接著看 extend。它是一個非常重要的方法,既是類別 Object 的靜態成員,也是其實例成員。它接收兩個參數 destination 與 source:若兩者都是類別,就把 source 的所有靜態成員複製給 destination;若兩者都是物件,就把所有實例成員複製過來。此時 destination 中若已有同名成員,則會被覆蓋,也就是讓 destination 具備 source 的所有成員,並傳回這個 destination。再看 extend 作為 Object 的實例成員:
Object.prototype.extend = function(object) {
return Object.extend.apply(this, [this, object]);
}
apply 的呼叫者是一個方法,而 Object.extend 是一個靜態方法,它被套用到 this(也就是 Object 的實例,假設為 obj)上,後面方括號是一個陣列,包含 this 與 object 兩個成員,實際上就是 Object 靜態成員 extend 的 arguments 參數。那麼這條語句就相當於執行 obj.extend(this,object)。因為 obj 與 object 都是物件,於是函數作用就是讓 obj 具備 object 的所有成員並傳回 obj——也就是讓 obj「繼承於」object。很好,我們看到了繼承!類別不就是有個 prototype 嗎,而 prototype 是物件!
類別繼承的語法看似很簡單:
b.prototype.extend(a.prototype);
讓 b 繼承 a。但事實沒那麼簡單:prototype 是存放方法原型指標,extend 方法未經初始化,不能使用!要使用 extend,就必須實例化一個物件。看看 prototype 怎麼做:
b.prototype=(new a()).extend(b.prototype);
很高明!先實例化 a 物件,然後在它基礎上呼叫 extend,把所有 b.prototype 的成員覆蓋到 a 的物件,再把这个 a 物件賦值給 b.prototype,便完成了 b 從 a 的繼承。實際使用時,一般寫法都是:
b.prototype=(new a()).extend({});
因為讓 b 繼承自 a 時,b 通常是未定義的類別,所以後面的 {} 中其實就可以定義類別成員;你也可以先定義再繼承,只是與傳統概念有別。
Ajax 之旅(三):JavaScript 中的事件設計模式
今天暫時拋開 prototype 1.3.1,分享我的 JavaScript 事件設計心得,其技術基礎在於函數的本質。JavaScript 內建物件都有事件功能,比如 button 有 onclick、input 有 onchange。那如何在我們自訂的類別中實作事件?很簡單:
var myClass=Class.create();
myClass.prototype={
show:function(){
//statement
onshow();
},
onshow:function(){}
}
這段程式碼其實就實作了 onshow 事件,在 myClass 實例 show 時觸發,你可以給 onshow 綁定一個函數來使用事件功能。但這樣的實作有兩個突出問題:一是只能綁定一個回呼函數,若要多重綁定就得自己寫很多程式碼來封裝;二是不能傳遞參數,因為 onshow 只能賦予函數名,無法把參數傳進去。
那這些問題怎麼解決?先考慮一個問題:頁面需要用 JavaScript 做初始化,且必須在載入完成之後進行。通常我們會把程式碼放到 HTML 檔案最下方,但此時在載入完成前,頁面上的按鈕點擊若需呼叫必須經過初始化的方法,不作判斷就容易出錯。一個簡單想法是用 bool 變數 loaded 判斷,初始為 false,初始化完成後為 true,點擊時遇到 false 就返回。這實現雖簡單,卻可能造成使用者點擊無效而不知所以然。更完善的做法是能捕獲這個方法,將其綁定到頁面載入完成事件,待載入完成後自動呼叫。
現在看事件設計模式的實作程式碼:
var myClass=Class.create();
myClass.prototype={
initialize:function(){
this.initEvent=new Object();
},
init:function(){
//初始化要執行的語句
//下面是呼叫綁定的回呼函數
for(var p in this.initEvent){
//extend 是內建方法,不可作為回呼關鍵字
if(p=="extend")continue;
this.initEvent[p].apply(_object,[]);
}
},
attachOnInit:function(_key,_object,_method,_arguments){
this.initEvent[_key]=createFunction(_object,_method,_arguments);
},
}
function createFunction(_object,_method,_arguments){
return function(){
_method.apply(_object,_arguments);
}
}
這段程式碼實作了一個類別 myClass,具 init 方法,觸發 oninit 事件。使用時要綁定事件,可呼叫 attachOnInit 方法,參數分別為:_key(回呼函數的唯一標識,重複則後者覆蓋前者)、_object(回呼函數的物件,若是 script 中的函數可傳 this,即 document 物件)、_method(要回呼的函數名,非字串)、_arguments(回呼函數的參數陣列)。createFunction 則負責包裝一個函數使其內置參數。使用範例:
function myFunc(s){
alert(s);
}
var myObj=new myClass();
myClass.attach("key1",this,myFunc,[123]);
myClass.init();
這就把 myFunc 綁定到 myObj 的 init 函數,執行後會彈出對話框 123。
Ajax:prototype 原始碼解讀之 prototype.js(一)
/** 定義一個全域物件,屬性 Version 在發布時會替換為當前版本號 */
var Prototype = { Version: '@@VERSION@@' }
/** 建立一種類型,其屬性 create 是一個方法,傳回一個建構函數。一般使用為 var X = Class.create();,傳回一個型別;要使用 X 型別,需再用 new X() 取得實例。傳回的建構函數會執行名為 initialize 的方法(initialize 是 Ruby 物件的建構子方法名)。*/
var Class = { create: function() { return function() { this.initialize.apply(this, arguments); } } }
/** 建立一個物件,本意或許是定義一個抽象類別,但從後代程式碼應用來看,Abstract 更多是為了保持命名空間清晰。*/
var Abstract = new Object();
/** 取得參數物件的所有屬性和方法,有點像多重繼承,但這種繼承是動態獲得的。*/
Object.prototype.extend = function(object) { for (property in object) { this[property] = object[property]; } return this; }
/** 這個方法封裝一個 JavaScript 函數物件,傳回一個新函數物件,主體與原物件相同,但 bind() 的參數將作為當前物件,也就是新函數中的 this 被改為參數提供的物件。*/
Function.prototype.bind = function(object) { var method = this; return function() { method.apply(object, arguments); } }
/** 和 bind 一樣,但一般用做 HTML 控件物件的事件處理,所以要傳遞 event 物件。*/
Function.prototype.bindAsEventListener = function(object) { var method = this; return function(event) { method.call(object, event || window.event); } }
/** 將整數形式 RGB 顏色值轉換為 HEX 形式 */
Number.prototype.toColorPart = function() { var digits = this.toString(16); if (this < 16) return '0' + digits; return digits; }
/** 典型 Ruby 風格的函數,將參數中的方法逐個呼叫,傳回第一個成功執行方法的傳回值 */
var Try = { these: function() { var returnValue; for (var i = 0; i < arguments.length; i++) { var lambda = arguments[i]; try { returnValue = lambda(); break; } catch (e) {} } return returnValue; } }
/** 一個設計精巧的定時執行器。它用 bind 把 this 綁定到 PeriodicalExecuter 實例,因為 setTimeout 預設以 window 為當前物件,若不綁定 this,onTimerEvent 將無法存取 currentlyExecuting 屬性。*/
var PeriodicalExecuter = Class.create();
PeriodicalExecuter.prototype = {
initialize: function(callback, frequency) { this.callback = callback; this.frequency = frequency; this.currentlyExecuting = false; this.registerCallback(); },
registerCallback: function() { setTimeout(this.onTimerEvent.bind(this), this.frequency * 1000); },
onTimerEvent: function() { if (!this.currentlyExecuting) { try { this.currentlyExecuting = true; this.callback(); } finally { this.currentlyExecuting = false; } } this.registerCallback(); }
}
/** 這個函數有兩個作用:一是 document.getElementById(id) 的最簡化呼叫,如 $("aaa") 傳回 aaa 物件;二是取得物件陣列,如 $("aaa","bbb") 傳回包含兩個 id 為 "aaa" 與 "bbb" 的控件物件的陣列。*/
function $() { var elements = new Array(); for (var i = 0; i < arguments.length; i++) { var element = arguments[i]; if (typeof element == 'string') element = document.getElementById(element); if (arguments.length == 1) return element; elements.push(element); } return elements; }
Ajax:prototype 原始碼解讀之 prototype.js(二)
/** 定義 Ajax 物件,靜態方法 getTransport 傳回一個 XMLHttp 物件 */
var Ajax = { getTransport: function() { return Try.these( function() {return new ActiveXObject('Msxml2.XMLHTTP')}, function() {return new ActiveXObject('Microsoft.XMLHTTP')}, function() {return new XMLHttpRequest()} ) || false; }, emptyFunction: function() {} }
Ajax.Base 並未使用 Class.create() 建立,是因為作者不希望它被庫使用者實例化,作者在其他物件型別的宣告中將繼承於它,就好像 Java 中的私有抽象類別。
Ajax.Base = function() {};
Ajax.Base.prototype = {
/** extend 的用法讓人耳目一新:options 先設定預設屬性,再 extend 參數物件,若參數物件有同名屬性則覆蓋預設值。*/
setOptions: function(options) { this.options = { method: 'post', asynchronous: true, parameters: '' }.extend(options || {}); }
}
Ajax.Request 封裝 XMLHttp。Ajax.Request = Class.create();
/** 定義四種事件(狀態):Uninitialized、Loading、Loaded、Interactive、Complete */
Ajax.Request.Events = ['Uninitialized', 'Loading', 'Loaded', 'Interactive', 'Complete'];
Ajax.Request.prototype = (new Ajax.Base()).extend({
initialize: function(url, options) {
this.transport = Ajax.getTransport();
this.setOptions(options);
try {
if (this.options.method == 'get') url += '?' + this.options.parameters + '&_=';
this.transport.open(this.options.method, url, true);
if (this.options.asynchronous) { this.transport.onreadystatechange = this.onStateChange.bind(this); setTimeout((function() {this.respondToReadyState(1)}).bind(this), 10); }
this.transport.setRequestHeader('X-Requested-With', 'XMLHttpRequest');
this.transport.setRequestHeader('X-Prototype-Version', Prototype.Version);
if (this.options.method == 'post') { this.transport.setRequestHeader('Connection', 'close'); this.transport.setRequestHeader('Content-type', 'application/x-www-form-urlencoded'); }
this.transport.send(this.options.method == 'post' ? this.options.parameters + '&_=' : null);
} catch (e) {}
},
onStateChange: function() { var readyState = this.transport.readyState; if (readyState != 1) this.respondToReadyState(this.transport.readyState); },
respondToReadyState: function(readyState) { var event = Ajax.Request.Events[readyState]; (this.options['on' + event] || Ajax.emptyFunction)(this.transport); }
});
Ajax.Updater 用於綁定一個 HTML 元素與 XMLHttp 呼叫的傳回值。若 options 中有 insertion 物件,insertion 能提供更多的插入控制。
Ajax.Updater = Class.create();
Ajax.Updater.prototype = (new Ajax.Base()).extend({
initialize: function(container, url, options) { this.container = $(container); this.setOptions(options); if (this.options.asynchronous) { this.onComplete = this.options.onComplete; this.options.onComplete = this.updateContent.bind(this); } this.request = new Ajax.Request(url, this.options); if (!this.options.asynchronous) this.updateContent(); },
updateContent: function() { if (this.options.insertion) { new this.options.insertion(this.container, this.request.transport.responseText); } else { this.container.innerHtml = this.request.transport.responseText; } if (this.onComplete) { setTimeout((function() {this.onComplete(this.request)}).bind(this), 10); } }
});
Ajax:prototype 原始碼解讀之 prototype.js(三)
Field 是針對頁面元素物件的工具類別,提供 clear(清除值)、focus(取得焦點)、present(判斷是否為空)、select(選中)、activate(聚焦並選中)等靜態方法;Form 則是表單工具類別,提供 serialize(序列化為 QueryString)、getElements(取得所有元素)、disable(停用)、focusFirstElement(聚焦第一個可用元素)、reset(重設)等方法;Form.Element 負責單一元素的序列化與取值,Form.Element.Serializers 則針對 input、textarea、select 等不同標籤定義序列化規則。$F 是 Form.Element.getValue 的快捷引用。
Abstract.TimedObserver 套用 Observer 設計模式來追蹤指定表單元素,當元素值改變時便執行回呼函數,與 onchange 事件的差別在於它以 timeout 控制、且更為物件導向、可動態更換回呼函數,適合用於動態資料校驗或多個關聯下拉選單的連動。Form.Element.Observer 與 Form.Observer 皆繼承自 Abstract.TimedObserver,前者追蹤單一元素,後者追蹤整個表單的序列化結果。
Ajax:prototype 原始碼解讀之 prototype.js(四)
document.getElementsByClassName 根據 class 屬性名稱傳回物件陣列,支援 multiple class。Element 則像一個工具類別,主要用來 toggle(切換顯示)、hide(隱藏)、show(顯示)、remove(移除)物件,以及取得物件的簡單屬性如 getHeight。Toggle 是為 Element.toggle 做的符號連接,出於相容性考慮。
Abstract.Insertion 是動態插入內容的實作,MS 的 JScript 中物件有 insertAdjacentHTML 方法,這裡算是物件形式的封裝。它定義了名為 initializeRange 的抽象方法與 insertContent 抽象方法,並派生出四個子類別:Insertion.Before、Insertion.Top、Insertion.Bottom、Insertion.After,分別對應 beforeBegin、afterBegin、beforeEnd、afterEnd 四種插入位置,各自實作 initializeRange 與 insertContent。prototype 加深了我的體會:撰寫 JS 時該如何遵循 DRY(Don't Repeat Yourself)原則。