非同步流程最麻煩的地方是「等全部都做完,再彙整結果」。手写回呼很容易變成又深又醜的巢狀結構,Async.js 就是為了整理這種場景而生。
// Asyncjs/seriesByHand.js
var fs = require('fs');
process.chdir('recipes'); // 改變工作目錄
var concatenation = '';
fs.readdir('.', function (err, filenames) {
if (err) throw err;
function readFileAt(i) {
var filename = filenames[i];
fs.stat(filename, function (err, stats) {
if (err) throw err;
if (!stats.isFile()) return readFileAt(i + 1); // 不是檔案就跳下一個
fs.readFile(filename, 'utf8', function (err, text) {
if (err) throw err;
concatenation += text;
if (i + 1 === filenames.length) {
return console.log(concatenation); // 全部讀完才輸出
}
readFileAt(i + 1); // 遞迴讀下一個
});
});
}
readFileAt(0);
});
如你所見,非同步版本比同步版本長得多。若用 filter 與 forEach 這些同步迭代器,程式碼大約只有一半長,而且好讀太多。要是這些迭代器有非同步版本就好了——Async.js 正好提供了。
它給了兩組選擇:
async.filter / async.forEach:並行處理陣列。async.filterSeries / async.forEachSeries:順序處理陣列。並行看起來比較快,為什麼還要用序列式?有兩個理由:
// Asyncjs/forEachSeries.js
var async = require('async');
var fs = require('fs');
process.chdir('recipes');
var concatenation = '';
var dirContents = fs.readdirSync('.');
async.filter(dirContents, isFilename, function (filenames) {
async.forEachSeries(filenames, readAndConcat, onComplete);
});
function isFilename(filename, callback) {
fs.stat(filename, function (err, stats) {
if (err) throw err;
callback(stats.isFile());
});
}
function readAndConcat(filename, callback) {
fs.readFile(filename, 'utf8', function (err, fileContents) {
if (err) return callback(err);
concatenation += fileContents;
callback();
});
}
function onComplete(err) {
if (err) throw err;
console.log(concatenation);
}
現在程式碼漂亮地分成兩塊:任務概貌(兩個 async 呼叫)與實作細節(兩個迭代器函式加一個完工回呼)。意圖一目了然。
除了 filter 與 forEach,Async.js 也提供:
reject / rejectSeries:與 filter 相反。map / mapSeries:一對一變換。reduce / reduceRight:逐值累積變換。detect / detectSeries:找出第一個符合條件的項目。sortBy:產生有序副本。some:測試是否至少有一個符合條件。every:測試是否全部符合條件。這些方法讓你能以最低的程式碼重複度完成常見的迭代工作。
要特別注意:因為 fs.exists 當年首開「回呼不含 err 參數」的先例,Async.js 那些會回傳布林值的資料收集方法(filter、reject、detect、some、every 等)的迭代器無法回報錯誤。
而對其他所有非布林型的方法,約定是:只要把非 null/undefined 的值當作迭代器回呼的第一個參數傳入,就會立即以該錯誤呼叫完工回呼。這正是 readAndConcat 不必 throw 也能運作的原因:
function readAndConcat(filename, callback) {
fs.readFile(filename, 'utf8', function (err, fileContents) {
if (err) return callback(err); // err 會一路傳到 onComplete
concatenation += fileContents;
callback();
});
}
function onComplete(err) {
if (err) throw err; // 只會被呼叫一次
console.log(concatenation);
}
Async.js 保證 onComplete 只會被呼叫一次——無論是因為首次出錯,還是因為全部成功完成。
前面手寫版本裡直接 throw err,其實違反了「不要從回呼中拋出例外」的原則,尤其在正式環境中。但對於這麼簡單的範例完全沒問題:真出錯時 throw 會中止程式並給出完整的堆疊追蹤,反而最好除錯。
真正不妥的是同樣的 if (err) throw err 重複了三次。Async.js 的價值之一,就是把這種重複收斂掉。
Async.js 的榮光期在 Node 0.x 到 4.x 之間。現在請直接用 async/await,同樣的邏輯會短得多:
const fs = require('fs/promises');
async function concatFiles(dir) {
const names = await fs.readdir(dir);
const files = (await Promise.all(
names.map(n => fs.stat(`${dir}/${n}`))
)).filter((st, i) => st.isFile())
.map((_, i) => names[i]);
let result = '';
for (const f of files) { // 順序讀取,避免 fd 上限
result += await fs.readFile(`${dir}/${f}`, 'utf8');
}
return result;
}
錯誤用 try/catch 處理即可,不再需要把 err 當參數一路傳遞。Async.js 的觀念——「把流程與細節分離」、「明確選擇並行或序列」——在 async/await 裡同樣適用,只是語法親切了許多。