사내 칸반보드 개발 프로젝트 - 5

사내 칸반보드 개발 프로젝트 - 4

 

오늘 글은 드디어 백엔드로 넘어왔다.

사실 지금 회사를 입사하고 초기에 강의를 들었을 때 node js가 포함되어 있어 들은 이후로 한적이 없으니 거의 3년만에 다시 해본것이다.

이번에 신기한데 3년 전에 했을 때는 코드가 아예 눈에 안들어왔는데 이번에는 신기하게 쓱 보는데 코드를 조금 이해 할 수 있었다.

확실히 포기 안하고 꾸준히 하면 성장이란 것을 할 수 있는 것 같긴하다.

 

기술 스택

1. Node.js

2. mongoDB (회사에서 사용중임)

3. Express

4. mongoose

Node.js 설명

Node.js는 Chrome의 V8 JavaScript 엔진으로 빌드된 JavaScript 런타임입니다. 주로 서버 측 애플리케이션 개발에 사용되며, 비동기 이벤트 기반 구조를 가지고 있어 높은 확장성을 제공합니다. Node.js는 JavaScript를 서버 측에서도 사용할 수 있게 해주며, 웹 서버, API 서버, CLI 도구 등 다양한 분야에서 사용됩니다.

Node.js의 주요 특징

1. 비동기 이벤트 기반 아키텍처: Node.js는 비동기 I/O를 사용하여 높은 성능과 확장성을 제공합니다. 비동기 프로그래밍 모델 덕분에, 하나의 쓰레드로 많은 클라이언트 요청을 처리할 수 있습니다.
2. 단일 쓰레드: Node.js는 단일 쓰레드로 동작하지만, 내부적으로 I/O 작업은 libuv 라이브러리를 사용하여 다중 쓰레드 풀에서 처리됩니다. 이를 통해 I/O 작업을 효율적으로 처리합니다.
3. 빠른 실행 속도: Node.js는 Chrome의 V8 JavaScript 엔진을 사용하여 JavaScript 코드를 빠르게 실행합니다.
4. npm (Node Package Manager): npm은 Node.js의 패키지 관리 도구로, 다양한 라이브러리와 패키지를 쉽게 설치하고 관리할 수 있습니다. npm 레지스트리에는 수많은 패키지가 등록되어 있어 개발 생산성을 높여줍니다.

MongoDB 설명

MongoDB는 NoSQL 데이터베이스로, 문서 지향(document-oriented) 데이터 모델을 사용하여 데이터를 저장합니다. 전통적인 관계형 데이터베이스와는 달리, MongoDB는 유연한 스키마를 제공하며, JSON과 유사한 BSON(Binary JSON) 형식을 사용하여 데이터를 저장합니다. 이는 애플리케이션 개발에 있어 높은 유연성과 성능을 제공합니다.

MongoDB의 주요 특징

1. 문서 지향 스토리지: MongoDB는 데이터를 문서(Document) 형태로 저장합니다. 문서는 JSON과 유사한 BSON 형식으로 저장되며, 이는 계층적 데이터를 자연스럽게 표현할 수 있습니다.
2. 유연한 스키마: MongoDB는 고정된 스키마를 요구하지 않으므로, 각 문서는 서로 다른 필드와 구조를 가질 수 있습니다. 이는 애플리케이션의 변화에 따라 데이터 구조를 쉽게 변경할 수 있게 합니다.
3. 수평적 확장: MongoDB는 샤딩(Sharding) 기술을 통해 데이터베이스를 여러 서버에 분산 저장하여 수평적 확장을 지원합니다. 이를 통해 대용량 데이터를 효과적으로 처리할 수 있습니다.
4. 고성능: MongoDB는 인덱싱, 복제, 메모리 기반 스토리지 엔진 등을 통해 높은 읽기/쓰기 성능을 제공합니다.
5. 풍부한 쿼리 언어: MongoDB는 강력한 쿼리 언어를 제공하여, 필터링, 정렬, 집계, 조인 등 다양한 데이터 처리 작업을 지원합니다.
6. 복제 및 고가용성: MongoDB는 복제(replication)를 통해 데이터의 가용성과 내구성을 보장합니다. 여러 복제본(replica set)을 유지하여, 장애 발생 시 자동으로 장애 조치를 수행합니다.

 

 

 

Express 설명

Express는 Node.js 환경에서 웹 애플리케이션을 개발하기 위해 널리 사용되는 빠르고 간결한 웹 프레임워크입니다. Express는 다양한 기능을 제공하며, 이를 통해 간단하게 RESTful API를 구축하거나 복잡한 웹 애플리케이션을 개발할 수 있습니다.

Express의 주요 특징

1. 미들웨어 아키텍처: Express는 미들웨어(middleware)를 사용하여 요청(request)과 응답(response) 객체를 처리합니다. 미들웨어는 함수의 형태로, 요청과 응답을 가로채고 처리할 수 있습니다.
2. 라우팅: Express는 HTTP 메소드(GET, POST, PUT, DELETE 등)와 URL 경로를 기반으로 라우팅을 제공합니다. 이를 통해 요청을 처리할 함수를 정의할 수 있습니다.
3. 빠르고 경량: Express는 최소한의 기능만 포함하여 경량이며, 필요한 경우 다양한 서드파티 미들웨어를 추가하여 기능을 확장할 수 있습니다.
4. 템플릿 엔진 지원: Express는 Pug, EJS, Handlebars 등 다양한 템플릿 엔진을 지원하여 동적 HTML 페이지를 생성할 수 있습니다.
5. 높은 유연성: Express는 매우 유연하며, 다양한 방식으로 애플리케이션의 구조를 설계할 수 있습니다.

Express 구조

 bin/www
http 모듈에 express 모듈을 연결하며, 포트를 지정할 수 있다.
서버를 실행하는 스크립트이다.

 

 routes
라우터들을 관리하는 곳으로 서버의 로직은 모두 routes 폴더 안의 파일에 작성할 것이다. index.js를 기반으로 라우팅 관리를 해주면 된다. routes 디렉토리 안에 또 폴더를 만들어 관리하던지 파일을 만들어 관리하던지 하면 된다.

 

app.js
대망의 app.js! 핵심적인 서버의 역할을 하며 미들웨어 관리를 하는 곳이다.

 

var createError = require('http-errors');
var express = require('express');
var router = express.Router();
var path = require('path');
var cookieParser = require('cookie-parser');
var logger = require('morgan');
var indexRouter = require('./routes/index');
var usersRouter = require('./routes/users');
const kanbanRouter = require('./routes/kanban');
const { tryConDB } = require('./utils/db');
var cors = require('cors'); // cors 패키지 추가
var app = express();

// CORS 미들웨어 설정
app.use(cors()); // 모든 도메인에서의 요청을 허용
// 데이터베이스 연결을 위한 미들웨어 사용
app.use(tryConDB);
// view engine setup
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'jade');

app.use(logger('dev'));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

app.use('/', indexRouter);
app.use('/users', usersRouter);
app.use('/kanban', kanbanRouter);
app.use(router);
// catch 404 and forward to error handler
app.use(function (req, res, next) {
  next(createError(404));
});

// error handler
app.use(function (err, req, res, next) {
  // set locals, only providing error in development
  res.locals.message = err.message;
  res.locals.error = req.app.get('env') === 'development' ? err : {};

  // render the error page
  res.status(err.status || 500);
  res.render('error');
});

router.get('/test', function (req, res) {
  res.json({
    'message': 'nodemon 사용중',
  });
});

router.post('/test/post', function (req, res) {
  res.json({
    'message': 'hello post api nodejs-api',
  });
});

module.exports = app;

코드에서 app.use 가 미들웨어를 사용하는 것이다.

 

내가 사용한 스택에 대해 간단하게 설명을 맞췄다.

 

이번에 내가 삽질을 많이 했던 부분은 db를 연결하고  api를 요청 했을 때 db에 데이터가 들어가는 지 부분에 굉장히 애를 먹었다.

 

나는 utils 폴더에 db.js 라는 파일을 만들어 아래 코드를 넣었다.

첫 번째  보이는 코드인 mongoose를 활용해서 연결시킨다.

 

Mongoose 설명

Mongoose는 Node.js와 MongoDB를 위한 객체 데이터 모델링(ODM) 라이브러리입니다. Mongoose를 사용하면 MongoDB의 문서를 스키마에 맞춰 정의하고, 해당 스키마를 기반으로 데이터를 다룰 수 있는 다양한 기능을 제공합니다. 이를 통해 MongoDB와의 상호 작용을 더 간단하고 일관되게 처리할 수 있습니다.

Mongoose의 주요 기능

1. 스키마 정의: Mongoose는 스키마 정의를 통해 MongoDB 컬렉션의 구조를 명확하게 할 수 있습니다. 스키마는 문서의 필드와 데이터 타입을 정의합니다.
2. 모델: 모델은 스키마를 기반으로 생성된 객체로, MongoDB 컬렉션에 대한 CRUD 작업을 수행할 수 있습니다. 모델을 통해 문서를 생성, 읽기, 수정, 삭제할 수 있습니다.
3. 유효성 검사: Mongoose는 데이터를 저장하기 전에 유효성 검사를 수행할 수 있습니다. 이를 통해 데이터의 무결성을 보장할 수 있습니다.
4. 미들웨어: Mongoose는 문서가 저장되기 전, 후 등의 특정 시점에 실행될 수 있는 미들웨어를 제공합니다. 이를 통해 데이터 처리 로직을 쉽게 추가할 수 있습니다.
5. 가상 속성: 스키마에 정의되지 않은 가상 속성을 설정할 수 있습니다. 가상 속성은 데이터베이스에 저장되지 않지만, 애플리케이션에서 유용하게 사용할 수 있습니다.
6. 플러그인: Mongoose는 플러그인 시스템을 통해 기능을 확장할 수 있습니다. 커스텀 플러그인을 작성하거나, 커뮤니티에서 제공하는 다양한 플러그인을 사용할 수 있습니다.

 

 

db 연결하는 부분 코드다.

 

 

 

자 이제 본격적인 crud 작업을 해보자

express 프레임워크라서 이미 구조가 잡혀있어 우리는 구조에 맞게 파일을 만들어 사용하면 깔끔하게 사용할 수 있다.

 

models 는 스키마를 정의하는 파일을 넣는다.

스키마 역시 mongoose를 활용해 만든다.

const mongoose = require('mongoose');
const { Schema } = mongoose;

const kanbanSchema = new Schema({
  title: String,
  name: String,
});

module.exports = mongoose.model('kanban', kanbanSchema);

 

controllers에는 crud를 불러오는 함수를 모아 놓은 파일을 생성한다.

const Kanban = require('../models/kanban');

const getProfile = async (req, res) => {
  try {
    let result = await Kanban.find().lean().exec();
    console.log('result', result);
    res.status(200).json(result);
  } catch (error) {
    console.error('Error fetching data:', error);
    res.status(500).json({ message: 'Internal Server Error' });
  }
};

const createKanban = async (req, res) => {
  try {
    const { title, name } = req.body;
    const newKanban = new Kanban({ title, name });
    const savedKanban = await newKanban.save();
    console.log('savedKanban', savedKanban); // 저장된 결과를 콘솔에 출력
    res.status(201).json(savedKanban);
  } catch (error) {
    console.error('Error creating kanban:', error);
    res.status(500).json({ message: 'Internal Server Error' });
  }
};

module.exports = {
  getProfile,
  createKanban,
};

 

routes에 라우팅 주소를 설정한다.

const express = require('express');
const kanbanController = require('../controllers/kanban');
const router = express.Router();

// 프로필 조회
router.get('/', kanbanController.getProfile);

// 프로필 생성
router.post('/', kanbanController.createKanban);

module.exports = router;

 

이 라우터를 app.js 에 불러와 사용한다.

var createError = require('http-errors');
var express = require('express');
var router = express.Router();
var path = require('path');
var cookieParser = require('cookie-parser');
var logger = require('morgan');
var indexRouter = require('./routes/index');
var usersRouter = require('./routes/users');
const kanbanRouter = require('./routes/kanban');
const { tryConDB } = require('./utils/db');
var cors = require('cors'); // cors 패키지 추가
var app = express();

// CORS 미들웨어 설정
app.use(cors()); // 모든 도메인에서의 요청을 허용
// 데이터베이스 연결을 위한 미들웨어 사용
app.use(tryConDB);
// view engine setup
app.set('views', path.join(__dirname, 'views'));
app.set('view engine', 'jade');

app.use(logger('dev'));
app.use(express.json());
app.use(express.urlencoded({ extended: false }));
app.use(cookieParser());
app.use(express.static(path.join(__dirname, 'public')));

app.use('/', indexRouter);
app.use('/users', usersRouter);
app.use('/kanban', kanbanRouter); // 칸반 라우터 활용
app.use(router);
// catch 404 and forward to error handler
app.use(function (req, res, next) {
  next(createError(404));
});

// error handler
app.use(function (err, req, res, next) {
  // set locals, only providing error in development
  res.locals.message = err.message;
  res.locals.error = req.app.get('env') === 'development' ? err : {};

  // render the error page
  res.status(err.status || 500);
  res.render('error');
});

router.get('/test', function (req, res) {
  res.json({
    'message': 'nodemon 사용중',
  });
});

 

이제 포스트맨에서 한번 실행해보자 

먼저 get api

 

다음은 post api

 

다시 get 으로 불러오면 post 를 활용해서 만들어서 2개의 데이터를 불러온다

 

정말 이번 편에서는 초간단으로 했고 다음편에서 서버까지 올리면 아마 진짜 칸반에서 활용할 수 있게 다시 리팩토링 할 예정이다.

서버부분은 내가 안해본 것을 도전하고 있기에 일단 작은 목적을 달성하면 빠르게 다음 목표로 도전할 계획이다.