RedisTemplate 내부 탐구: Spring Data Redis는 Lettuce를 어떻게 추상화했는가?

Lettuce 가 무엇인지, Spring Data Redis의 RedisTemplate 은 Lettuce 를 어떻게 추상화했는지 알아보고자 합니다.

 

먼저, Spring Data Redis 는 Lettuce와 Jedis 라는 2개의 오픈 소스 라이브러와 통합되었습니다.

Spring Data Redis integrates with Lettuce and Jedis, two popular open-source Java libraries for Redis.

 

Lettuce와 Jedis는 "Java에서 Redis에 접근하여 데이터를 주고받을 수 있도록 도와주는 라이브러리"입니다.

그렇다면 각각 무엇인지 Lettuce부터 알아보겠습니다.

Lettuce 란?

Lettuce is a scalable thread-safe Redis client for synchronous, asynchronous and reactive usage. Multiple threads may share one connection if they avoid blocking and transactional operations such as BLPOP and MULTI/EXEC. Lettuce is built with netty. 

• Lettuce 는 동기(Synchronous), 비동기(Asynchronous), 리액티브(Reactive) 방식을 지원하며, Thread-Safe 합니다.
• BLPOP, MULTI/EXEC과 같은 블로킹(Blocking) 및 트랜잭션 명령어를 피하는 경우, 1개의 Native Connection(StatefulRedisConnection)을 여러 스레드에서 공유할 수 있습니다.
• Lettuce 는 Netty (비동기 I/O 라이브러리) 기반입니다.

Spring Data Redis 에서 Lettuce 사용 방식

Spring Boot에서 Spring Data Redis 의존성을 추가하면, 기본적으로 Jedis가 아닌 Lettuce가 자동 구성(auto configuration)됨을 확인할 수 있습니다.

auto configure된 Lettuce 라이브러리

 

 

이 의존성이 추가되면 Lettuce 를 추상화하여 쉽게 사용할 수 있도록 Spring Data Redis가 LettuceConnectionFactory와 LettuceConnection을 제공합니다.(Redis Config 할 때, 자주 보던 애들입니다)

Spring Data Redis의 내부 코드에서는 RedisConnection 의 구현체는 LettuceConnection 이며, 편의상 LettuceConnection 이라고 하겠습니다.

 

정리하자면 Spring 은 LettuceConnectionFactory 와 LettuceConnection, Lettuce 는 Native Connection 을 제공한다는 것을 기억해주세요.

 

LettuceConnectionFactory의 기본 동작

LettuceConnectionFactory의 Javadoc을 보면, 기본적으로 여러 개의 LettuceConnection은 하나의 Native Connection을 공유하여 사용합니다. 따라서, Blocking 연산을 실행하면 Native Connection이 막히게 됩니다.  

While multiple LettuceConnections share a single thread-safe native connection by default

 

만약 BLPOP과 같은 Blocking 명령어를 사용해야 한다면, LettuceConnectionFactory.setShareNativeConnection(false)로 설정하는 방법이 있습니다. 다만, LettuceConnection 를 사용하게 될 때마다 TCP 소켓이 열리고 닫히게 될 것입니다.

LettuceConnectionFactory.setShareNativeConnection( ) 의 Javadoc

LettuceConnection 생성 방식과 RedisTemplate 의 역할

LettuceConnection(RedisConnection) 는 Thread-safe 하지 않습니다.

즉, LettuceConnection을 여러 스레드에서 공유하면 안 되므로, 스레드마다 새로운 인스턴스를 생성해야 합니다.

RedisConnection classes are not Thread-safe. Spring Data Redis’s LettuceConnection class itself is not. Therefore, you should not share instances of a RedisConnection across multiple Threads.

 

이 역할을 RedisTemplate이 수행합니다.

RedisTemplate은 Redis로 요청을 보낼 때 마다 새로운 LettuceConnection을 생성합니다.

 

RedisTemplate의 Connection 획득 과정

RedisTemplate은 execute() 메서드를 통해 Redis와 통신하며, 이때 내부적으로 RedisConnectionUtils.getConnection()을 호출하여 Connection을 가져옵니다.

RedisTemplate.execute( ) → getConnection( )

 

RedisConnectionUtils.getConnection 을 타고 내려가다 보면 doGetConnection 메서드를 볼 수 있습니다.

그리고, doGetConnection 의 fetchConnection 으로 들어가겠습니다.

RedisConnectionUtils.doGetConnection( ) → fetchConnection( )

 

fetchConnection 에는 factory.getConnection( )이 있습니다.

해당 메서드는 RedisConnectionFactory의 getConnection() 로, 호출할 때마다 LettuceConnection 인스턴스를 생성합니다.

RedisConnectionUtils.fetchConnection( ) → RedisConnectionFactory.getConnection()

 

이러한 동작 방식으로 인해 RedisTemplate은 요청마다 새로운 LettuceConnection을 획득하게 됩니다.
따라서, RedisTemplate은 Bean으로 등록하여 싱글톤으로 사용하게 되고, 내부적으로 각 요청마다 새로운 LettuceConnection 인스턴스를 생성합니다.

 

그리고, 생성된 LettuceConnection들이 사용하는 Native Connection은 재활용됩니다.

 

실험 1. LettuceConnection은 재사용되지 않음

@DataRedisTest
public class RedisConnectionTest {

    @Autowired
    private RedisTemplate<String, String> redisTemplate;

    @DisplayName("RedisTemplate에서 Lettuce Connection은 재사용되지 않는다.")
    @Test
    void test() {
        // given
        RedisConnectionFactory connectionFactory = redisTemplate.getConnectionFactory();

        RedisConnection connection1 = connectionFactory.getConnection();
        System.out.println("첫 번째 Connection: " + connection1);

        RedisConnection connection2 = connectionFactory.getConnection();
        System.out.println("두 번째 Connection: " + connection2);

        // when then
        System.out.println("같은 LettuceConnection인가? " + (connection1 == connection2));
        Assertions.assertThat(connection1).isNotSameAs(connection2);
    }
}

 

실험 결과 - false

첫 번째 Connection: org.springframework.data.redis.connection.lettuce.LettuceConnection@37fca349
두 번째 Connection: org.springframework.data.redis.connection.lettuce.LettuceConnection@86377d5
같은 LettuceConnection인가? false

 

실험 2. Native Connection은 재사용됨

 

@DisplayName("RedisTemplate에서 Native Connection은 재사용된다.")
@Test
void test1() {
    // given
    RedisConnectionFactory connectionFactory = redisTemplate.getConnectionFactory();

    Object nativeConnection1 = connectionFactory.getConnection().getNativeConnection();
    System.out.println("첫 번째 Native Connection: " + nativeConnection1);

    Object nativeConnection2 = connectionFactory.getConnection().getNativeConnection();
    System.out.println("두 번째 Native Connection: " + nativeConnection2);

    // when then
    System.out.println("같은 Native Connection인가? " + (nativeConnection1 == nativeConnection2));
    Assertions.assertThat(nativeConnection1).isSameAs(nativeConnection2);
}

 

실험 결과 - true

 

첫 번째 Native Connection: io.lettuce.core.RedisAsyncCommandsImpl@37fca349
두 번째 Native Connection: io.lettuce.core.RedisAsyncCommandsImpl@37fca349
같은 Native Connection인가? true

 

Lettuce 는 트랜잭션 동기화를 하지 않는다

Lettuce에서 단일 Native Connection을 여러 스레드/프로세스에서 공유하면,

• Spring에서는 여러 개의 LettuceConnection이 하나의 Native Connection을 공유합니다

트랜잭션 연산 시 외부에서 동기화가 필요합니다.

• Spring 에서 트랜잭션 명령어인 MULTI 를 Redis에게 보낼 경우, Spring에서 트랜잭션을 위해 동기화가 필요합니다.

Transactional use requires external synchronization when a single connection is used by multiple threads/processes.
출처 - https://github.com/redis/lettuce/wiki/Transactions

 

Spring의 Redis 트랜잭션 지원

RedisTemplate의 setEnableTransactionSupport(true) 메서드를 호출하면, Spring의 트랜잭션에 RedisTemplate이 참여하도록 설정할 수 있습니다.

RedisTemplate 에 setEnableTransactionSupport 메서드

 

트랜잭션 지원을 활성화하면, 하나의 LettuceConnection만 현재 트랜잭션에 바인딩되며,
이는 ThreadLocal을 기반으로 관리되어 트랜잭션 내에서 동일한 LettuceConnection을 유지할 수 있도록 합니다.

"Enabling transaction support binds RedisConnection to the current transaction backed by a ThreadLocal"

 

그리고, Spring에서 Redis 트랜잭션을 사용하려면 다음 3가지를 만족해야 합니다.

• Spring 컨텍스트에서 선언적 트랜잭션 관리 활성화 (@EnableTransactionManagement 추가)
• RedisTemplate이 트랜잭션에 참여하도록 설정 (setEnableTransactionSupport(true))
• 트랜잭션을 관리하기 위한 PlatformTransactionManager 등록
  • Spring Data Redis 자체적으로 PlatformTransactionManager 구현체를 제공하지 않음
  • JDBC 기반의 트랜잭션 관리자를 활용하여 Redis 트랜잭션을 함께 관리 가능

하지만, Spring Boot 에서는 RedisTemplate 에 setEnableTransactionSupport(true) 설정만을 추가하면 됩니다.

 

@EnableTransactionManagement 와 PlatformTransactionManager 등록은 spring-data* 의존성이 있다면(redis 제외), 'TransactionAutoConfiguration.class' 에 의해 Spring Boot에서 자동 구성됩니다.

출처 - @EnableTransactionManagement in Spring Boot 의 3번째 답변을 보시는 것을 추천드립니다.

 

Spring Data Redis에서 트랜잭션의 읽기/쓰기 명령 구분

Spring Data Redis는 진행 중인 트랜잭션 내에서 읽기(Read) 명령과 쓰기(Write) 명령을 구분합니다.

• 읽기 명령(예: KEYS)은 새로운(non-thread-bound) RedisConnection을 통해 실행됩니다. 이는 트랜잭션이 진행되는 동안에도 읽기 작업을 수행할 수 있도록 하기 위함입니다.
• 쓰기 명령(예: SET)은 RedisTemplate에서 큐에 저장되었다가 트랜잭션이 커밋될 때 한꺼번에 실행됩니다.

Transaction 관련 Code 는 Spring Data Redis - Redis Transactions 참고 해주세요.

 

Lettuce와 Jedis 비교

Lettuce는 이외에도 메시지를 발행하고 구독하는 Pub/Sub 기능, Reactive API, 비동기 API를 지원합니다.

또한, Redis Replication, Sentinel, Cluster 기능들도 지원합니다.

* replication, sentinel, cluster 는 Redis 아키텍처이며, 저도 학습해야할 내용이라 자세하게 설명드릴 수 없지만, 궁금하시다면 '[Youtube] Redis 야무지게 사용하기' 에서 확인할 수 있습니다. 

 

반면 Jedis는 동기I/O 방식이기 때문에 비동기 I/O인 Lettuce보다 느리다고 하는데요. 두 라이브러리 간의 성능을 실험한 글인 'Jedis 보다 Lettuce 를 쓰자' 에서도 많은 성능 차이를 보입니다.

 

하지만, Lettuce는 비동기I/O인 만큼 문제가 발생했을 때, 디버깅하기가 어렵다는 단점이 존재합니다. 그리고, Jedis보다 읽어야 한 내부 코드도 더 많을 것이구요.

결론

• Spring Boot 에서 기본적으로 LettuceConnectionFactory를 사용할 경우, 여러 개의 LettuceConnection이 하나의 Native Connection을 공유하는 방식이 기본 설정
• Lettuce는  Pub/Sub 기능, Reactive API, 비동기 API, 고가용성을 위한 Redis Replication, Sentinel, Cluster 기능들도 지원
• 설정을 통해 Redis의 명령어들을 Spring Boot에서 원자적이게 실행되도록 구현이 가능하다.
• RedisTemplate은 Bean으로 등록하여 싱글톤으로 사용하게 되고, 내부적으로 각 요청마다 새로운 LettuceConnection 인스턴스를 생성한다. 하지만, 생성된 LettuceConnection들이 사용하는 Native Connection은 재활용된다.

마치며

캐싱 전략을 공부하려다 Redis 클라이언트를 살펴보게 되었는데, 덕분에 RedisTemplate을 사용하기 전에 그 동작 방식까지 깊이 이해하게 된 것 같습니다. 또한, 과거에 Spring Data JPA를 공부할 때 JPA 자체를 먼저 이해해야 Data JPA를 제대로 활용할 수 있었던 것처럼, 이번에도 Spring Data Redis가 Lettuce를 얼마나 추상화했는지, RedisTemplate 을 통해 알게 되는 좋은 기회였습니다.

 

참고 문서

Spring Data Redis - RedisTemplate

Spring Data Redis - Drivers

Jedis vs. Lettuce: An Exploration

Spring Data Redis - Redis Transactions

Jedis Github

Lettuce Github 

Spring data redis(lettuce connector) 쓰기 전에 알았다면 좋았을 것들

Redis Docs - Transactions