Async.js解決Node.js操作MySQL的回撥大坑
由於JavaScript語言非同步特性,在使用Node.js執行很多操作時都會使用到回撥函式,其中就包括訪問資料庫。如果程式碼中的業務邏輯稍微複雜一點,回撥一層層巢狀,那麼程式碼很容易進入Callback Hell,無論對寫程式碼的人還是閱讀程式碼的人,都是精神上的折磨。
例如對MySQL的一個事務操作,插入一條posts並插入一條log:
var title = 'It is a new post';
connection.beginTransaction(function(err) {
if (err) { throw err; }
connection.query('INSERT INTO posts SET title=?' , title, function(err, result) {
if (err) {
return connection.rollback(function() {
throw err;
});
}
var log = 'Post ' + result.insertId + ' added';
connection.query('INSERT INTO log SET data=?', log, function(err, result) {
if (err) {
return connection.rollback(function () {
throw err;
});
}
connection.commit(function(err) {
if (err) {
return connection.rollback(function() {
throw err;
});
}
console.log('success!');
});
});
});
});
以上非常簡單的一個業務邏輯,已經回調了好幾層了,如果稍微再複雜一點,那麼程式碼恐怕就無法直視了。
為了防止發生多層巢狀回撥的大坑,可以使用Async.js來解決這個問題。下面來介紹Async.js結合操作MySQL資料庫的使用。
async.each批量Insert
假設需求是向log表中插入多條資料,最終返回執行結果,可以使用async.each函式:
var sqls = [
"INSERT INTO log SET data='data1'",
"INSERT INTO log SET data='data2'",
"INSERT INTO log SET data='data3'"
];
async.each(sqls, function(item, callback) {
// 遍歷每條SQL並執行
connection.query(item, function(err, results) {
if(err) {
// 異常後呼叫callback並傳入err
callback(err);
} else {
console.log(item + "執行成功");
// 執行完成後也要呼叫callback,不需要引數
callback();
}
});
}, function(err) {
// 所有SQL執行完成後回撥
if(err) {
console.log(err);
} else {
console.log("SQL全部執行成功");
}
});
async.each並不能保證執行成功一條SQL語句後再去執行下一條,所以如果有一條執行失敗,不會影響到其他語句的執行。
async.eachSeries按順序批量Insert
如果想要實現執行成功上一條語句後再開始執行陣列中下一條語句,可以使用eachSeries函式:
var sqls = [
"INSERT INTO log SET data='data1'",
"INSERT INTO log SET data='data2'",
"INSERT INTO log SET data='data3'"
];
async.eachSeries(sqls, function(item, callback) {
// 遍歷每條SQL並執行
connection.query(item, function(err, results) {
if(err) {
// 異常後呼叫callback並傳入err
callback(err);
} else {
console.log(item + "執行成功");
// 執行完成後也要呼叫callback,不需要引數
callback();
}
});
}, function(err) {
// 所有SQL執行完成後回撥
if(err) {
console.log(err);
} else {
console.log("SQL全部執行成功");
}
});
async.eachSeries保證了SQL的執行順序,而且當其中一條執行異常,就不會繼續執行下一條。
async.forEachOf獲取多條Select語句的查詢結果
async.forEachOf類似於async.each,區別是可以接收Object型別引數,並且會在第二個引數回撥函式中傳入遍歷到的每一項的key,更適合批量執行查詢語句並返回結果:
var sqls = {
table_a: "select count(*) from table_a",
table_b: "select count(*) from table_b",
table_c: "select count(*) from table_c"
};
// 用於存放查詢結果
var counts = {};
async.forEachOf(sqls, function(value, key, callback) {
// 遍歷每條SQL並執行
connection.query(value, function(err, results) {
if(err) {
callback(err);
} else {
counts[key] = results[0]['count(*)'];
callback();
}
});
}, function(err) {
// 所有SQL執行完成後回撥
if(err) {
console.log(err);
} else {
console.log(counts);
}
});
執行結果:
{ table_a: 26, table_b: 3, table_c: 2 }
async.map簡化獲取多條Select語句的查詢結果
上面的async.forEachOf獲取多條Select語句的查詢結果的程式碼可以使用async.map函式簡化成這樣:
var sqls = {
table_a: "select count(*) from table_a",
table_b: "select count(*) from table_b",
table_c: "select count(*) from table_c"
};
async.map(sqls, function(item, callback) {
connection.query(item, function(err, results) {
callback(err, results[0]['count(*)']);
});
}, function(err, results) {
if(err) {
console.log(err);
} else {
console.log(results);
}
});
執行結果:
{ table_a: 26, table_b: 3, table_c: 2 }
async.series按順序執行多條任務
Async.js非常實用的一個功能就是流程控制。回到本文剛開始的那個開啟事務執行Insert的例子,每一步都需要上一步執行成功後才能執行,很容易掉進回撥大坑中。下面實用async.series函式來優化流程控制,讓程式碼更優雅:
var title = 'It is a new post';
// 用於在posts插入成功後儲存自動生成的ID
var postId = null;
// function陣列,需要執行的任務列表,每個function都有一個引數callback函式並且要呼叫
var tasks = [function(callback) {
// 開啟事務
connection.beginTransaction(function(err) {
callback(err);
});
}, function(callback) {
// 插入posts
connection.query('INSERT INTO posts SET title=?', title, function(err, result) {
postId = result.insertId;
callback(err);
});
}, function(callback) {
// 插入log
var log = 'Post ' + postId + ' added';
connection.query('INSERT INTO log SET data=?', log, function(err, result) {
callback(err);
});
}, function(callback) {
// 提交事務
connection.commit(function(err) {
callback(err);
});
}];
async.series(tasks, function(err, results) {
if(err) {
console.log(err);
connection.rollback(); // 發生錯誤事務回滾
}
connection.end();
});
async.waterfall按順序執行多條任務並且下一條任務可獲取上一條任務的執行結果
上面使用async.series按順序執行多條任務,但是很多情況下執行一個任務的時候需要用到上一條任務的相關資料,例如插入一條資料到posts表後,會自動生成ID,下一步插入日誌會用到這個ID,如果使用async.series函式就需要定義一個變數var postId
來儲存這個ID,此時可使用async.waterfall來替代async.series。
var title = 'It is a new post';
var tasks = [function(callback) {
connection.beginTransaction(function(err) {
callback(err);
});
}, function(callback) {
connection.query('INSERT INTO posts SET title=?', title, function(err, result) {
callback(err, result.insertId); // 生成的ID會傳給下一個任務
});
}, function(insertId, callback) {
// 接收到上一條任務生成的ID
var log = 'Post ' + insertId + ' added';
connection.query('INSERT INTO log SET data=?', log, function(err, result) {
callback(err);
});
}, function(callback) {
connection.commit(function(err) {
callback(err);
});
}];
async.waterfall(tasks, function(err, results) {
if(err) {
console.log(err);
connection.rollback(); // 發生錯誤事務回滾
}
connection.end();
});
async.series獲取多條SQL的結果
// tasks是一個Object
var tasks = {
table_a: function(callback) {
connection.query('select count(*) from table_a', function(err, result) {
callback(err, result[0]['count(*)']); // 將結果傳入callback
});
},
table_b: function(callback) {
connection.query('select count(*) from table_b', function(err, result) {
callback(err, result[0]['count(*)']);
});
},
table_c: function(callback) {
connection.query('select count(*) from table_c', function (err, result) {
callback(err, result[0]['count(*)']);
});
}
};
async.series(tasks, function(err, results) {
if(err) {
console.log(err);
} else {
console.log(results);
}
connection.end();
});
執行結果:
{ table_a: 26, table_b: 3, table_c: 2 }
以上是Async.js操作資料庫經常會用到的一些例子,用上它的話就不再需要擔心非同步回撥的坑了。Async.js不僅僅可以用於資料庫操作,其他用到非同步回撥函式的地方都可以使用,例如檔案讀寫等,本文只是通過資料庫操作為例來介紹Async.js基本用法,它同樣也可以運用到其他需要它的地方。除了上面介紹的幾個函式外,Async.js還提供了一些其他實用的函式,可以參考文件靈活使用。