Router, Controller

💡 현재 프로젝트는 mvc 패턴을 적용 중인데 이번에는 그 중에서 controller 파트를 구현한 부분을 간단하게 적어 보고자 한다.

Router란?

기존 express를 사용해서 api 서버를 구현하면 클라이언트 측에서 들어오는 요청은 아래의 코드와 같이 request를 수신받아 데이터를 처리하고 다시 클라이언트 측으로 데이터를 반환하는 구조를 가진다.

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

// app.[METHOD]('request 경로', callback_function)
app.get('/', (req, res) => {
  res.send('hello world')
})

기존 요청 처리 단점

하지만 기존과 같이 인자로 전달하는 callback 함수에서 각 요청들을 처리하는 로직을 직접적으로 구현하다 보면 프로젝트의 규모가 커짐에 따라 수많은 요청들을 처리하게 된다.

그 과정에서 하나의 js 파일에서 모든 요청에 대해 로직을 구현하게 되는데 그러다 보면 당연히 코드의 가독성이 떨어지고 코드가 중복되게 되면서 프로젝트의 유지보수가 떨어진다.

Express Router

그 점을 express에서 제공하는 Router 모듈을 사용해 공통된 경로를 모아서 라우팅을 깔끔하게 관리할 수 있다.

→ “라우트 체이닝” 이라고 부르는 거 같다

간단하게 Router에 대해 알아보기 위해 src 디렉토리 아래에 routes를 생성한다.

• index.js 는 Express generator에 의해 자동으로 생성된 파일(defalut 값..?)

그리고 아래와 같이 users.js 파일에 코드를 작성하자.
(전체 코드는 깃허브를 참고하자)

var express = require("express");
var router = express.Router();
// 로직을 처리할 컨트롤러
const userController = require("../controllers/userController")

router.get("/emailCheck/:email", userController.checkEmailExistence);

module.exports = router;

그리고 app.js 에 user router를 사용하기 위해 아래의 코드를 추가하자.

app.use("/users", usersRouter);

그리고 나는 router와 controller를 분리해서 router는 경로를 라우팅 하는 용도로만 사용하고자 한다.
(Django의 urls.py를 이용한 라우팅 방식과 유사…?)

위와 같이 코드를 작성을 했으면 만약 ‘GET /emailChecl/[query parameter]’ 경로로 서버에 요청이 오면 router는 요청을 받아 userController로 requset을 전달한다.

Controller

이제 클라이언트에서 들어온 요청을 처리하고 반환하는 로직을 구현해야 하는데 바로 mvc design pattern의 controller를 구현하면 된다!!

라우터도 공통된 경로(기능)로 묶어서 구현한 듯이 컨트롤러를 공통된 기능이나 목적을 가진 컨트롤러들을 합쳐서 하나의 모듈로 구현해보겠다.

→ 일단 Router : Controller = 1: 1 매칭이 되게끔…

userController

위의 그림처럼 controllers 디렉토리를 생성하고 그 아래에 사용자 관련 기능을 담당할 userController.js 파일을 생성한다. 그리고 아래와 같이 코드를 추가해보자.

const db = require("../models");

// 이메일 체크 컨트롤러
exports.checkEmailExistence = async (req, res) => {
  const emailToCheck = req.params.email;

  db.Worker.findOne({ where: { email: emailToCheck } })
    .then((user) => {
      res.status(200);
      if (user) {
        res.json({ message: "EMAIL_ALREADY_EXISTS" });
      } else {
        res.json({ message: "EMAIL_AVAILABLE" });
      }
    })
    .catch((err) => {
      console.log(err.message);
      res.status(500).json({ message: "EAMIL_CHECKING_FAILED" });
    });
};

checkEmailExistence controller를 간단하게 설명하면 회원가입 과정에서 이메일이 사용할 수 있는 이메일인지 조회하는 로직을 구현한 코드이다.

model 객체를 통해 클라이언트에서 요청으로 받은 email 값이 user table에 존재하는지 확인한다.
→ 현재는 database를 ORM을 통해 CRUD를 하기 위해 sequelize와 연동을 한 상태
💡 그리고 개인적인 바람으로 최대한 **REST full api**를 구현하는 것을 목표로 가지고 있어 상태 코드나 return message 등을 적극적으로 활용할 예정이다.

마지막으로 종합하면

• Router: 말 그대로 특정 경로로 들어온 요청을 controller로 routing을 하기 위해 사용
• Controller: 라우팅을 통해 받은 request를 처리하는 핵심 로직을 구현하는 코드을 의미
  • 기본적으로 model 과 view 와 분리하기 위해 controller 모듈?을 사용

---

Reference

Express routing

[EXPRESS] 📚 라우터 (Router) 개념 정리

express 라우터, 모듈로 분리하기