[async.js] 막강한 flow 제어 - async.waterfall, async.series, async.parallel, async.auto

async.js는 callback이 너무 많아지는 javascript의 문제점을 해결할 수 있는 package이다. async.js를 사용하면 javascript asynchronous programming을 훨씬 용이하고 직관적으로 할 수 있다.

Learning node.js 책에 나와 있는 내용을 참고하여 이해를 해보자.

아래의 코드를 보면 javascript 코드에서 asynchronous task가 연속적으로 수행되는 경우 코딩도 쉽지 않고, 이해도 쉽지 않음을 알 수 있다.
<br /> var fs = require('fs');<br /> function load_file_contents(path, callback) {<br /> fs.open (path, 'r', function (err, f) {<br /> if (err) {<br /> callback(err);<br /> return;<br /> } else if (!f) {<br /> callback({ error: "invalid_handle",<br /> message: "bad file handle from fs.open"});<br /> return;<br /> }<br /> fs.fstat (f, function (err, stats) {<br /> if (err) {<br /> callback(err);<br /> return;<br /> }<br /> if ( stats.isFile ()) {<br /> var b = new Buffer(10000);<br /> fs.read (f, b, 0, 10000, null, function (err, br, buf) {<br /> if (err) {<br /> callback(err);<br /> return;<br /> }<br /> fs.close (f, function (err) {<br /> if (err) {<br /> callback(err);<br /> return;<br /> }<br /> callback(null, b.toString('utf8', 0, br));<br /> });<br /> });<br /> } else {<br /> callback({ error: "not_file",<br /> message: "Can't load directory" });<br /> return;<br /> }<br /> });<br /> });<br /> }<br />

async.waterfall
위처럼 asynchronous task가 순차적으로 실행되어야 하는 경우 async.waterfall이 사용된다.

<br /> var fs = require('fs');<br /> var async = require('async');<br /> function load_file_contents(path, callback) {<br /> async.waterfall ([<br /> function (callback) {<br /> fs.open(path, 'r', callback);<br /> },<br /> function (f, callback) { // fs.open function call의 마지막의 callback이 여기로 넘어온다. (이때 그 callback의 argument가 file handle, callback)<br /> fs.fstat(f, function (err, stats) {<br /> if (err)<br /> callback(err); //error발생시 마지막 callback이 호출<br /> else<br /> callback(null, f, stats); //다음 function이 실행되며, 이때 f와 stats가 argument로 passing<br /> });<br /> },<br /> function (f, stats, callback) {<br /> if (stats.isFile()) {<br /> var b = new Buffer(10000);<br /> fs.read(f, b, 0, 10000, null, function (err, br, buf) {<br /> if (err)<br /> callback(err); //error발생시 마지막 callback이 호출<br /> else<br /> callback(null, f, b.toString('utf8', 0, br));// f와 string이 다음 함수로 passing<br /> });<br /> } else {<br /> callback({ error: "not_file",message: "Can't load directory" }); //error발생시 마지막 callback이 호출<br /> }<br /> },<br /> function (f, contents, callback) {<br /> fs.close(f, function (err) {<br /> if (err)<br /> callback(err); //error발생시 마지막 callback이 호출<br /> else<br /> callback(null, contents); //성공시 정상적인 값으로 마지막 callback 호출<br /> });<br /> }<br /> ]<br /> , function (err, file_contents) { //error가 발생하면 즉시 jump하고, 모든 task가 성공하면 마지막에 반드시 실행되는 callback함수<br /> callback(err, file_contents);<br /> });<br /> } <br />

async.series
async.series는 async.waterfall과 유사하면서도 약간 다르다. function의 결과는 다음 function의 argument로 passing되지 않는다. 대신 마지막에 호출되는 callback의 두번째 argument인 array에 추가된다. 즉, 각 function의 결과는 array에 저장되어 마지막 callback에 넘겨진다.
<br /> var async = require("async");<br /> async.series (<br /> {<br /> numbers : function (callback) { //첫번째 실행<br /> setTimeout(function () {<br /> callback(null, [ 1, 2, 3 ]);<br /> }, 1500);<br /> },<br /> strings : function (callback) { //두번째 실행<br /> setTimeout(function () {<br /> callback(null, [ "a", "b", "c" ]);<br /> }, 2000);<br /> }<br /> },<br /> function (err, results) { //마지막에 실행되는 callback 함수<br /> console.log(results);<br /> }<br /> );<br /> <br />
위 코드의 결과는 다음과 같다.

{ numbers: [ 1, 2, 3 ], strings: [ 'a', 'b', 'c' ] }

async.parallel
async.parallel은 위의 async.waterfall이나 async.series와 달리 병렬적으로 실행되는 task의 flow를 제어한다.

아래의 코드를 보면 이해가 쉬울 것이다. 병렬적으로 수행되어야 할 task들이 실행되고, 마지막에 반드시 callback이 실행된다.
<br /> var async = require("async");<br /> async.parallel ({<br /> numbers : function (callback) {<br /> setTimeout(function () {<br /> callback(null, [ 1, 2, 3 ]);<br /> }, 1500);<br /> },<br /> strings : function (callback) {<br /> setTimeout(function () {<br /> callback(null, [ "a", "b", "c" ]);<br /> }, 2000);<br /> } },<br /> function (err, results) {<br /> console.log(results); }<br /> ); <br />

위 코드의 결과는 다음과 같다. (위의 async.series 예제 코드와 같다)

{ numbers: [ 1, 2, 3 ], strings: [ 'a', 'b', 'c' ] }

async.auto
async.auto는 asynchronous flow control을 맘대로 할 수 있는 일종의 끝판왕이다.

병렬, 직렬 처리를 유연하게 할 수 있다는 장점이 있다.
<br /> var async = require("async");<br /> async.auto ({<br /> numbers : function (callback) {<br /> setTimeout(function () {<br /> callback(null, [ 1, 2, 3 ]);<br /> }, 1500);<br /> },<br /> strings : function (callback) {<br /> setTimeout(function () {<br /> callback(null, [ "a", "b", "c" ]);<br /> }, 2000);<br /> },<br /> assemble : [ 'numbers', 'strings', function (callback, thus_far) { //numbers와 strings가 끝나기 전까지는 실행되지 않는다. thus_far는 array로 numbers와 strings를 저장하고 있다. <br /> callback(null, {<br /> numbers: thus_far.numbers.join(", "),<br /> strings: "'" + thus_far.strings.join("', '") + "'"<br /> });<br /> }]<br /> },<br /> //마지막에 호출되는 callback 함수, optional<br /> function (err, results) {<br /> if (err)<br /> console.log(err);<br /> else<br /> console.log(results); }<br /> );<br />
이 코드의 결과는 다음과 같다.

{ numbers: [ 1, 2, 3 ], strings: [ 'a', 'b', 'c' ], assemble: { numbers: '1, 2, 3', strings: '\'a\', \'b\', \'c\'' } }

추가 참고 사이트
https://github.com/caolan/async