[Node.js] TypeORM이란? (feat. ORM Library)

안녕하세요 Foma 입니다!

 

오늘은 저번 글 Sequelize에 이어서 Node.js ORM 라이브러리인 TypeORM에 대해서 다뤄보려고 합니다.

 

평소에 Typescript로 개발하는 것을 선호하기 때문에 "Sequelize를 Typescript로 개발할 수 있나?" 하고 찾아봤더니

 

Typescript 기반으론 TypeORM 라이브러리를 많이 사용하는 것 같더라구요.

 

(물론 Sequlize도 Typescript를 지원합니다. 여기 에서 확인하실 수 있습니다.)

 

그래서 오늘은 TypeORM이 무엇인지에 대해 정리해 보려고 합니다.

 

바로 시작할게요~

---

ORM이란?

 

먼저 Sequelize를 알기 위해서 ORM의 개념을 알아야 하는데요.

 

그 이유는 바로 Sequelize가 Node.js의 ORM 라이브러리이기 때문이죠.

 

ORM은 Object Relational Mapping의 줄임말로 객체와 관계를 매핑해주는 것 입니다.

 

 

좀 더 구체적으로 객체와 관계를 매핑해준다는 게 어떤 것일까요?

 

예를 들면 객체 지향 언어에서는 모델을 정의할 때 Class를 사용하고, 관계형 데이터 베이스에선 Table을 사용합니다.

 

바로 여기서 객체 지향 언어로 된 Class를 관계형 데이터 베이스의 Table와 연결시켜 준다는 것이죠.

 

이것은 직접 SQL문을 작성하지 않고, 객체 지향적으로 코드를 작성할 수 있도록 도와주는 것이죠.

 

(ORM에 더 깊이 알고 싶으신 분들은 여기 에서 확인해 주세요!)

---

TypeORM이란?

 

공식 홈페이지에서는 아래와 같이 소개하고 있습니다.

 

TypeORM is an ORM that can run in NodeJS, Browser, Cordova, PhoneGap, Ionic, React Native, NativeScript, Expo, and Electron platforms and can be used with TypeScript and JavaScript (ES5, ES6, ES7, ES8). Its goal is to always support the latest JavaScript features and provide additional features that help you to develop any kind of application that uses databases - from small applications with a few tables to large scale enterprise applications with multiple databases.
TypeORM supports both Active Record and Data Mapper patterns, unlike all other JavaScript ORMs currently in existence, which means you can write high quality, loosely coupled, scalable, maintainable applications the most productive way.
TypeORM is highly influenced by other ORMs, such as Hibernate, Doctrine and Entity Framework.

 

간단하게 해석하면 아래와 같습니다.

 

" TypeORM은 Node.js, Browser, React Native 플랫폼 등에서 JS,TS와 함께 사용할 수 있는 ORM입니다. 소규모 데이터베이스부터 대규모 엔터프라이즈 어플리케이션을 개발하는데 도움이 되는 추가 기능을 제공하는 것을 목표로 합니다. 다른 ORM과 달리 액티브 레코드 패턴과 데이터 매퍼 패턴을 모두 지원하여 확장 가능하며 유지보수가 가능한 어플리케이션을 가장 생산적인 방법으로 작성할 수 있습니다. "

---

Active Record Pattern이란?

 

액티브 레코드 패턴은 모델 자체 내에서 모든 쿼리 메서드를 정의하고 모델 메서드를 사용하여 오브젝트를 생성,삭제,조회,수정할 수 있게 하는 방식을 의미합니다.

 

아래와 같이 User 모델의 프로퍼티와 메서드를 정의할 수 있습니다.

 

 

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()
    }
}

 

위 User 모델을 이용하여 user 객체를 이미 구현된 메서드로 간단하게 생성, 삭제, 조회, 수정할 수 있습니다.

 

또한 위에서 User 모델에 직접 커스텀하여 구현한 메서드 또한 아래와 같이 사용할 수 있습니다.

 

const user = new User()
user.firstName = "Timber"
user.lastName = "Saw"
user.isActive = true
await user.save()

await user.remove()
const users = await User.find({ skip: 2, take: 5 })
const newUsers = await User.findBy({ isActive: true })
const timber = await User.findOneBy({ firstName: "Timber", lastName: "Saw" })
//구현한 메서드
const timber = await User.findByName("Timber", "Saw")

---

Data Mapper Pattern이란?

 

데이터 매퍼 패턴은 "레포지토리" 라는 별도의 클래스에서 모든 쿼리 메서드를 정의하고 이 "레포지토리"를 사용하여 오브젝트를 생성, 삭제, 조회, 수정할 수 있습니다.

 

액티브 레코드 패턴과 같이 User 모델을 정의해 줍니다.

 

차이점은 User 모델을 BaseEntity로 확장하지 않습니다.

 

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

@Entity()
export class User {
    @PrimaryGeneratedColumn()
    id: number

    @Column()
    firstName: string

    @Column()
    lastName: string

    @Column()
    isActive: boolean
}

 

아래와 같이 User의 레포지토리를 가져와 User 레포지토리에 생성, 삭제, 조회, 수정을 할 수 있습니다.

 

const userRepository = dataSource.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.findBy({ isActive: true })
const timber = await userRepository.findOneBy({
    firstName: "Timber",
    lastName: "Saw",
})

---

느낀 점

 

Sequelize를 다뤄보았을 때 모델을 만들고 직접 시퀄을 작성하지 않는다는 점에서 진짜 편리하고 혁명적인 라이브러리라고 생각했다.

 

근데 TypeORM을 발견하고 사용해 보니깐 모델을 만드는 부분이나 , 메서드를 사용하는 점에서 더 직관적이고, 뭔가 백엔드를 프론트 엔드처럼 개발할 수 있다는 걸 느끼게 되었다.

 

장단점이 있겠지만 둘 중에 하나를 고른다면 TypeORM을 사용할 것 같다.

---

Reference

 

Active Record vs Data Mapper - typeorm