[MEMO APP] Back-end/ 라우팅 (2)

 

👨‍💻 라우팅 (2)

 

📌 라우팅 (2)

저번 포스팅까지 내용을 간단히 요약해보겠습니다. 

 

• 깃허브에 업로드를 원활하게(+보안내용은 가리기) 위해서 gitignore을 설정해 주었습니다.
• Koa-router를 이용해서 '/' 경로로 접근시 특정 메시지가 보이게 하였습니다. 

 

이번에는 저번에 하던 routing작업을 마저 완료하도록 할껀데요. 그 전에 우리가 알아야할 팁들이 있습니다.

 

저 뿐만은 아니겠지만 개발을 하다보면, 폴더 혹은 파일정리가 정말이지 중요하게 느껴집니다.

비슷한 역할을하는 파일들을 하나의 폴더에 묶는다거나 여러가지 역할을 하는 소스코드 덩어리들을 각각의 역할을 수행하는 여러개의 소스코드로 분리시켜 별도의 파일로 만드는 작업은 생활화가 되어있어야 나중에 프로젝트 규모가 커져갈때 그나마.. 그!나!마! 유지보수를 조금 편하게 만들어줍니다.

(아 이건 사람바이 사람 그리고 실력바이 실력인것 같아요. 제 코드는 유지보수가 어렵게만 느껴지는건... )

 

routing작업을 할때에도 이 경로를 잘 구분지어 작업하는것 또한! 같은 맥락으로 중요합니다.

 

앞으로 우리는 REST API 서버를 만들꺼기 때문에 다음을 유의하며 만들어야 합니다.

1. API 버전별 관리

2. 비슷한 역할을 수행하는 기능끼리 관리

3. 각 경로별 수행하는 함수들(Controller) 관리

자 첫번째 조건부터 클리어 하기전에 라우팅 경로를 위한 폴더를 만들어 그곳에서만 라우팅 작업을 처리하도록 api라는 새로운 폴더를 생성해 보겠습니다.

( 경로는 src 폴더 안에 만들어주세요 )

 

이제 첫번째 조건을 클리어 해보겠습니다.

버전별 관리를 하기위해 각 버전마다 폴더를 하나 만들어주겠습니다. 폴더 이름은 v1.0으로 할게요.

(처음 만드는 버전이기에 v1.0으로 합니다. 경로는 api 폴더 안에 만들어주세요.)

 

그리고 각 버전별 폴더들을 관리해줄 수 있도록 소스코드를 작성해야 함으로 api 폴더안에 index.js 파일도 같이 생성해 주도록 하겠습니다.

( 이곳에서 각 버젼별 라우팅 연결을 해줄거에요 )

자 잘따라왔습니다. 근데 여기서 우리가 빠뜨린게 하나 있어요. 그게 무엇이냐면 이 api 폴더를 정확히는 api폴더 안에 있는 파일들을 routing 해줄 api/index.js 를 우리가 만든 서버파일 src/index.js 와 연결을 해주어야 합니다.

 

다음 작업으로 넘어가기전에 이 작업을 먼저 해주고 가도록 하겠습니다.

src/index.js 파일을 열어주세요.

 

우리가 이전에는 router객체 내장 메소드를 사용할때 get만 사용해 보았는데요. 이 router객체에도 app객체에 미들웨어를 연결했던것처럼 또다른 router객체를 연결하는것이 가능합니다.

( app객체에서와 같이 use 메서드를 사용합니다. ex/ routes.use('/api ', api.routes()) ) 

 

바로 use 메서드를 사용하기전에 우리가 만든 api/index.js파일을 먼저 src/index.js 상단에 불러와주도록 하겠습니다.

이제 api 안에 index.js를 불러왔으니 연결을 해봐야겠죠?

 

사용법은 간단합니다. 아래의 소스코드처럼 작성을 해주면 됩니다.

// about routing
const router = new Router();

router.use('/api', api.routes());
router.get('/', (ctx) => {
  ctx.body = '홈';
});

여기서 api 뒤에 routes에 대하여 알아보도록 하겠습니다. 

( 사진을 보면서 알아볼게요. )

우리는 이전 포스팅에서 koa-router 객체를 app에 적용할때 한번 routes를 사용했었는데요.

routes는 우리가 만든 koa-router 객체 (위의 그림에선 router가 되겠네요) 에 연결한 모든 경로들을 의미합니다. 즉 우리는 get을 이용한 '/'의 경로만 있었겠죠? 

 

다시 돌아와서 router.use()의 괄호안에 또라른 router객체의 routes를 집어 넣는것은 특정경로(여기선 '/api')로 들어왔을때 모두 새롭게 집어넣은 rotuer객체로 연결함을 의미합니다.

 

뭐 이런모습일까요?

 

위의 사진에서 예로들어 '/auth' 경로는 위의 '/api '경로와 합쳐져서 '/api/auth' 가 되어지겠네요.

 

이렇게 외부에서 라우팅 작업을 하고 메인으로 사용하는 라우팅 객체에 합치는 것이 가능해집니다.

일단 우리가 처음으로 만들 라우팅은 REST API를 위한 것임으로 api라는 경로로 만들었습니다.

 

따라서 같이 코딩작업을 계속 이어나가 볼게요.

 

이렇게 연결은 했지만... 사실 우리는 api/index.js에 아무 소스코드도 넣지 않았습니다 ㅎㅎ

위와 같이 작성하기 위해서 api 를 router 객체로 만들어주어야 겠죠? 

그럼 다시 api/index.js 파일로 가서 작업을 진행해 보겠습니다.

 

src/index.js의 api를 router 객체로 만들어준다는 것은 api/index.js에서 router객체를 밖으로 내보준다는것을 의미합니다. 고로 이곳에서도 router 객체를 새롭게 만들어주도록 할게요.

const Router = require('koa-router');
const ver1 = require('./v1.0');

const api = new Router();
/* /api/... */
api.use('/v1.0', ver1.routes());

module.exports = api;

 ( 여기서 밖으로 내보내주는 소스코드는 module.exports 입니다. )

 

아마 앞선 내용을 이해하셨다면 눈치채셨을 겁니다. 여기서는 버전별 관리를 하기때문에 우리가 미리 생성한 ver1과 api 라는 이름의 router 객체와 또 연결을 해주었습니다. 이런식으로 계층형식으로 연결을 해주어 관리를 해주면 나중에 특정 라우터에서 오류가 나도 쉽게 찾아가 오류를 수정할 수 있습니다.

 

근데 velopert님 강좌를 보니깐 버전관리 유지보수를 위해서 ver1변수처럼 쓰지 않고 배열을 만들어서 관리를 하더군요. 우리도 고수님의 가르침을 소스코드에 적용시켜 보겠습니다.

const Router = require('koa-router');
// Version 관리 1.0
const versions = {
  'v1.0': require('./v1.0')
};

const api = new Router();
/* /api/... */
api.use('/v1.0', versions['v1.0'].routes());

module.exports = api;

4번째 줄에서 오류가 난다고 걱정하지마세요. : ) 오류가 나는 이유는 우리가 소스코드를 작성하지 않았기 때문입니다 ^^

 

후... 이제야 첫번째 조건을 클리어 했습니다. 이제 두번째 조건을 클리어해줄껍니다.

 

두번째 조건은 비슷한 기능끼리 묶어주는것 이었습니다.

이를 위해서 각 기능별 경로를 관리해주는 v1.0/index.js 파일을 생성해 내부 소스코드를 작성해 보도록 하겠습니다.

 

설명은 위와 같음으로 설명없이 소스코드 작성을 이어갈게요.

 

현재까지의 폴더구성을 공유합니다.

v1.0/index.js 안에 소스도 공유드릴게요.

const Router = require('koa-router');

const api = new Router();

/* /api/v1.0/... */

module.exports = api;

이제 2번째 조건도 클리어 했습니다. 앞으로 새로운 api요청에 대한 기능을 만들때 기능별로 v1.0폴더안에 새로운 폴더를 만들어 그 안에서 router 경로를 관리하고 위의 사진6번째 줄에서 use 메서드를 통해 연결만 해주면 됩니다.

 

마치 아래와 같은 사진처럼 말이죠.
( 공부중인 개인 프로젝트 사진입니다. )

 

오늘 포스팅은 여기까지 작성할텐데요, 사실 라우팅 작업을 얼릉 끝마치고 DB 연결까지 포스팅할 예정이었지만... 생각보다 이부분에 대한 내용이 많아 포스팅 글이 길어지게 되었습니다.

 

그래서 다음 포스팅에서 라우팅작업 요약 하고 DB 연결을 해주도록 하겠습니다. 

 

TodoList

1. 라우팅 요약하기
2. DB 연결하기 ( MongoDB )