TypeORM 자체 캐시 기능 활용 가이드 (feat. Redis)

들어가며

적절한 곳에 캐시를 활용하는 일은 중요한 일이며 어려운 일이기도 합니다. 이번에는 TypeORM에 내장된 기능을 활용하여 Redis에 쿼리 결과를 캐싱하는 방법을 공유해보려고 합니다. 이 방법을 이용하면 코드 상에서의 큰 변경 없이 간편하게 쿼리 결과를 원하는 방식으로 캐싱할 수 있어 저희 팀에서도 유용하게 사용하고 있습니다.

TypeORM에 Redis 설정하기

기본적으로 TypeORM은 db에 쿼리 결과를 저장해 캐싱하는 default 설정 값을 갖고 있습니다. 저희는 빠른 성능을 위하여 Redis에 캐시를 저장하는 설정값을 사용했습니다. 기본적으로 Redis 설정은 TypeORM 설정에서 다음과 같이 설정하면 됩니다. 이외에도 ioredis를 활용해 cluster 설정도 지원합니다.

 cache: {
    type: 'redis',
    options: {
        host: 'localhost',
        port: 6379
    }
}

Cache 설정하기

캐시 설정은 createQueryBuilder를 사용하는 경우와 find, count 메소드를 사용하는 두가지 경우 모두 가능합니다.

먼저 createQueryBuilder를 사용하는 경우 입니다. 총 3가지 방법으로 설정할 수 있습니다.

// 기본 설정 (기본 만료 시간: 1s)
const posts = await dataSource
  .createQueryBuilder(Post, "post")
  .where("post.isPublic = :isPublic", { isPublic: true })
  .cache(true)
  .getMany();

// 만료 시간 설정 (5000ms)
const posts = await dataSource
  .createQueryBuilder(Post, "post")
  .where("post.isPublic = :isPublic", { isPublic: true })
  .cache(5000)
  .getMany();

// id, 만료 시간 설정 (5000ms)
const posts = await dataSource
  .createQueryBuilder(Post, "post")
  .where("post.isPublic = :isPublic", { isPublic: true })
  .cache("posts_public", 5000)
  .getMany();

find, count 메소드를 사용하는 경우도 2가지 방법으로 설정이 가능합니다.

// 기본 설정 (기본 만료 시간: 1s)
const posts = await dataSource.getRepository(Post).find({
  where: { isPublic: true },
  cache: true,
});

// id, 만료 시간 설정 (5000ms)
const posts = await dataSource.getRepository(Post).find({
  where: { isPublic: true },
  cache: {
    id: "posts_public",
    milliseconds: 5000,
  },
});

캐시 만료 시간 설정

상기 설명대로 TypeORM에서 지원하는 캐시는 만료 시간을 자유롭게 지정할 수 있습니다. 해당 시간은 캐싱하려는 데이터의 성격 등을 고려하여 설정할 수 있습니다. 저희는 캐시 시간을 1초로 설정하여 캐시 만료에 대한 관리포인트를 줄이며, 동시에 1초 안에 접속하는 스파이크 트래픽을 대비할 수 있도록 만료 시간을 설정하였습니다.

마치며

지금까지 TypeORM 자체 캐시 기능을 이용하여 캐싱을 구현하는 방법에 대해 알아보았습니다. TypeORM에 캐시를 도입하시려는 분들게 도움이 되었으면 좋겠습니다. 감사합니다.

참고자료

https://orkhan.gitbook.io/typeorm/docs/caching