node js async 모듈 사용하기

Node 는 기본적으로 비동기식으로 작동을 합니다. 즉  1 2 3 4 5 순서로 코딩을 했어도 반드시 1 2 3 4 5 의 순서로 실행을 하진 않는 다는 얘기입니다. 서버쪽에서는 비동기식으로 작동하는 것이 더 효율적인 상황이 많지만 반드시 순차적으로 작동해야할 프로세스도 있기 마련입니다. 제가 작업했던 과정 중 그러한 과정이 있어서 async라는 모듈에서 waterfall을 사용한 경험 및 코드를 써보고자 합니다. 일단 제 과정은 이렇습니다.

웹 상에서 컴파일이 가능한 에디터를 구현하였는데 과정을 보시면 아시겠지만 작성되지도 않은 파일을 컴파일 할 수도 없을 것이고 컴파일이 안된 파일을 실행하는 것도 당연히 불가능 할 것입니다. 그래서 위와 같은 과정은 동기적으로 이루어져야하는 과정이기 때문에 그냥 순차적인 코드 혹은 함수 형태로 짜면 안되고 콜백형식을 이용하는 동기적인 형태로 작성해야 했습니다.

전체적인 코드입니다.

let fs = require('fs');
let spawn = require('child_process').spawn;
let cp = require('child_process');
let exec = require('child_process').exec;
let models = require('../models');
let async = require('async');
function compileFunction(lan,path,source,res){
	let file, compile,run,responseData;
	let tasks = [
		//파일 작성
		function(callback){
			if(lan==='c')
				file = path+'test.c';
			else if(lan==='java')
				file = path+'Test.java';
			else if(lan==='python')
				file = path+'test.py';
			fs.writeFile(file,source,'utf-8',err=>{if(err) throw err;});
			callback(null,file);
		},
		//작성된 파일을 컴파일
		function(file,callback){
			if(lan==='c'){
				compile = exec('gcc test.c',{cwd:'sources'},(err,stdout,stderr)=>{
					if(stderr.length===0){
						let run = spawn('./sources/./a.out',[]);
						run.stdout.on('data',stdout=>{
							callback(null,stdout.toString('utf8'));
						})
					}		
					else
						callback(true,stderr)
				})
			}
			else if(lan==='java'){
				compile = exec('javac Test.java',{cwd:'sources'},(err,stdout,stderr)=>{
					if(stderr.length===0) {
						let run = exec("java Test",{cwd:'sources'},(err,stdout,stderr)=>{
							callback(null,stdout);
						});
					}
					else
						callback(true,stderr)
				})
			}
			else if(lan==='python'){
				compile = exec('python3 test.py',{cwd:'sources'},(err,stdout,stderr)=>{
					if(stderr.length===0) {
						callback(null,stdout)
					}
					else 
						callback(true,stderr)
				})
			}
		},
		//컴파일 후 나온 결과를 반환
		function(stdout,callback){
			callback(null,stdout)
		}
	]
	async.waterfall(tasks,(err,msg)=>{
		if(err){
			responseData = {'result':'err','output':msg};
			res.json(responseData);
		}
		else{
			responseData = {'result':'ok','output':msg};
			res.json(responseData);
			console.log('done');
		}
	});
}
exports.compileFunction = compileFunction;

제대로 실행되는 것만 확인하고 아직 다듬지는 않은 상태여서 코드가 지저분한 상태입니다. waterfall이라는게 말 그대로 폭포수의  형태를 띈다고 해서 붙여진 이름인데 function이 마치 폭포수처럼 나열되며, 전단계 함수의 결과를 다음 단계의 변수값으로 사용  가능한 callback 형태를 띄고 있습니다. 사용자 모듈형태로 쓰기위해서 따로 분리시켜 놓은 js 파일이기때문에 매개변수도  이미 app.js 파일에서 넘어온 상태인데 그런건 제쳐두고 동작 과정만 설명해보겠습니다.

let tasks = [
        //파일 작성
        function(callback){
            if(lan==='c')
                file = path+'test.c';
            else if(lan==='java')
                file = path+'Test.java';
            else if(lan==='python')
                file = path+'test.py';
            fs.writeFile(file,source,'utf-8',err=>{if(err) throw err;});
            callback(null,file);
        },
        //작성된 파일을 컴파일
        function(file,callback){
            if(lan==='c'){
                compile = exec('gcc test.c',{cwd:'sources'},(err,stdout,stderr)=>{
                    if(stderr.length===0){
                        let run = spawn('./sources/./a.out',[]);
                        run.stdout.on('data',stdout=>{
                            callback(null,stdout.toString('utf8'));
                        })
                    }       
                    else
                        callback(true,stderr)
                })
            }
            else if(lan==='java'){
                compile = exec('javac Test.java',{cwd:'sources'},(err,stdout,stderr)=>{
                    if(stderr.length===0) {
                        let run = exec("java Test",{cwd:'sources'},(err,stdout,stderr)=>{
                            callback(null,stdout);
                        });
                    }
                    else
                        callback(true,stderr)
                })
            }
            else if(lan==='python'){
                compile = exec('python3 test.py',{cwd:'sources'},(err,stdout,stderr)=>{
                    if(stderr.length===0) {
                        callback(null,stdout)
                    }
                    else
                        callback(true,stderr)
                })
            }
        },
        //컴파일 후 나온 결과를 반환
        function(stdout,callback){
            callback(null,stdout)
        }
    ]

=> 동기적으로 작동해야할 function들을 배열형태로 작성해준 것입니다. 아까 위에서도 흐름도를 첨부하였는데 거기에 약간의 설명을 더해보겠습니다.

저 빨간색 요구사항들이 callback 함수의 매개변수로 들어갈 값들입니다. 파일을 전달해줘야 컴파일을 할테고 실행파일이 있어야  실행을 하겠죠 굉장히 단순한 이치입니다. 항상 함수의 끝에 callback(null, 전달할 변수) 의 형태로 호출을 하는 것을 볼 수 있습니다. 근데 null은 도대체 왜 들어가는건가 궁금해서 저도 찾아 봤습니다.

구글 번역기의 도움으로 번역을 해보니

--------------------google 번역-------------------------

일반적으로 노드에서 콜백의 첫 번째 인수는 일반적으로 오류를 나타내는 데 사용됩니다. 그것이 null이 아닌 다른 것이라면, 어떤 이유로 든 작업이 실패했습니다. 아마도 호출 수신자가 복구 할 수 없지만 호출자가 복구 할 수있는 것일 수 있습니다. 첫 번째 인수 이후의 다른 인수는 연산의 반환 값으로 사용됩니다 (성공한 메시지, 검색 등).

---------------------------------------------------------

라고 해석이 나옵니다. 분위기상 마치 관습적으로 그렇게 쓰인다 라는 뉘앙스를 보이는걸 보니 다른 언어에서는 아닐 수도 있겠지만 node에서는 관습적으로 그렇게 쓰나보다 하고 일단 넘어가겠습니다. 즉 우리가 신경써야할 인수는 첫 번째 인수 이후라는 것입니다.

아무튼 배열형태로 여러개의 함수를 모두 작성했다 치면 동기식으로 작동시키는 방법은 간단합니다.

async.waterfall(tasks,(err,msg)=>{
		if(err){
			responseData = {'result':'err','output':msg};
			res.json(responseData);
		}
		else{
			responseData = {'result':'ok','output':msg};
			res.json(responseData);
			console.log('done');
		}
	});

async의 waterfall을 이용하여 매개변수로 작성한 함수의 배열과 콜백함수를 이용하여 제대로 실행이 됐는지 확인할 수 있습니다. 아니면 각 함수의 단계마다 log를 찍어서 내가 생각한 순서대로 실행되고 있는지 확인하셔도 됩니다.