NestJS로 프로젝트 만들어보기 - 3 (DB연동)

웹어플리케이션을 만들면서 가장 많이 필요로 하는 것중에 하나가 데이터베이스 연동인데, Nest.js에서도 공식적으로 데이터베이스 클라이언트 모듈을 제공해주고, Typescript의 ORM인 TYPE ORM을 사용할 수 있습니다. 이전 프로젝트에 데이터베이스를 연동시켜보겠습니다.

 

일단 데이터베이스가 필요할텐데, 보통 데이터베이스는 별도의 서버나 혹은 클라우드에서 제공하는 서비스를 원격으로 붙어서 사용하는게 일반적이나, 간단하게 테스트하는 용도이니만큼 DB도 도커를 사용하여 간단하게 띄워보도록 하겠습니다. (도커는 기본적으로 설치되었다는 가정하게 진행하겠습니다.)

 

1. MYSQL image 다운받기

$ docker pull mysql

버전을 따로기입하지 않고 image를 다운받으면 최신버전을 기준으로 mysql 이미지를 다운받게 됩니다.

 

2.  Container 실행

$ docker run --name mysql-container -e MYSQL_ROOT_PASSWORD=root -d -p 3306:3306 mysql

위에서 다운받은 이미지를 실행하는데, 몇가지 옵션들이 필요합니다.

• --name : 컨테이너 이름
• -e MYSQL_ROOT_PASSWORD : 패스워드 설정
• -d : 백그라운드(데몬)으로 실행
• -p : 포트바인딩

도커실행이 제대로 됐다면, docker ps 명령어로 실행이 됐는지 확인할 수 있습니다.

 

3.  Mysql 접속 테스트

컨테이너가 제대로 떳다면 DBMS로 접속이 가능합니다. 저는 DBeaver 라는 DBMS 툴로 사용하였습니다.

참고로 MYSQL8 버전 이후부터 바로 접속하려했을 때 아래의 에러가 하나 발생했습니다.

Public Key Retrieval is not allowed

allowPublicKeyRetrieval=true 옵션값을 설정하여 해결했습니다.

MySql 공식사이트에서 MITM 공격을 방어하기 위해 해당 디폴트 옵션값을 false로 설정했다라는 설명을 합니다.

DBeaver를 사용한다는 가정하에는 아래와 같이 옵션 설정을 할 수 있습니다.

default 값으로 false로 설정되어있는걸 true로 변경합니다.

4.  Database 생성

DDL 문으로도 Database를 만들어도되고, 아니면 DBMS의 UI로 간단하게 만들 수도 있습니다.

프로젝트에 사용할 Database 이름을 store라고 짓도록 하겠습니다.

 

5.  Nestjs 프로젝트에서 DB 연결 (출처: https://docs.nestjs.com/techniques/database)

Nest.js 공식 문서에 보면 여러가지 ORM 연결을 공식적으로 지원하고 있습니다. 그중에서 TypeORM을 사용하려합니다.

일단 Mysql을 접속하기위한 모듈들을 설치하도록 하게습니다.

$ npm install --save @nestjs/typeorm typeorm mysql2

패키지 설치 후에 DB 접속을 모듈화한 코드를 작성하고, 해당 모듈을 루트모듈에 import하는 코드입니다.

src/common/db.module.ts

import { Module } from '@nestjs/common';
import {TypeOrmModule} from '@nestjs/typeorm';

@Module({
    imports: [
        TypeOrmModule.forRoot({
            type: 'mysql',
            host: 'localhost',
            port: 3306,
            username: 'root',
            password: 'admin1234',
            database: 'store',
            entities: [],
            synchronize: true,
        }),
    ],
    providers: [],
    exports: [],
})
export class DatabaseModule {}

루트모듈에 위에 작성한 DatabaseModule을 import 합니다.

src/app.module.ts

import { Module } from '@nestjs/common';
import {TypeOrmModule} from '@nestjs/typeorm';
import { DatabaseModule } from '@Common/db.module';

@Module({
    imports: [
        DatabaseModule,
        TypeOrmModule.forFeature([]),
    ]
})
export class AppModule {}

forFeature안에 entity를 넣으라고 되어있지만 Database.module.ts 파일에서 entity 의 경로를 추후에 다시 잡아줄거기 때문에 이번엔 일단 연결만 한다는 생각으로 코드를 작성합니다. 그리고 파일을 import 할 때 절대경로를 사용하기위해 tsconfig.json 파일에 path 설정을 추가해줍니다.

{
  "compilerOptions": {
    ...
    "paths": {
      "@Common/*": ["./src/common/*"]
    }
  }
}

이렇게 작성을 끝낸후 npm run start:dev 혹은 yarn start:dev (저는 yarn으로 프로젝트를 생성했습니다) 으로 프로젝트를 실행시킵니다.

 

에러없이 실행완료된 모습

제가 소스에서는 지워놓은 몇몇 모듈들이 있어서 OrderModule 같은건 아마 안나올텐데, 중요한건 에러가 안난다는 것과 TypeOrmCoreModule, DatabaseModule 의 dependencies initialized가 정상적으로 되면 성공한겁니다.

 

DB 모듈의 계정정보를 이렇게 하드코딩으로 쓰게되면 나중에 관리하기가 어려워지고,
개발 환경에 따라 커넥션 정보를 관리해야하기때문에 약간 다듬어야할 필요가 있는데, 그건 이후의 과정에서 포스팅 하도록 하겠습니다.