*🔐Study Keyword :

🔑TypeORM & 🔑Configuring을 통해 TypeORM을 등록해보자

ORM이란?

객체와 관계형 데이터 베이스의 데이터를 자동으로 변형 및 연결하는 작업으로 orm을 활용하면 개발은 객체와 데이터베이스의 변형에 유연하게 사용할 수 있다.

typeorm 특징과 이점

• 모델 기반으로 데이터베이스 테이블 체계를 자동으로 생성
• 데이터 베이스에 객체 쉽게 삽입, 업데이트 및 삭제가능
• 테이블 간의 매핑(1:1,1:N,M:N)을 만듦
• 간단한 CLI 명령을 제공
• typeorm은 간단한 코딩으로 ORM 프레임워크 사용하기 쉽다
• typeorm은 다른 모듈과 쉽게 통합된다.

1. typeorm 사용하는 법

1.npm install @nestjs/typeorm

• nestjs에서 typeorm을 사용하기 위해 연동시켜주는 모듈

2.npm install --save typeorm pg

• typeorm 모듈과 postgres 모듈

connection Option을 작성

1. 코드에 직접 쓰는 방식

config/typerom.cofig.ts

import { TypeOrmModuleOptions } from '@nestjs/typeorm';
export const typeORMConfig: TypeOrmModuleOptions = {
  type: 'postgres',
  host: 'localhost',
  port: 5432,
  username: 'postgres',
  password: '2qordjr10',
  database: 'board-app',
  entities: [__dirname + '/../**/*.entity.{js,ts}'],
  synchronize: true,
};

• app.module에 연결

@Module({
  imports: [
    TypeOrmModule.forRoot(typeORMConfig),
  ],
})

2. ormconfig.json파일에 쓰는법

• app.module

import { Module } from '@nestjs/common';
import { GraphQLModule } from '@nestjs/graphql';
import { TypeOrmModule } from '@nestjs/typeorm';
import { RestaurantsModule } from './restaurants/restaurants.module';
@Module({
  imports: [
    GraphQLModule.forRoot({
      autoSchemaFile: true,
    }),
    TypeOrmModule.forRoot({
      type: 'postgres',
      host: 'localhost',
      port: 5432,
      username: 'minjaekim',
      password: '2qordjr10',
      database: 'minber-eats',
      synchronize: true,
      // 데이터 베이스에서 모듈의 현재상태로 마이크레이션
      logging: false,
    }),
    RestaurantsModule,
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

2. Configuration

1. npm i --save @nestjs/config

• dotenv 접근 하는 방법, config 패키지를 설치하면 dotenv를 내부에서 사용할 수 있다.

2. npm i cross-env

• 가상 변수를 설정할 수 있게 해준다.

3. "start:dev": "cross-env Env=dev nest start --watch"

• scripts에 cross-env를 적어주고 Env=dev를 적어준다.

• app.module

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { TypeOrmModule } from '@nestjs/typeorm';
@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: process.env.NODE_ENV === 'dev' ? '.env.dev' : '.env.test',
    }),
    TypeOrmModule.forRoot({
      type: 'postgres',
      host: 'localhost',
      port: 5432,
      username: 'minjaekim',
      password: '2qordjr10',
      database: 'minber-eats',
      synchronize: true,
      logging: false,
    }),
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

• isGlobal은 어플리케이션 어디서나 config 모듈 접근 가능하도록 해주고
• envFilePath은 변수를 환경에 따라 다르게 접근 하도록 npm 환경 설정을 해 줄 수 있다.

3. Configuring ConfigService

• 환경변수로 TypeOrmModule.forRoot에 적은 내용을 옮겨준다.

.env.dev

DB_HOST=localhost
DB_PORT=5432
DB_USERNAME=minjaekim
DB_PASSWORD=2qordjr10
DB_NAME=minber-eats]

• app.module

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { TypeOrmModule } from '@nestjs/typeorm';
@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: process.env.NODE_ENV === 'dev' ? '.env.dev' : '.env.test',
      ignoreEnvFile: process.env.NODE_ENV === 'prod',
    }),
    GraphQLModule.forRoot({
      autoSchemaFile: true,
    }),
    TypeOrmModule.forRoot({
      type: 'postgres',
      host: process.env.DB_HOST,
      port: +process.env.DB_PORT,
      username: process.env.DB_USERNAME,
      password: process.env.DB_PASSWORD,
      database: process.env.DB_NAME,
      synchronize: true,
      logging: true,
    }),
    RestaurantsModule,
  ],
  controllers: [],
  providers: [],
})
export class AppModule {}

-ignoreEnvFile은 서버에 배포할 때 환경 변수 파일 사용하지 않도록 하여 prod 환경일 때 ConfigModule은 환경변수 파일을 무시한다.
"start": "cross-env NODE_ENV=prod nest start"

• scripts에 start부분 cross-env NODE_ENV=prod 배포 시에만 되도록 설정하기

4.Joi

• Joi는 자바스크립트 용의 스키마 설명 언어이자 데이터 유효성 검사용 툴이다.

1. npm i joi

• 환경 변수 유효성 검사를 통해서 환경변수들이 준비되지 않으면 앱이 실행 안되록 한다.

2. import * as Joi from 'joi';

• 자바스크립트 패키지는 타입스크립트로 만들어있지 않기때문에 import하는 방식이 다름
• import한 Joi object활용하여 환경 변수마저 유효성 검사를 할 수 있다.

3. Joi는 string이 되어야하며 valid안에 환경 변수들을 적어준다.

ConfigModule.forRoot({
      isGlobal: true,
      envFilePath: process.env.NODE_ENV === 'dev' ? '.env.dev' : '.env.test',
      ignoreEnvFile: process.env.NODE_ENV === 'prod',
      validationSchema: Joi.object({
        NODE_ENV: Joi.string().valid('dev', 'prod').required(),
        DB_HOST: Joi.string().required(),
        DB_PORT: Joi.string().required(),
        DB_USERNAME: Joi.string().required(),
        DB_PASSWORD: Joi.string().required(),
        DB_NAME: Joi.string().required(),
    TypeOrmModule.forRoot({
      type: 'postgres',
      host: process.env.DB_HOST,
      // 숫자가 들어간 string(EX>"5302")을 num으로 바꾸기 위해서+를 앞에 붙여주면됨
      port: +process.env.DB_PORT,
      username: process.env.DB_USERNAME,
      password: process.env.DB_PASSWORD,
      database: process.env.DB_NAME,
      synchronize: true,
      logging: true,
    }),
 

*💡conclusion

• 🔑TypeORM을 쓰는 2가지 방식과 & 🔑Configuring 설정하는 방식에 대해서 알아두잠

#📑Study Source

• 니꼴라스 쌤 우버이츠 강의 중:-