[TypeORM] Start with Nest

TypeOrm은 대표적인 타입스크립트 기반의 ORM 라이브러리다.
Sequelize는 타입스크립트 지원이 부실하고, Prisma 같은 후발주자들은 좀 불안정하기 때문에,
타입스크립트 환경에서 ORM을 사용한다면 1순위로 선택되는 친구다.

아무데나 붙여도 되지만, 여기서는 Nest에 붙여보면서 테스트를 간략하게 해보겠다.

설치

설치는 다음과 같이 할 수 있다.
typeorm 모듈과 사용할 DB 모듈을 설치한다.

나는 postgres를 주로 사용하기 때문에 pg를 설치했는데, mysql을 사용한다면 mysql을 깔면 된다.
아래는 DB에 따른 추가 설치 모듈이다.

알다시피 Nest의 강력한 강점 중 하나가 의존성 주입을 통한 객체의 공유와 사용이다.
따라서 데이터베이스 커넥션 객체를 만들되, 의존성 주입으로 해당 커넥션을 갖다쓸 수 있도록 할 것이다.

커넥션 설정하기

이를 위한 프로바이더 소스 database.ts를 작성한다.
데이터베이스 접속 정보들을 잘 써주면 된다.

import { Connection, createConnection } from 'typeorm';

export const databaseProvider = {
  provide: Connection,
  useFactory: async () =>
    await createConnection({
      type: 'postgres',
      host: 'localhost',
      port: 5432,
      username: 'nest_user',
      password: 'asdf123',
      database: 'nest_test',
      entities: [__dirname + '/../**/*.entity{.ts,.js}'],
      synchronize: true,
      logging: 'all',
    }),
};

여기선 초기 생성단계라 synchronize: true, 옵션을 줬는데, 계속 이러면 실행하거나 바뀔때마다 강제로 테이블를 리셋할 수가 있다.
그래서 제대로 배포를 했을 때는 false로 주고 안전하게 잘 관리해야 한다.

그리고 데이터베이스 커넥션을 주입하기 위해서, 이걸 모듈에 넣어준다.
나는 database.module이라는 별도의 모듈을 정의해서

import { Module } from '@nestjs/common';
import { databaseProvider } from './../provider/database';

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

루트모듈에 넣어주도록 했다.

import { Module } from '@nestjs/common';
import { AppController } from './../controller/app.controller';
import { AppService } from './../app.service';
import { DatabaseModule } from './database.module';

@Module({
  imports: [DatabaseModule],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

프로바이더를 그냥 루트에 때려박아도 되긴 하는데 공식문서에서 그러길래 똑같이 했다.

엔티티 정의하기

그럼 이제 매핑시킬 엔티티 클래스를 정의한다.
실제 테이블과 1:1로 매칭될 데이터 구조다.
나는 User 테이블과 그 사용자들이 작성하는 Post에 대한 테이블 2개를 작성하겠다.

// user.entity.ts
import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn() // 기본키
  id: number;

  @Column()
  email: string;

  @Column()
  password: string;

  @Column()
  name: string;
}

// post.entity.ts
import { Entity, Column, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class Post {
  @PrimaryGeneratedColumn()
  id: number;

  @Column()
  user_id: string;

  @Column()
  content: string;
}

특별할 것은 없다.
@Entity 데코레이터로 해당 타입이 테이블에 매칭될 구조임을 명시하고, 필드마다 Column 데코레이터를 달아서 테이블 컬럼임을 명시하면 된다.
PrimaryGeneratedColumn는 기본키 컬럼용 데코레이터다.

특별한 경우가 아니면 typeorm이 필드 타입을 읽어서 컬럼타입도 알아서 잘 맞춰주는데, 컬럼타입을 직접 지정하고 싶다면 아래와 같이

@Column('TEXT')
user_id: string;

데코레이터에 문자열 인자로 써주면 된다.

커넥션 주입하기

위에서 만든 커넥션을 이제 갖다써보자.
방법은 쉽다. 컨트롤러 필드 아무데나

이런식으로 박아두면 된다.
nest가 위에서 정의한 커넥션을 읽어서 잘 넣어준다.

쿼리 빌더

그러면 이제 커넥션을 기반으로 해서, 쿼리빌더 등으로 쿼리를 작성해서 사용할 수 있을 것이다.
다음은 데이터를 하나 삽입하는 쿼리다.
into에 삽입할 테이블 엔티티를 전달, values에 삽입할 데이터를 넣고,
execute로 쿼리를 실행하면 데이터가 삽입될 것이다.

위의 api를 실행한다면

동기화 옵션을 줬으니 없는 테이블은 자동으로 생성되었을 것이고

데이터도 삽입되었을 것이다.

select를 하고 싶다면 아래와 같은 식으로 할 수 있다.

select는 select 쿼리를 날리겠다는 것이고, from은 읽어올 테이블이다.
쿼리빌더는 빌더 패턴으로 구축된 구조라, 전부 위처럼 메서드 체이닝으로 쿼리 구조를 생성한다.

이외에도 쿼리빌더에는 다양한 기능들이 있고, 외에도 repository 패턴 등의 화려한 기능들이 존재하나.
자세한 것들은 다음 포스트에서 천천히 다루도록 하겠다.

참조
https://docs.nestjs.com/recipes/sql-typeorm
https://orkhan.gitbook.io/typeorm/docs/logging