blocktrip 4번째 삽질

정말 오랜만에 개발일지를 작성하는것 같다.
원래였으면 코딩테스트 연습문제 일주일에 1회씩 풀고 블로깅 ,
개발과정을 담는 일지 블로깅 등 여러 컨텐츠가 진행됐어야 하는데 , 개인사정 (번아웃,스트레스) 때문에 드디어 차근차근 회복하고 재시작을 하려고한다.

• nestJS init 과정 생략

데이터베이스 구성

우선 내 나름대로의 설계에 따르면 시작은 유저를 생성하고 관리하는것부터였다.
그래서 로컬에 있는 mysql을 연결하려다가 이번기회에 mysql을 도커에 담아서 관리하는게
좀더 가볍고 편리하지 않을까 ? 라는 생각에 도커에 mysql 컨테이너를 올렸다.

도커를 설치했다는 과정하에 작성해보았다.
내 경우는 윈도우라 docker desktop 을 다운로드 받아 사용했다.

WSL2 필요

| mysql 이미지를 내려받는다.

docker pull mysql

| 컨테이너를 생성하고 실행한다.

docker run --name mysql -e MYSQL_ROOT_PASSWORD=<password> -d -p 3306:3306 mysql:latest

| mysql docker 접속

docker exec -it mysql-container bash

아 접속전에 docker desktop 에서 컨테이너를 실행시켜줘야 bash에 접속할 수 있다.

그 후 비밀번호를 입력하고 접속하면 아래와같이 SHOW DATABASES로 데이터베이스를 볼 수 있다.

여기 까지 간단하게 docker mysql 구성을 심플하게 했다.
다음은 실제 연결이 되는지 확인해보자

nestJS 와 mysql 연동

nestJS - Database
공식문서를 참고하면 사실 금방 연결할 수 있지만 나는 DB 정보를 숨길 필요가 있었고 ,
Database 는 따로 분리시켜서 nestJS의 패턴에 맞게 작업하고 싶었다.

npm install --save @nestjs/typeorm typeorm mysql2

우선 typeorm을 사용해서 쿼리 작업을 하기위해 위와 같은 패키지를 설치했다.

npm install --save @nestjs/config joi

그리고 환경변수 세팅을 위한 config 와 환경변수 검사를 위한 joi 패키지를 선택해서 설치했다.

// app.module.ts

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { Connection } from 'typeorm';
import { UserModule } from './user/user.module';
import { DataBaseService } from './database/database.service';
import { DatabaseModule } from './database/database.module';
import { ConfigModule, ConfigService } from '@nestjs/config';
import { AuthModule } from './auth/auth.module';
import * as Joi from 'joi';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      validationSchema: Joi.object({
        DATABASE_PORT: Joi.number().required(),
        DATABASE_USER: Joi.string().required(),
        DATABASE_PASSWORD: Joi.string().required(),
        DATABASE_NAME: Joi.string().required(),
        JWT_SECRET_KEY: Joi.string().required(),
      }),
    }),
    TypeOrmModule.forRoot(
      new DataBaseService(new ConfigService()).getTypeOrmConfig(),
    ),
    UserModule,
    DatabaseModule,
    AuthModule,
  ],
  controllers: [],
  providers: [],
})
export class AppModule {
  constructor(private connection: Connection) { }
}

그리고 기존 nodejs 에서 사용하는 dotenv 대신 nestjs에서 제공하는 ConfigModule을 이용해
env를 세팅했다.

    ConfigModule.forRoot({
      isGlobal: true,
      validationSchema: Joi.object({
        DATABASE_PORT: Joi.number().required(),
        DATABASE_USER: Joi.string().required(),
        DATABASE_PASSWORD: Joi.string().required(),
        DATABASE_NAME: Joi.string().required(),
        JWT_SECRET_KEY: Joi.string().required(),
      }),

ConfigModule.forRoot를 이용하면 어디서든 호출해서 환경변수를 사용할 수 있다.
isGlobal 옵션을 true 로 줘서 전역으로 사용하게끔 한다.
validationSchema 를 사용해 아까 설치한 Joi로 환경변수를 검사한다.

Database 연결을 위해선 TypeOrmModule을 사용해야한다.

   TypeOrmModule.forRoot(
      new DataBaseService(new ConfigService()).getTypeOrmConfig(),
    )

new DataBaseService 는 내가 만든 DataBase 연결용 서비스 인데 코드는 이렇다.

// database/database.service.ts
import { Injectable } from '@nestjs/common';
import { ConfigService } from '@nestjs/config';
import { TypeOrmModuleOptions } from '@nestjs/typeorm';

@Injectable()
export class DataBaseService {
    constructor(private readonly config: ConfigService) { }

    public getTypeOrmConfig(): TypeOrmModuleOptions {
        return {
            type: 'mysql',
            host: 'localhost',
            port: +this.config.get('DATABASE_PORT'),
            username: this.config.get('DATABASE_USER'),
            password: this.config.get('DATABASE_PASSWORD'),
            database: this.config.get('DATABASE_NAME'),
            entities: ["dist/**/*.entity{.ts,.js}"],
            synchronize: true,
            autoLoadEntities: true,
        };
    }
}

내 경우 아직 local 에서 개발하고 있기 때문에 host는 localhost이다.
synchronize 옵션은 prod 에선 추천하지 않는다.
테이블을 바로 만들어줘서 매우 편리하지만 문제가 생길 수 있으므로 공식문서에서도 prod 에선
지양하라고 한다.

autoLoadEntities 를 사용해 엔티티를 자동으로 로드한다.
내 엔티티는 컴파일이 끝난 dist 폴더에 들어있어서 경로를 위와 같이 설정했다.
나머지 정보는 환경변수로서 ConfigService.get() 메서드를 통해 가져올 수 있다.

env 세팅 ( 보통은 dev , prod 를 나눈다. )

// .env
DATABASE_PORT=3306
DATABASE_USER=USER
DATABASE_PASSWORD=PASSWORD
DATABASE_NAME=NAME

database module 에서 providers 에 서비스를 추가하는걸 빼먹지 않도록 한다.

// database/database.module.ts
import { Module } from '@nestjs/common';
import { DataBaseService } from './database.service';

@Module({
    providers: [DataBaseService],
})
export class DatabaseModule { }

docker mysql은 켜져있고 세팅도 끝났으니 npm run start를 해보면...

정상적으로 로드가 끝났다.
애초에 정상적으로 실행되지 않으면 에러를 뱉으나
실제로 데이터 확인이나 테이블을 확인해보려면 db 툴을 이용해 확인하면 된다.

툴에서 연결정보를 입력하면

커넥션 테스트 했을때 성공을 했다.
이대로 완료를 하면 커넥트 성공 !

여기까지 내 서버와 docker mysql을 통해 연동을 시켰다. !
운좋게 회사에서 백엔드로서 포지션 전환이 되면서 php 나 express 가 아닌
다른 프레임워크로 작업하는건 이번 사이드 프로젝트가 처음인데,

NestJS는 express 와 fastify 프레임워크를 합쳤고 , 자바 스프링의 패턴을 그대로 따라가
필요한것들이 준비되어있고 빠르고 간결하게 코드를 나눠서 작성할 수 있어서 좋은것 같다.

다음은 유저 모듈을 만들어 생성하고 로그인하는 과정까지 해보고자한다.
핵심기능을 개발후 추후에 삭제나 수정을 업데이트하려고한다.

사실 끝난건 아니고 앞으로 추가해야할 스펙들이 더 많다. 갈길이 멀다는 뜻..
어쨌든 설계대로 한번 진행을 계속 해보고자 한다.