JavaScript異步編程的Promise模式
異步模式在web編程中變得越來越重要,對于web主流語言Javascript來說,這種模式實現起來不是很利索,為此,許多 Javascript庫(比如 jQuery和Dojo)添加了一種稱為promise的抽象(有時也稱之為deferred)。通過這些庫,開發人員能夠在實際編程中使用 promise模式。IE官方博客最近發表了一篇文章,詳細講述了如何使用XMLHttpRequest2來實踐promise模式。我們來了解一下相關的概念和應用。
考慮這樣一個例子,某網頁存在異步操作(通過XMLHttpRequest2或者 Web Workers)。隨著Web 2.0技術的深入,瀏覽器端承受了越來越多的計算壓力,所以“并發”具有積極的意義。對于開發人員來說,既要保持頁面與用戶的交互不受影響,又要協調頁面與異步任務的關系,這種非線性執行的編程要求存在適應的困難。先拋開頁面交互不談,我們能夠想到對于異步調用需要處理兩種結果——成功操作和失敗處理。在成功的調用后,我們可能需要把返回的結果用在另一個Ajax請求中,這就會出現“函數連環套”的情況(在筆者的另一篇文章《NodeJS的異步編程風格》中有詳細的解釋)。這種情況會造成編程的復雜性。看看下面的代碼示例(基于XMLHttpRequest2):
function search推ter(term, onload, onerror) {
var xhr, results, url;
url = 'http://search.推ter.com/search.json?rpp=100&q=' + term;
xhr = new XMLHttpRequest();
xhr.open('GET', url, true);
xhr.onload = function (e) {
if (this.status === 200) {
results = JSON.parse(this.responseText);
onload(results);
}
};
xhr.onerror = function (e) {
onerror(e);
};
xhr.send();
}
function handleError(error) {
/ handle the error /
}
function concatResults() {
/ order tweets by date /
}
function loadTweets() {
var container = document.getElementById('container');
search推ter('#IE10', function (data1) {
search推ter('#IE9', function (data2) {
/ Reshuffle due to date /
var totalResults = concatResults(data1.results, data2.results);
totalResults.forEach(function (tweet) {
var el = document.createElement('li');
el.innerText = tweet.text;
container.appendChild(el);
});
}, handleError);
}, handleError);
}</pre>
上面的代碼其功能是獲取推ter中hashtag為IE10和IE9的內容并在頁面中顯示出來。這種嵌套的回調函數難以理解,開發人員需要仔細分析哪些代碼用于應用的業務邏輯,而哪些代碼處理異步函數調用的,代碼結構支離破碎。錯誤處理也分解了,我們需要在各個地方檢測錯誤的發生并作出相應的處理。
為了降低異步編程的復雜性,開發人員一直尋找簡便的方法來處理異步操作。其中一種處理模式稱為promise,它代表了一種可能會長時間運行而且不一定必須完整的操作的結果。這種模式不會阻塞和等待長時間的操作完成,而是返回一個代表了承諾的(promised)結果的對象。
考慮這樣一個例子,頁面代碼需要訪問第三方的API,網絡延遲可能會造成響應時間較長,在這種情況下,采用異步編程不會影響整個頁面與用戶的交互。promise模式通常會實現一種稱為then的方法,用來注冊狀態變化時對應的回調函數。比如下面的代碼示例:
search推ter(term).then(filterResults).then(displayResults);
promise模式在任何時刻都處于以下三種狀態之一:未完成(unfulfilled)、已完成(resolved)和拒絕(rejected)。以CommonJS Promise/A 標準為例,promise對象上的then方法負責添加針對已完成和拒絕狀態下的處理函數。then方法會返回另一個promise對象,以便于形成 promise管道,這種返回promise對象的方式能夠支持開發人員把異步操作串聯起來,如then(resolvedHandler, rejectedHandler); 。resolvedHandler 回調函數在promise對象進入完成狀態時會觸發,并傳遞結果;rejectedHandler函數會在拒絕狀態下調用。
有了promise模式,我們可以重新實現上面的推ter示例。為了更好的理解實現方法,我們嘗試著從零開始構建一個promise模式的框架。首先需要一些對象來存儲promise。
var Promise = function () {
/* initialize promise */
}; 接下來,定義then方法,接受兩個參數用于處理完成和拒絕狀態。
Promise.prototype.then = function (onResolved, onRejected) {
/* invoke handlers based upon state transition */
}; 同時還需要兩個方法來執行理從未完成到已完成和從未完成到拒絕的狀態轉變。
Promise.prototype.resolve = function (value) {
/ move from unfulfilled to resolved /
};
Promise.prototype.reject = function (error) {
/ move from unfulfilled to rejected /
};</pre>
現在搭建了一個promise的架子,我們可以繼續上面的示例,假設只獲取IE10的內容。創建一個方法來發送Ajax請求并將其封裝在 promise中。這個promise對象分別在xhr.onload和xhr.onerror中指定了完成和拒絕狀態的轉變過程,請注意 search推ter函數返回的正是promise對象。然后,在loadTweets中,使用then方法設置完成和拒絕狀態對應的回調函數。
function search推ter(term) {
var url, xhr, results, promise;
url = 'http://search.推ter.com/search.json?rpp=100&q=' + term;
promise = new Promise();
xhr = new XMLHttpRequest();
xhr.open('GET', url, true);
xhr.onload = function (e) {
if (this.status === 200) {
results = JSON.parse(this.responseText);
promise.resolve(results);
}
};
xhr.onerror = function (e) {
promise.reject(e);
};
xhr.send();
return promise;
}
function loadTweets() {
var container = document.getElementById('container');
search推ter('#IE10').then(function (data) {
data.results.forEach(function (tweet) {
var el = document.createElement('li');
el.innerText = tweet.text;
container.appendChild(el);
});
}, handleError);
}</pre>
到目前為止,我們可以把promise模式應用于單個Ajax請求,似乎還體現不出promise的優勢來。下面來看看多個Ajax請求的并發協作。此時,我們需要另一個方法when來存儲準備調用的promise對象。一旦某個promise從未完成狀態轉化為完成或者拒絕狀態,then方法里對應的處理函數就會被調用。when方法在需要等待所有操作都完成的時候至關重要。
Promise.when = function () {
/* handle promises arguments and queue each */
}; 以剛才獲取IE10和IE9兩塊內容的場景為例,我們可以這樣來寫代碼:
var container, promise1, promise2;
container = document.getElementById('container');
promise1 = search推ter('#IE10');
promise2 = search推ter('#IE9');
Promise.when(promise1, promise2).then(function (data1, data2) {
/ Reshuffle due to date /
var totalResults = concatResults(data1.results, data2.results);
totalResults.forEach(function (tweet) {
var el = document.createElement('li');
el.innerText = tweet.text;
container.appendChild(el);
});
}, handleError);</pre>
分析上面的代碼可知,when函數會等待兩個promise對象的狀態發生變化再做具體的處理。在實際的Promise庫中,when函數有很多變種,比如 when.some()、when.all()、when.any()等,讀者從函數名字中大概能猜出幾分意思來,詳細的說明可以參考CommonJS的一個promise實現when.js。
除了CommonJS,其他主流的Javascript框架如jQuery、Dojo等都存在自己的promise實現。開發人員應該好好利用這種模式來降低異步編程的復雜性。我們選取Dojo為例,看一看它的實現有什么異同。
Dojo框架里實現promise模式的對象是Deferred,該對象也有then函數用于處理完成和拒絕狀態并支持串聯,同時還有resolve和reject,功能如之前所述。下面的代碼完成了推ter的場景:
function search推ter(term) {
var url, xhr, results, def;
url = 'http://search.推ter.com/search.json?rpp=100&q=' + term;
def = new dojo.Deferred();
xhr = new XMLHttpRequest();
xhr.open('GET', url, true);
xhr.onload = function (e) {
if (this.status === 200) {
results = JSON.parse(this.responseText);
def.resolve(results);
}
};
xhr.onerror = function (e) {
def.reject(e);
};
xhr.send();
return def;
}
dojo.ready(function () {
var container = dojo.byId('container');
search推ter('#IE10').then(function (data) {
data.results.forEach(function (tweet) {
dojo.create('li', {
innerHTML: tweet.text
}, container);
});
});
});</pre>
不僅如此,類似dojo.xhrGet方法返回的即是dojo.Deferred對象,所以無須自己包裝promise模式。
var deferred = dojo.xhrGet({
url: "search.json",
handleAs: "json"
});
deferred.then(function (data) {
/ handle results /
}, function (error) {
/ handle error /
});</pre>
除此之外,Dojo還引入了dojo.DeferredList,支持開發人員同時處理多個dojo.Deferred對象,這其實就是上面所提到的when方法的另一種表現形式。
dojo.require("dojo.DeferredList");
dojo.ready(function () {
var container, def1, def2, defs;
container = dojo.byId('container');
def1 = search推ter('#IE10');
def2 = search推ter('#IE9');
defs = new dojo.DeferredList([def1, def2]);
defs.then(function (data) {
// Handle exceptions
if (!results[0][0] || !results[1][0]) {
dojo.create("li", {
innerHTML: 'an error occurred'
}, container);
return;
}
var totalResults = concatResults(data[0][1].results, data[1][1].results);
totalResults.forEach(function (tweet) {
dojo.create("li", {
innerHTML: tweet.text
}, container);
});
});
});</pre>
上面的代碼比較清楚,不再詳述。
說到這里,讀者可能已經對promise模式有了一個比較完整的了解,異步編程會變得越來越重要,在這種情況下,我們需要找到辦法來降低復雜度,promise模式就是一個很好的例子,它的風格比較人性化,而且主流的JS框架提供了自己的實現。所以在編程實踐中,開發人員應該嘗試這種便捷的編程技巧。需要注意的是,promise模式的使用需要恰當地設置promise對象,在對應的事件中調用狀態轉換函數,并且在最后返回promise對象。
技術社區對異步編程的關注也在升溫,國內社區也發出了自己的聲音。資深技術專家老趙就發布了一套開源的異步開發輔助庫Jscex,它的設計很巧妙,拋棄了回調函數的編程方式,采用一種“線性編碼、異步執行”的思想,感興趣的讀者可以查看這里。
不僅僅是前端的JS庫,如今火熱的NodeJS平臺也出現了許多第三方的promise模塊,具體的清單可以訪問這里。
來源:InfoQ - 崔康