先看一個具體的業務場景:給定一個 RSS 位址,把它抓回來存成檔案。而這個位址本身,也存在一個檔案裡。
拆成任務就是三步:從檔案讀出 RSS 位址、抓取該 RSS、把內容寫進檔案,最後把三步串起來。
準備工作:建立 address.txt,裡面放一行位址。
https://programmer.csdn.net/rss_programmer.html
任務一,讀位址並用 callback 回傳:
var getRssAddress = function(path, callback) {
fs.readFile(path, {encoding: 'utf8'}, function (err, data) {
callback(err, data);
});
}
任務二,抓 RSS:
var getRss = function(url, callback) {
var data = '';
http.get(url, function(res) {
res.on('data', function(chrunk) {
data += chrunk;
});
res.on('end', function() {
callback(null, data);
});
}).on('error', function(err) {
callback(err, null);
});
}
任務三,寫檔:
var saveRss = function(data, callback) {
fs.writeFile('rss.txt', data, 'utf8', function(err) {
callback(err);
});
}
串起來:
getRssAddress('address.txt', function(err, data) {
if(err) {
console.log(err);
return;
}
getRss(data, function(err, data) {
if(err) {
console.log(err);
return;
}
saveRss(data, function(err) {
if(err) console.log(err);
});
});
});
這是全非同步的正統寫法,好處是夠標準、人人看得懂;壞處是耦合太緊、錯誤處理瑣碎、可讀性差。任務一多、邏輯一複雜,層層遞進的 callback 馬上讓人眼花,後續維護更是痛苦。
Promise/A 規範的實作之一 when.js,正是為這個問題域而生的。
任務一:
var getRssAddress = function(path) {
var deferred = when.defer();
fs.readFile(path, {encoding: 'utf8'}, function (err, data) {
if (err) deferred.reject(err);
deferred.resolve(data);
});
return deferred.promise;
}
任務二:
var getRss = function(url) {
var deferred = when.defer();
var data = '';
http.get(url, function(res) {
res.on('data', function(chrunk) {
data += chrunk;
});
res.on('end', function() {
deferred.resolve(data);
});
}).on('error', function(err) {
deferred.reject(err);
});
return deferred.promise;
}
任務三:
var saveRss = function(data) {
var deferred = when.defer();
fs.writeFile('rss.txt', data, 'utf8', function(err) {
if(err) deferred.reject(err);
deferred.resolve();
});
return deferred.promise;
}
串起來:
getRssAddress('address.txt')
.then(getRss)
.then(saveRss)
.catch(function(err) {
console.log(err);
});
對比之下,主流程乾淨得像同步程式碼,每個任務只關心自己那件事。
Promises/A 定義的 Deferred/Promise,本質就是「發布/訂閱」模型:用 Deferred 發布事件(完成 resolve,或失敗 reject),用 Promise 訂閱對應的完成或失敗。
每個任務有三種狀態:pending(預設)、fulfilled(完成)、rejected(失敗)。轉移規則如下:
1. pending 可單向轉為 fulfilled,這叫 resolve,對應 deferred.resolve(promiseOrValue)。
2. pending 也可單向轉為 rejected,這叫 reject,對應 deferred.reject(reason)。
3. 處於 pending 時,還能用 deferred.notify(update) 發布執行中的資訊,例如進度。
4. 轉移是一次性的。一旦離開 pending,就再也回不去,並進入下一個環節。
對照上面的程式碼:用 when.defer() 建立 deferred 物件;資料取回後呼叫 deferred.resolve(data) 發布完成事件;失敗則 deferred.reject(err);最後 return deferred.promise 把它作為訂閱用的憑證。
訂閱靠 Promise 的 then:
getRssAddress('address.txt')
.then(getRss)
then 有三個參數,分別是 onFulfilled、onRejected、onProgress:
promise.then(onFulfilled, onRejected, onProgress)
上一個任務被 resolve(data),onFulfilled 觸發並收到 data;被 reject(reason),則 onRejected 觸發並收到 reason。兩者永遠只會有一個被觸發,而且只觸發一次。
when.js 的 then 會把錯誤往下傳。多任務串行時,你只需要在最後一個 then 定義 onRejected,或者直接在尾端接 catch,就能攔下任何一個環節拋出的異常:
getRssAddress('address.txt')
.then(getRss)
.then(saveRss)
.catch(function(err) {
console.log(err);
});
不需要每個 callback 都寫 if (err)。
Promise 對異步編程的價值就在這裡:讓你能專注在單一任務的實作,而不必陷進金字塔。以上是基礎用法,when.js 實際提供的能力遠多於此,細節請查官方 API。