코드로 알아보는 Spring Data Redis의 @Cacheable 동작 원리와 트랜잭션에서 @CachePut/@CacheEvict 실행 시점

글의 목표

Spring Data Redis에서 @Cacheable 메서드를 실행하고, 캐시 미스(Cache miss)로 인해 반환값이 캐시에 저장되는 과정. 그리고, @Transactional과 함께 @CachePut/@CacheEvict를 사용할 경우 @CachePut/@CacheEvict가 언제 실행되는지를 내부 구현을 통해 아는 것이 목표입니다.

 

본 글은 RedisCache에 한정된 내용임을 미리 알려드립니다.

 

Spring Cache 추상화 구조

Spring Cache는 Cache 인터페이스와 CacheManager 인터페이스를 통해 추상화됩니다

This abstraction is materialized by the org.springframework.cache.Cache and org.springframework.cache.CacheManager interfaces.

 

Cache 인터페이스

Cache 는 Spring 이 지원하는 여러 Cache 구현체를 추상화한 인터페이스로 Redis,Caffeine등 다양한 캐시를 손쉽게 교체할 수 있습니다. Cache에는 get(), evict(), put() 등의 메서드가 있으며, 이는 각각 @Cacheable, @CacheEvict, @CachePut 어노테이션과 매칭되도록 구현되어 있습니다.

Cache 인터페이스와 그 구현체들

 

CacheManager 인터페이스

CacheManager 는 이러한 Cache 들을 관리하는 인터페이스입니다.

• getCache(name) : 특정 캐시 가져오기
  • AbstractCacheManager 는 getCache 에서 Cache 가 없을경우, Cache 인스턴스를 생성하도록 구현되어 있습니다. 그리고,  RedisCacheManager 가  AbstractCacheManager 를 상속받고 있습니다. 
• getCacheNames() : 캐시 목록 조회하기

CacheManager 인터페이스와 그 구현체들

 

이 중, TransactionAwareCacheManagerProxy 가 호출하는 TransactionAwareCacheDecorator.class 를 통해 @Transactional 에서 @CacheEvict/Put의 실행 시점을 알아보고, RedisCacheManager.class 를 통해 @Cacheable 동작 원리를 알아가 봅니다.

 

RedisCacheManager

RedisCacheManager는 Spring Data Redis 의존성을 포함할 경우 제공되는 기본 캐시 매니저입니다.

package org.springframework.data.redis.cache; // RedisCacheManager 위치

 

RedisCachManager 의 주요 속성들을 알아보겠습니다.

public class RedisCacheManager extends AbstractTransactionSupportingCacheManager {

    protected static final boolean DEFAULT_ALLOW_RUNTIME_CACHE_CREATION = true;
    private final boolean allowRuntimeCacheCreation; // 기본값은 true 입니다.
    private final RedisCacheConfiguration defaultCacheConfiguration;
    private final RedisCacheWriter cacheWriter;
    private final Map<String, RedisCacheConfiguration> initialCacheConfiguration;

 

1. RedisCacheConfiguration defaultCacheConfiguration

• 기본 값
  • TTL(만료 시간) 없음
  • 캐시 값에 null 허용
  • key의 prefix는 허용(default prefix 는 Cache Key에 "::" 를 붙입니다.)
  • key 직렬화에 사용하는 객체 : StringRedisSerializer
  • value 직렬화에 사용하는 객체 : JdkSerializationRedisSerializer
  • DefaultFormattingConversionService 은 JSR-354 Money & Currency and JSR-310 Date-Time 와 관련되니, 날짜/시간/화폐에 관련있을 것입니다.

 

2. RedisCacheWriter

RedisCacheWriter는 Redis에 대한 저수준 명령어 실행을 담당하는 객체입니다.

RedisCacheWriter provides low-level access to Redis commands (SET, SETNX, GET, EXPIRE,...) used for caching.

class DefaultRedisCacheWriter implements RedisCacheWriter {

    private static final boolean REACTIVE_REDIS_CONNECTION_FACTORY_PRESENT = ClassUtils
          .isPresent("org.springframework.data.redis.connection.ReactiveRedisConnectionFactory", null);

    private final BatchStrategy batchStrategy;
    private final CacheStatisticsCollector statistics;
    private final Duration sleepTime;
    private final RedisConnectionFactory connectionFactory;
    private final TtlFunction lockTtl;
    private final AsyncCacheWriter asyncCacheWriter;

역시 Redis에 대한 명령어를 전송하기 위해 RedisConnectionFactory 를 필드로 갖고 있습니다. RedisConnectionFactory 에 대한 설명은 'RedisTemplate 내부 탐구: Spring Data Redis는 Lettuce를 어떻게 추상화했는가?' 를 참고해주세요.

 

그 외에도, 캐시 히트/미스 통계 수집 담당인 CacheStatisticsCollector도 있습니다.

 

간단하게 정리하자면 RedisCacheManager 가 TTL만료, 직렬화 방식 등을 지정하는 역할, RedisWriter 는 레디스 명령어 실행하는 역할, RedisConnectionFactory 는 이러한 명령어들을 Redis 에 보내는 역할이 됩니다.

 

@Cacheable 동작 과정

@EnableCaching 은 캐싱에 필요한 Spring Component 들을 등록하는 책임을 가지고 있습니다. 예를 들면, @Cacheable이 선언된 메서드를 호출할 때, 캐싱 로직을 가로채서(intercept) 실행하는 CacheInterceptor를 프록시(proxy)로 등록합니다.

In both of the scenarios above, @EnableCaching and <cache:annotation-driven/> are responsible for registering the necessary Spring components that power annotation-driven cache management, such as the CacheInterceptor and the proxy- or AspectJ-based advice that weaves the interceptor into the call stack when @Cacheable methods are invoked.
- @EnableCaching Javadoc 일부

 

@Cacheable 호출 시, 호출 순서

1. @Cacheable 을 호출하면 CacheInterceptor 가 호출됩니다.

2. CacheInterceptor 는 CacheAspectSupport 를 호출하고, CacheAspectSupport 는 findCachedValue() → findInCaches() 통해 Cache 를 조회합니다.(여기서는 RedisCache입니다.)

3. 조회한 Cache 로 findInCaches() 에서 doGet( ) 을 통해 캐시의 Key로 Value를 가져오려 합니다.

CacheAspectSupport 의 findInCaches() 내부 구현

4. doGet( ) 을 따라가보면 RedisCache 가 get( ) 메서드가 호출됩니다.

5. get( ) 은 RedisWriter → RedisConnectionFactory 를 거쳐 Redis에서 Key에 대한 Value을 조회합니다.

6. 만약 Value 가 없다면 getSynchronized() 은 ReentrantLock 을 사용해 동기화 작업을 수행하고, loadCacheValue()를 호출하여 새 Value를 Redis 에 저장합니다.

7. loadCacheValue 과정에서 put( ) 이 실행되며, 최종적으로 Redis에 새로운 Key-Value 가 저장됩니다.

RedisCache 의 get( )

결론

• @Cacheable 호출 시, 해당 키(Key)에 대한 값(Value)이 캐시에 존재하지 않으면 Redis에 새로운 값이 저장됩니다. 이 과정은 Thread-safe하게 이루어집니다.
  • 즉, @Cacheable 을 동시에 3번 호출해도 내부적으로 동기화 되어 정상적으로 3번다 호출된다.(호출 수 만큼 counting 된다고 이해하시면 쉬울 것 같습니다.)
• @Cacheable(sync=true) 옵션은 여러 스레드가 동일한 키에 대해 값을 요청하더라도 오직 하나의 스레드만 메서드를 실행하며, 나머지는 해당 작업이 완료될 때까지 대기한다. 다만, 쓰레드가 대기(Blocking) 되니 캐시 미스가 자주 일어나지 않아야 할 것입니다.

 

@CachePut / @CacheEvict와 @Transactional의 동작 관계

Spring에서 @CachePut과 @CacheEvict를 @Transactional과 함께 사용할 경우, 트랜잭션과 함께 수행될지 여부는 TransactionAwareCacheDecorator 클래스에서 확인할 수 있습니다.

Cache decorator which synchronizes its put, evict and clear operations with Spring-managed transactions (through Spring's TransactionSynchronizationManager), performing the actual cache put/evict/clear operation only in the after-commit phase of a successful transaction. If no transaction is active, put, evict and clear operations will be performed immediately, as usual
- TransactionAwareCacheDecorator 의 Javadoc

 

해당 Javadoc을 확인하면 다음과 같은 동작 방식이 정의되어 있습니다.

 

트랜잭션이 활성화된 경우

• put(저장), evict(제거), clear(전체 삭제) 연산이 즉시 실행되지 않고 대기한다.
• 트랜잭션이 성공적으로 커밋(commit)된 후, after-commit 단계에서 연산이 수행된다.
• 즉, 트랜잭션이 롤백(rollback)되면 캐시 작업도 실행되지 않는다.

트랜잭션이 없는 경우

• put, evict, clear 연산이 즉시 실행된다.
• 일반적인 캐시 동작과 동일함.

•  

Javadoc 에서 설명하는 코드로 TransactionAwareCacheDecorator 의 put 메서드를 가져왔습니다. this.target 은 Cache 인터페이스를 가리키며, afterCommit 임을 확인 할 수 있습니다.

TransactionAwareCacheDecorator 의 put 메서드

위 기능을 활성화 하려면 CacheManager 를 빈으로 등록할 때, transactionAware( ) 옵션을 추가합니다.

/**
 * Enable {@link RedisCache}s to synchronize cache put/evict operations with ongoing Spring-managed transactions.
 * @return this {@link RedisCacheManagerBuilder}.
 */
public RedisCacheManagerBuilder transactionAware() {
    this.enableTransactions = true;
    return this;
}

 

마치며

이번 글에서는 Redis의 직렬화 방식, 비동기 요청 처리, Redis 아키텍처와 같은 부분은 다루지 않고, Spring의 캐시 추상화에 초점을 맞춰 살펴보았습니다.

가끔은 이렇게까지 내부 구현을 깊이 파고들 필요가 있을까? 하는 생각이 들기도 하지만, 직접 하나하나 따라가다 보면 흥미롭기도 하고, 단순히 Javadoc을 읽는 것보다 훨씬 많은 것을 배울 수 있기 때문입니다. 무엇보다 시간이 충분 합니다..ㅎ

 

특히 이번 과정에서 ReentrantLock 이 등장했는데, 만약 이 개념을 몰랐다면 코드를 읽던 도중에 이해가 어려워 포기했을지도 모릅니다. 이를 통해 Java 와 CS 지식이 왜 중요한지 다시 한 번 공감했습니다.

 

이렇게 기술의 내부 구현을 분석할 수 있다면 사용 중 발생하는 문제도 보다 빠르게 해결할 수 있지 않을까? 라는 기대감이 생깁니다. 그리고 후에 인강과 책을 통해서 부족한 내용을 습득함과 동시에 보다 더 이해하기에 쉽지 않을까 생각합니다.

 

 

참고

캐시 추상화 문서 - https://docs.spring.io/spring-framework/reference/integration/cache/strategies.html

캐시 어노테이션 문서 - https://docs.spring.io/spring-framework/reference/integration/cache/annotations.html#cache-annotations-cacheable