빠르게 훝어보는 node.js
#5 - Express 2/2
조대협 (http://bcho.tistory.com
File upload 및 download 처리
Express는 파일 업로드 기능을 제공한다. Express 의 경우, 파일을 tmp directory에 업로드한후, 업로드가 끝나면 이벤트를 주는 형태이다. 그래서, 파일 업로드가 끝나면 파일 저장 디렉토리로 옮겨 줘야 한다. 그러면 간단하게 코드를 살펴보자.
express에서 업로드되는 file stream은 multipart 형태로 업로드가 된다. 이 multi part request stream을 인식하려면, express세팅에 bodyParser 미들웨어를 사용함을 명시해줘야 한다.
var app = express();
app.use(express.bodyParser());
http://expressjs.com/3x/api.html#req.files
다른 미들웨어도 이 bodyParser() 미들웨어를 사용하기 때문에, 다른 미들웨어 선언전에 앞쪽에 선언을 해줘야 한다.
다음으로 file 업로드를 해줄 HTML 파일을 정의하자
<form action="/upload" method="post" enctype="multipart/form-data">
<input type="file" name="myfile" />
<input type="submit" name="upload" />
</form>
HTTP Post 형태로 multipart 형태로 데이터를 보내며, 파일은 “myfile”이라는 폼 이름으로 전송된다. 이를 받는 코드는 아래와 같다.
var fs = require('fs');
exports.upload = function(req, res){
fs.readFile(req.files.myfile.path,function(error,data){
var destination = __dirname + '\\..\\uploaded\\'+ req.files.myfile.name;
fs.writeFile(destination,data,function(error){
if(error){
console.log(error);
throw error;
}else{
res.redirect('back');
}
});
});
};
파일은 req.files.{폼이름}.path에 업로드 된다. 위의 예제는 파일 컴포넌트의 폼명을 “myfile”로 했기 때문에 파일의 경로는 req.files.myfile.path가 되낟. 다음 fs.readFile을 이용해서 업로드된 파일이 tmp 디렉토리에 모두 업로드가 되면 destination 디렉토리로 복사해주는 예제이다.
tmp 디렉토리의 경우 bodyParser 미들웨어 적용시 적용할 수 있다.
조금 더 효율적인 코드를 구성해보면, 파일을 tmp 디렉토리에 써지지는 것을 바로 읽어서 write destination에 쓸 수 있도록 Stream을 이용할 수 있다. tmp에서 읽어서 destination 디렉토리에 쓰는 것은 위의 예제와 똑같지만, 나중에 설명하겠지만 Stream을 사용하면, 파일을 읽을 때, 쓸 수 있는 만큼만 (버퍼크기만큼만) 읽은 후 쓰기 때문에, 훨씬 효율적인 IO를 할 수 있다.
exports.uploadstream = function(req, res){
var destination = __dirname + '\\..\\uploaded\\'+ req.files.myfile.name;
var ws = fs.createWriteStream(destination);
fs.createReadStream(req.files.myfile.path).pipe(ws);
res.redirect('back');
};
아쉬운 점은 Express의 특성상 바로 destination 디렉토리에 write하는 것은 안되고, tmp 디렉토리를 거쳐서 write해야 한다.
JSON REST API
Express는 JSON 기반의 REST API 구현도 지원하는데, Spring/Java를 알고 있는 개발자라면, 아주 짜증이 날(?) 정도로 express를 이용한 REST API 구현은 매우 간단하다. 설명은 생략하고 먼저 코드부터 보자
app.use(express.json());
app.post('/rest',function(request,response){
request.accepts('application/json');
// input message handling
json = request.body;
console.log('name is :'+json.name);
console.log('address is :'+json.address);
// output message
response.json({result:'success'});
});
위의 코드는
{
"name":"Terry",
"address":"seoul"
}
와 같은 JSON 메시지를 받은 후에, 내용을 파싱하고, { ‘result’:’success’} 라는 리턴을 보내는 코드이다. 먼저 exress.json 미들웨어를 적용하고, request.accept 를 application/json 타입으로 해서 JSON request를 받음을 명시한다.
다음으로는 request.body.{JSON 필드명} 을 사용하면 된다. 위의 예의 경우 JSON 필드명이 name과 address이기 때문에 그 값에 대한 경로는 body.name과 body.address가 된다.
Response를 보낼 때에는 위의 예제와 같이 response.json({key:value,…}) 형태로 지정하면 된다. 만약에 HTTP response code를 보내고 싶으면 response,json(HTTP_CODE,{key:value…}) 형태로 지정한다.
예를 들어 response.json(500,{error:’error message’}); 형태로 지정할 수 있다.
또한 response.jsonp 메서드를 이용해서 JSONP 를 지원하는데, JSONP는 간단하게 말하면 Cross Site Scripting을 지원할 수 있는 방법이다. 자세한 설명은
http://beebole.com/blog/general/sandbox-your-cross-domain-jsonp-to-improve-mashup-security/
를 참고하기 바란다.
Connect의 Module pipe line
지금까지 Express의 기능에 대해서 간략하게 살펴보았는데, 에러 처리 방식에 앞서서 Express의 근간이 되는 Connect framework에 대해서 짚고 넘어가고자 한다.
Connect Framework은 Javascript 를 기반으로 한 웹/서버 개발용 프레임웍이다. Javascript 기반의 서버를 만들기 위해서, 개발되었으며, Ruby의 Rack Framework을 기반으로 하였다.
Connect에서는 Middleware라는 개념을 사용하는데, reusable한 컴포넌트를 middleware라고 한다. Request, response 파이프라인상에 middle ware를 넣어서 기능을 추가 및 처리 하는 개념인데, Java의 Servlet Filter나 Servlet Chaining과 같은 개념과 유사하다고 보면 된다. 아래 그림과 같이 request가 들어와서 서버에서 처리되고 reponse로 나가는 형태라고 할 때,
아래 그림과 같이 처리 과정에 middleware를 추가하여 기능을 처리하도록 할 수 있다.
우리가 지금까지 express를 사용하면서 app.use라고 했던것들이 middleware 모듈을 추가하는 기능이었다.
app.use(express.logger('dev'));
app.use(express.json());
app.use(express.urlencoded());
app.use(express.methodOverride());
app.use(express.cookieParser('your secret here'));
app.use(express.session());
app.use(app.router);
app.use(express.static(path.join(__dirname, 'public')));
app.use(function(req,res,next){
console.log('custom log :'+req.path) ;
next();
});
app.post('/upload', upload.fileupload);
위의 코드를 분석해 보면
와 같은 순서로 middleware가 적용된 것이다.
static 파일의 경우 위에서부터 순차적으로 logger 모듈부터 적용이 되다가 express.static 모듈에서 적용후에, static file을 response한 다음에 바로 리턴이 된다.
static 파일이 아닌 경우는 모두 아래 함수를 수행하게 되는데
app.use(function(req,res,next){
console.log('custom log :'+req.path) ;
next();
});
이 Middleware로 넘어오는 parameter는 HTTP request,response 뿐만 아니라 next라는 함수 포인터를 넘겨주는데, 이 middleware를 수행한 다음에 다음 middleware를 실행하기 위한 포인터이다. 위의 예에서는 콘솔에서 로그를 출력한 후에, next()를 호출하여 다음 미들웨어를 호출하도록 하였다.
HTTP/POST /upload request의 경우에는 app.post('/upload', upload.fileupload); 미들웨어에 의해서 처리된다.
이렇게 middleware들은 순차에 의한 chaining 개념을 가지고 있기 때문에, middleware를 use를 이용해서 불러드릴 경우 순서가 매우 중요함을 알 수 있다.
Error Handling
다음으로 Express에서 에러처리에 대해서 알아보자 Express에서 별도의 에러처리를 하지 않으면, 404의 경우 한줄로 없는 페이지라는 메시지가 나오거나 500 에러의 경우 아래와 같이 에러스택이 바로 표시되어 버린다. (보안상의 이유라도 이런식으로 내부 스택이 나오는 것은 좋지 않다.)
그러면 어떻게 에러 처리를 하는지 알아보도록 하자. 먼저 코드를 보면
app.use(express.static(path.join(__dirname, 'public')));
app.get('/error',function(req,res,next){
// this will make a error
var err = new Error('custom error');
err.type = 'my error';
next(err);
});
app.use(function(err,req,res,next){
console.log(err.type);
console.log(err.stack);
res.format({
html: function(){
res.send(500,'internal server error');
},
json:function(){
res.send(500,{code:err.type,description:'error detail'});
}
});
});
app.use(function(req,res){
res.send(404,"I cannot find the page");
} );
http.createServer(app).listen(app.get('port'), function(){
console.log('Express server listening on port ' + app.get('port'));
});
먼저 404 에러의 경우 앞에 Connect에서 살펴본 middleware의 chaining 개념을 이용하면 된다. 간단하게 다른 middleware에 의해서 처리되지 않은 URL은 404로 처리하면 된다. 그래서 middleware를 불러드리는 맨 마지막에 404 에러 처리 로직을 구현하였다.
app.use(function(req,res){
res.send(404,"I cannot find the page");
} );
다음은 500이나 503 같은 에러 처리 방식을 알아보자, 인위적으로 에러를 만들기 위해서 HTTP GET/error 시에 인위적으로 에러를 발생시키는 코드를 구현하였다.
app.get('/error',function(req,res,next){
// this will make a error
var err = new Error('custom error');
err.type = 'my error';
next(err);
});
여기서 주의 할점은 node.js의 일반적인 에러 처리 방식 처럼 throw를 통해서 에러를 던지는 것이 아니라 next()를 통해서 에러 메시지를 다음 middleware로 넘기는 형태를 사용한다.next 호출시 인자에 error가 있을 경우 미리 정의된 error handler를 부르게 된다.error handler는 다른 middleware와는 총 4개 인자를 받으며, 다르게 첫번째 인자가 err로 정의 된다.
app.use(function(err,req,res,next){
가 에러 핸들러를 구현한것이며, res.format을 이용하여, 브라우져가 선호하는 포맷 (content/accept에 정의된) 포맷으로 html이나 json으로 메시지를 보내주도록 구현하였다. 예제라서 간단하게 구현했지만, err.type에 에러가 발생할 때 타입을 정해놓으면 error handler에서 이 err.type에 따른 다양한 에러 핸들링 로직을 구현할 수 있고 (예를 들어 Nagios 기반의 모니터링 시스템에 이벤트를 날리거나, IT Admin에게 SMS 메시지를 보내는 것등), 500 error의 경우에는 template을 미리 만들어놓고 잘 디자인된 에러페이지를 출력할 수 있다.
이 밖에도 HTTP Basic Auth를 이용한 인증, 압축 모듈, CSRF (Cross Site Request Forgery) 등을 방어 하는 모듈등 다양한 기능을 지원하는 API 및 모듈이 있다. 자세한 내용은 http://expressjs.com/api.html 을 참고하기 바란다.
'클라우드 컴퓨팅 & NoSQL > Vert.x & Node.js' 카테고리의 다른 글
| 빠르게 훝어 보는 node.js - #7 mongoose ODM 을 이용한 MongoDB 연동 (1) | 2014.04.09 |
|---|---|
| 빠르게 훝어 보는 node.js - #6 MongoDB 연동 (mongo-native) (5) | 2014.04.03 |
| 빠르게 훝어 보는 node.js - #4 웹개발 프레임웍 Express 1/2 (14) | 2014.04.01 |
| 빠르게 훝어 보는 node.js - #3 Event,Module,NPM (5) | 2014.03.25 |
| 빠르게 훝어 보는 node.js - #2 설치와 개발환경 구축 (1) | 2014.03.20 |