TypeORM 시작하기

조성철 (JoSworkS)·2020년 2월 1일

구독형 거주 서비스 BillyZip

목록 보기

4/22

이번 BillyZip 프로젝트에서는 Stroll에서 사용하였던 스택들은 물론 조금 더 다양한 스택들을 활용해보고자 하였다. Stroll에서 사용한 ORM인 Sequelize 대신에 타입스크립트와 더 잘 맞고 Active Record 패턴을 지원하는 typeORM을 사용하기로 하였다.

TypeORM을 사용하기에 앞서 TypeORM의 개요와 아래 링크를 통해 Active Record & Data Mapper 패턴을 알아보았다.
https://github.com/typeorm/typeorm/blob/master/docs/active-record-data-mapper.md

TypeORM 개요

express와 관계형 데이터베이스를 조합할 때 자주 사용되는 ORM으로 Sequelize가 있지만, 타입스크립트의 확대와 더불어 인기를 얻고 있는 ORM이 typeORM이다.

typeORM이라는 이름으로 인해 타입스크립트 전용의 ORM같이 느껴지지만, 자바스크립트(ES5, ES6, ES7)도 지원하고 있다.

TypeORM을 사용하여 개발을 하면 Python의 SQLAlchemy와 같은 Data Mapper 패턴과 Rails와 같은 Active Record 패턴으로 개발할 수 있다. 그리고 모델의 정의를 제대로 하면 타입을 정하는 메리트를 최대한으로 얻을 수 있고, 복잡한 모델간의 관계를 형성할 수 있다는 장점이 있다.

Active Record 패턴

TypeORM에서는 Active Record 패턴과 Data Mapper 패턴 두 종류의 패턴을 사용할 수 있으며 공식문서의 내용을 참고하여 서술하도록 하겠다.

먼저 Active Record 패턴은 모델 그 자체에 쿼리 메소드를 정의하고, 모델의 메소드를 사용하여 객체를 저장, 제거, 불러오는 방식이다.

아래는 공식문서의 예제 코드이며 BaseEntity라는 클래스를 사용하여 새로운 클래스에 상속하게 한 후 사용할 수 있다. 이를 통해 BaseEntity가 갖고 있는 메소드와 static으로 만들어 내는 커스텀 메소드를 이용할 수 있다.

import {BaseEntity, Entity, PrimaryGeneratedColumn, Column} from "typeorm";

@Entity()
export class User extends BaseEntity {

    @PrimaryGeneratedColumn()
    id: number;

    @Column()
    firstName: string;

    @Column()
    lastName: string;

    @Column()
    isActive: boolean;

    static findByName(firstName: string, lastName: string) {
        return this.createQueryBuilder("user")
            .where("user.firstName = :firstName", { firstName })
            .andWhere("user.lastName = :lastName", { lastName })
            .getMany();
    }
}

아래는 공식문서에 있는 Active Record 예제코드이다.
아래와 같이 Acitve Record 패턴은 DB 엔티티에 직접 다룰 수 있도록 new 키워드를 이용하여 새로운 인스턴스를 만들어 사용하는 것이 가능하다.

이런걸 보면 자바스크립트의 방식을 이용하여 DB를 다룰 수 있게 해주는 ORM의 역할이 얼마나 개발자에게 편리함을 가져다 주는지 알 수 있다.

// example how to save AR entity
const user = new User();
user.firstName = "Timber";
user.lastName = "Saw";
user.isActive = true;
await user.save();

// example how to remove AR entity
await user.remove();

// example how to load AR entities
const users = await User.find({ skip: 2, take: 5 });
const newUsers = await User.find({ isActive: true });
const timber = await User.findOne({ firstName: "Timber", lastName: "Saw" });
const timber = await User.findByName("Timber", "Saw");

Data Mapper 패턴

Data Mapper 패턴은 분리된 클래스에 쿼리 메소드를 정의하는 방식이며, Repository를 이용하여 객체를 저장, 제거, 불러온다.
Active Record 패턴과의 차이점은 모델에 접근하는 방식이 아닌 Repository에서 데이터에 접근한다는 것이다.

아래는 공식문서의 예제 코드이다. 먼저 클래스를 정의한다.

import {Entity, PrimaryGeneratedColumn, Column} from "typeorm";

@Entity()
export class User {

    @PrimaryGeneratedColumn()
    id: number;

    @Column()
    firstName: string;

    @Column()
    lastName: string;

    @Column()
    isActive: boolean;

}

정의한 클래스를 Generic 타입을 이용하여 상속하게 한다.

import {EntityRepository, Repository} from "typeorm";
import {User} from "../entity/User";

@EntityRepository()
export class UserRepository extends Repository<User> {

    findByName(firstName: string, lastName: string) {
        return this.createQueryBuilder("user")
            .where("user.firstName = :firstName", { firstName })
            .andWhere("user.lastName = :lastName", { lastName })
            .getMany();
    }

}

그리고 getRepository()를 사용하여 만들어진 모델을 사용한다.

const userRepository = connection.getRepository(User);

// example how to save DM entity
const user = new User();
user.firstName = "Timber";
user.lastName = "Saw";
user.isActive = true;
await userRepository.save(user);

// example how to remove DM entity
await userRepository.remove(user);

// example how to load DM entities
const users = await userRepository.find({ skip: 2, take: 5 });
const newUsers = await userRepository.find({ isActive: true });
const timber = await userRepository.findOne({ firstName: "Timber", lastName: "Saw" });