[NodeJS] 프로젝트 폴더 구조 만들기

Lends Project

이번에 렌즈 프로젝트를 진행하면서 NodeJS 템플릿을 만들게 되었다. 

어떻게 하면 더 좋은 폴더구조를 만들지 고민 하다가 여러가지 블로그를 참고하여 만들었다. 

기존의 템플릿을 그대로 사용하여도 되지만 복습도 할 겸 직접 만들면서 공부도 하게 되니 더 도움이 된 것 같다.

---

폴더 구조

📂 server
    📂 config
    ├── 📄 baseResponseStatus.js
    ├── 📄 database.js  
    ├── 📄 express.js
    ├── 📄 jwtMiddleware.js
    ├── 📄 response.js
    📂 src
    └── 📂 app           				
        ├── 📂 User          		
        |    ├── 📄 userController.js          	
        |    ├── 📄 userDao.js 		
        |    ├── 📄 userProvider.js   		
        |    ├── 📄 userRoute.js   		 
        |    └── 📄 userService.js   	 
    📄 .gitignore                     		
    📄 app.js
    📄 server.js
    📄 package.json                      
    📄 README.md

현재 완벽하게 구성된 폴더 구조는 아니지만 점차 프로젝트를 진행하면서 바뀌는 부분이나 새로운 부분들을 추가할 예정이다. 

---

폴더 구조 설명

    📂 config
    ├── 📄 baseResponseStatus.js
    ├── 📄 database.js  
    ├── 📄 express.js
    ├── 📄 jwtMiddleware.js
    ├── 📄 response.js

📂 Config 

설정과 관련된 파일들이 들어 있는 폴더이다. 

---

📄 baseResponseStatus.js / 📄 response.js

module.exports = {
  // Success
  SUCCESS: { isSuccess: true, code: 1000, message: '성공' },

  TOKEN_EMPTY: { isSuccess: false, code: 2000, message: 'JWT 토큰을 입력해주세요.' },
  TOKEN_VERIFICATION_FAILURE: { isSuccess: false, code: 3000, message: 'JWT 토큰 검증 실패' },
  TOKEN_VERIFICATION_SUCCESS: { isSuccess: true, code: 1001, message: 'JWT 토큰 검증 성공' },

  // User Response
  NICKNAME_EMPTY: { isSuccess: false, code: 2000, message: '닉네임(Id)을 입력하세요.' },
  PASSWORD_EMPTY: { isSuccess: false, code: 2001, message: '비밀번호를 입력하세요.' },
  SIGNIN_NICKNAME_WRONG: { isSuccess: false, code: 2002, message: '존재하지 않는 닉네임입니다.' },
  PASSWORD_WRONG: { isSuccess: false, code: 2003, message: '비밀번호가 맞지 않습니다.' },
  SIGNUP_VERIFIEDPASSWORD_EMPTY: { isSuccess: false, code: 2004, message: '비밀번호 확인을 입력하세요.' },
  SIGNUP_NAME_EMPTY: { isSuccess: false, code: 2005, message: '이름을 입력하세요.' },
  SIGNUP_REDUNDANT_EMAIL: { isSuccess: false, code: 2006, message: '존재하는 닉네임(Id)입니다.' },
  UPDATE_ERROR_TYPE: { isSuccess: false, code: 2007, message: '잘못된 형식 입니다.' },

  // DB Error
  SERVER_CONNECT_ERROR: { isSuccess: false, code: 3000, message: '서버 접속 에러입니다.' },

  // Profile Response
  LOGIN_ERROR: { isSuccess: false, code: 3000, message: '이용하려면 로그인 하세요' },
};

클라이언트에게 response를 보낼 때 사용 될 파일

아직 시작단계이기 때문에 당장 필요한 부분만 코드를 작성하였다. 

---

📄 database.js 

const mysql = require('mysql2/promise'); // async await
require('dotenv').config();

const pool = mysql.createPool({
  host: process.env.DB_HOST,
  user: process.env.DB_USER,
  port: process.env.DB_PORT,
  password: process.env.DB_PASSWORD,
  database: process.env.DB_DATABASE,
  multipleStatements: true,
});

module.exports = {
  pool: pool,
};

데이터 데이스 관련 설정을 관리하는 파일

---

📄 express.js

const express = require('express');
const router = express.Router();

router.use('/api/user', require('../src/app/user/userRoute'));
// router.use('/api/product', require('./product'));

module.exports = router;

라우팅을 관리할 파일. 

이 부분에서 많은 시간을 사용하게 되었는데 라우팅이 어떤 건지 잘 몰랐고 userRoute에서도 route 처리를 하기 때문에 이 파일이 필요 없다고 생각하였지만 꼭 필요한 파일이다.

라우트에 대해 더 공부를 해야 할 것 같다. 

---

   📄 jwtMiddleware.js

아직 작성하지 않은 jwtMiddleware 파일

로그인 구현을 jwt를 이용하여 할 것이기 때문에 jwt 미들웨어가 필수적이다. 토큰 검증 및 확인을 이 파일에서 진행할 예정이다. 

---

📂 Src / app 폴더

    📂 src
    └── 📂 app           				
        ├── 📂 User          		
        |    ├── 📄 userController.js          	
        |    ├── 📄 userDao.js 		
        |    ├── 📄 userProvider.js   		
        |    ├── 📄 userRoute.js   		 
        |    └── 📄 userService.js

현재는 API를 만들지 않았지만 이러한 구조를 갖게 될 것이다.

Controller / Service / Dao

지금은 Controller / Service & Provider / Dao 로 나누어서 진행을 할 예정인데 Service 와 Provider 를 하나의 파일에서 관리 할 것인지 고민해 볼 것이다.  

---

📄 userRoute.js

이전의 config -> express.js 파일에서 사용된 라우트를 이용해 userRoute에서 라우팅을 걸어준다.

const express = require('express');
const router = express.Router();

const userController = require('./userController');

// router.get('/signUp', userController.postUser);

module.exports = router;

 

---

📄 userController.js

Controller - 이메일 체크, 비밀번호 체크와 같은 것을 처리할 파일

📄 userService.js / 📄 userProvider.js

Serviec & Provider - 서비스 로직을 구현하는 파일

📄 userDao.js

Dao - 데이터 베이스의 쿼리문을 작성하는 파일 

---

시작 파일

📄 app.js

const express = require('express');
const app = express();
const dotenv = require('dotenv');
const methodOverride = require('method-override');
const logger = require('morgan');
const routes = require('./config/express');

class App {
  constructor() {
    this.app = express();

    dotenv.config();

    this.setMiddleWare();

    this.getRouting();
  }
  setMiddleWare() {
    this.app.use(logger('dev'));

    this.app.use(express.json());
    this.app.use(express.urlencoded({ extended: false }));

    this.app.use(methodOverride());
  }
  getRouting() {
    this.app.use(routes);
  }
}

module.exports = new App().app;

App 객체를 생성하여 app 관리

---

📄 index.js

const app = require('./app.js');
const port = process.env.PORT || 5000;

app.listen(port, () => {
  console.log(`Listening on port ${port}`);
});

 

프로젝트를 진행하면서 많은 부분들을 배우고 까먹었던 부분들도 다시 공부하게 된다. 제대로 된 프로젝트를 진행 하도록 노력할 것이다.