Node.js 傳統的 callback 風格在巢狀一多就容易失控,Promise 則把「下一步做什麼」串成一條線。q.js 是早期相當流行的 Promise 實作,提供了幾種把標準 Node 風格 API 包成 Promise 的方法。
npm install q
相對於 Q.fcall(呼叫一般函式),Q.nfcall 專門用來呼叫 Node 風格的函式——也就是最後一個參數是 callback 的那種。
var FS = require('fs'),
Q = require('q'),
colors = require('colors'),
file = 'example.txt';
var fsReadFile = Q.nfcall(FS.readFile, file, encoding);
fsReadFile.then(function(result){
console.log(("invoke in nfcall " + file).red);
console.log(result.green);
}, function(error){
console.log("invoke in nfcall".red);
console.log(error.toString().red);
});
如果同一個 API 要呼叫很多次,先用 denodeify 轉一次,之後就能當普通函式使用,省去重複包裝。
var fsReadFile_denodeify = Q.denodeify(FS.readFile);
fsReadFile_denodeify(file, encoding).then(function(result){
console.log("invoke in denodeify".red);
console.log(result.green);
}, function(error){
console.log("invoke in denodeify".red);
console.log(error.toString().red);
});
需要更細緻的控制時,可以手動建立 deferred 物件,自行決定何時 resolve 或 reject。
var fsReadFile_deferd = function(file, encoding){
var deferred = Q.defer();
FS.readFile(file, encoding, function(error, result){
if (error) {
deferred.reject(error.toString().red);
return;
}
deferred.resolve(result);
});
return deferred.promise;
};
fsReadFile_deferd(file).then(function(result){
console.log("invoke in deferd".red);
console.log(result.toString().green);
}, function(error){
console.log("invoke in deferd".red);
console.log(error.toString().red);
});
這裡我加了一個 return:原範例在 reject 之後沒有中斷,會繼續執行到 resolve,而 Promise 一旦定型就無法改變,第二個呼叫只會被安靜忽略。實務上一定要補上 return,或使用 else 分流。
這是 defer 的簡寫版本,q.js 直接提供一個符合 Node callback 簽名的解析器,程式碼短很多。
var fsReadFile_makeNodeResolver = function(file, encoding){
var deferred = Q.defer();
FS.readFile(file, encoding, deferred.makeNodeResolver());
return deferred.promise;
};
fsReadFile_makeNodeResolver(file, encoding).then(function(result){
console.log("invoke in makeNodeResolver".red);
console.log(result.green);
}, function(error){
console.log(error.toString().red);
});
一次性的呼叫用 Q.nfcall 最省事;同一個 API 重複使用時先 denodeify 包裝成函式;需要自訂流程時才動用 defer,而 makeNodeResolver() 則是 defer 的懶人寫法。今天的 Node.js 已內建 Promise 與 util.promisify,並有 async/await 可用,上面這些概念仍然適用,只是工具換成了標準 API。