expressjs

Achievement Goals

• Express 라이브러리
  • express 라이브러리가 어떤 작업을 단순하게 만드는지 이해할 수 있다.
    • express 라이브러리를 사용하는 예시와 그렇지 않은 예시를 들어서 작업을 단순화 차이를 알아보자

    • if (req.method === 'POST') {
          if (req.url === '/lower') {
            let data = '';
            req.on('data', chunk => {
              data = data + chunk;
            });
            req.on('end', () => {
              data = data.toLowerCase();
              res.writeHead(201, defaultCorsHeader);
              res.end(data);
            });
          } else {
            res.writeHead(404, defaultCorsHeader);
            res.end();
          }
        }

  • 미들웨어의 개념을 이해할 수 있다.
• 서버 개발과 디버깅
  • CRUD 를 수행하는 웹 서버 개발 방법을 익힐 수 있다.
  • 서버 개발을 돕는 다양한 툴들을 익힐 수 있다.

 

라우팅: 메소드와 URL에 따라 분기(Routing)하기

메소드와 URL(/lower, /upper 등)로 분기점을 만드는 것을 라우팅(Routing)이라고 합니다.

클라이언트는 특정한 HTTP 요청 메소드(GET, POST 등)나 서버의 특정 URI(또는 경로)로 HTTP 요청을 보냅니다. 라우팅은 클라이언트의 요청에 해당하는 메소드와 Endpoint에 따라 서버가 응답하는 방법을 결정하는 것입니다.

추가적인 라이브러리를 사용하지 않고, 순수한 node.js 코드를 작성하면, 다음과 같이 작성할 수 있습니다.

 

const requestHandler = (req, res) => {
  if(req.url === '/lower') {
    if (req.method === 'GET') {
      res.end(data)
    } else if (req.method === 'POST') {
      req.on('data', (req, res) => {
        // do something ...
      })
    }
  }
}

 

반면에 Express는 프레임워크 자체에서 라우터 기능을 제공합니다. Express의 라우터를 활용하면 아래와 같이 직관적인 코드를 작성할 수 있습니다.

 

const router = express.Router()

router.get('/lower', (req, res) =>{
  res.send(data)
})

router.post('/lower', (req, res) =>{
  // do something
})

 

MERN stack은 JavaScript 생태계에서 인기 있는 프레임워크인 MongoDB, Express, React, Node를 지칭하는 말입니다. 이 중에서 Express.js는 Node.js 환경에서 웹 서버, 또는 API 서버를 제작하기 위해 사용되는 인기 있는 프레임워크입니다.

 

자동차 공장에서는 컨베이어 벨트 위에 올려진 자동차의 뼈대에, 각 공정마다 부품을 추가합니다. 모든 부품이 추가되면 완성된 자동차가, 어딘가 문제가 있다면 불량품이 결과물로 나오게 됩니다.

미들웨어는 자동차 공장의 공정과 비슷합니다. 컨베이어 벨트 위에 올라가 있는 request에 필요한 기능을 더하거나, 문제가 발견된 불량품을 밖으로 걷어내는 역할을 합니다.

 

자주 사용하는 미들웨어

먼저, 미들웨어를 사용하는 상황

1. 모든 요청에 대해 url이나 메소드를 확인할 때
2. POST 요청 등에 포함된 body(payload)를 구조화할 때(쉽게 얻어내고자 할 때)
3. 모든 요청/응답에 CORS 헤더를 붙여야 할 때
4. 요청 헤더에 사용자 인증 정보가 담겨있는지 확인할 때

case 2: POST 요청 등에 포함된 body(payload)를 구조화할 때

순수 node.js로 HTTP body(payload)를 받을 때에는 Buffer를 조합해서 다소 복잡한 방식으로 body를 얻을 수 있습니다.

let body = [];
request.on('data', (chunk) => {
  body.push(chunk);
}).on('end', () => {
  body = Buffer.concat(body).toString();
  // body 변수에는 문자열 형태로 payload가 담겨져 있습니다.
});

미들웨어를 사용하면 이 과정을 간단하게 처리할 수 있습니다.

const bodyParser = require('body-parser')
const jsonParser = bodyParser.json()

// 생략
app.post('/api/users', jsonParser, function (req, res) {
  // req.body에는 JSON의 형태로 payload가 담겨져 있습니다.
})

case 3: 모든 요청/응답에 CORS 헤더를 붙일 때

순수 node.js 코드에 CORS 헤더를 붙이려면, 응답 객체의 writeHead 메소드 등을 이용합니다.

이런 메소드를 이용하더라도 Access-Control-Allow-* 헤더를 매번 재정의해야 합니다.

그뿐만 아니라, OPTIONS 메소드에 대한 라우팅도 따로 구현해야 합니다.

const defaultCorsHeader = {
  'Access-Control-Allow-Origin': '*',
  'Access-Control-Allow-Methods': 'GET, POST, PUT, DELETE, OPTIONS',
  'Access-Control-Allow-Headers': 'Content-Type, Accept',
  'Access-Control-Max-Age': 10
};

// 생략
if (req.method === 'OPTIONS') {
  res.writeHead(201, defaultCorsHeader);
  res.end()
}

cors 미들웨어를 사용하면 이 과정을 간단하게 처리할 수 있습니다.

 

const cors = require('cors')

// 생략
app.use(cors()) // 모든 요청에 대해 CORS 허용

[코드] cors 모듈을 이용해 CORS를 간단하게 처리할 수 있습니다.

 

const cors = require('cors')

// 생략
// 특정 요청에 대해 CORS 허용
app.get('/products/:id', cors(), function (req, res, next) {
  res.json({msg: 'This is CORS-enabled for a Single Route'})
})

[코드] 특정 요청에만 cors 모듈을 적용할 수도 있습니다.

미들웨어 작동 원리

수많은 미들웨어가 있지만, 가장 단순한 미들웨어 로거(logger)를 예로 들겠습니다.

로거는 디버깅이나, 서버 관리에 도움이 되기 위해 console.log 로 적절한 데이터나 정보를 출력합니다.

데이터가 여러 미들웨어를 거치는 동안 응답할 결과를 만들어야 한다면, 미들웨어 사이사이에 로거를 삽입하여 현재 데이터를 확인하거나, 디버깅에 사용할 수 있습니다.

위 그림은 endpoint가 /이면서, 클라이언트로부터 GET 요청을 받았을 때 적용되는 미들웨어입니다.

next는 다음 미들웨어를 실행합니다.

 

이 콘텐츠의 최상단에 나오는 이미지에서 next 의 역할을 확인할 수 있습니다.

 

위 그림을 살펴보면, 미들웨어 내부에서는 아무런 작업을 하고 있지 않습니다. 그저 next() 함수를 호출하여 다음 미들웨어로 데이터를 전달하고 있습니다.

 

만약 특정 enpoint가 아니라 모든 요청에 동일한 미들웨어를 적용하려면 어떻게 해야 할까요? 이때에는 메소드 app.use 를 사용합니다.

 

const express = require('express');
const app = express();

const myLogger = function (req, res, next) {
  console.log('LOGGED'); // 이 부분을 req, res 객체를 이용해 고치면, 여러분들은 모든 요청에 대한 로그를 찍을 수 있습니다.
  next();
};

app.use(myLogger);

app.get('/', function (req, res) {
  res.send('Hello World!');
});

app.listen(3000);

목표는 다음과 같이, 모든 요청에 대해 메소드와 url을 출력하는 것입니다. 직접 구현해 보세요.

case 4: 요청 헤더에 사용자 인증 정보가 담겨있는지 확인할 때

다음은 HTTP 요청에서 토큰이 있는지 여부를 판단하여, 이미 로그인한 사용자일 경우 성공, 아닐 경우 에러를 보내는 미들웨어 예제입니다.

app.use((req, res, next) => {
  // 토큰 있니? 없으면 받아줄 수 없어!
  if(req.headers.token){
    req.isLoggedIn = true;
    next()
  } else {
    res.status(400).send('invalid user')
  }
})

로그인 없이 웹사이트에 접근을 시도했을 때, 로그인 창 등으로 되돌려 보내는 경우를 경험해 본 적이 있을 겁니다.

 

서버에서는 요청에 포함된 데이터를 통해 미들웨어가 요구하는 조건에 맞지 않으면, 불량품으로 판단하고 돌려보내도록 구현할 수 있습니다.

 

 

 

 

 

 

 

 

 

 

라우팅

미들웨어

오류처리

생성기X