Spring Data Redis의 @Indexed 사용 시 주의점

@Indexed란?

@Indexed는 Spring Data Redis 모듈의 주요 어노테이션 중 하나입니다. 주 목적으로는 Redis의 보조 인덱스(Secondary Index) 생성에 사용되며,  @Id가 붙여진 객체 외에도 @Indexed가 붙여진 객체로도 값을 조회할 수 있게 합니다.

예를 들어, 아래의 코드에서는 id뿐만 아니라 name으로도 데이터를 검색할 수 있습니다.

@RedisHash("Person")
public class Person {

    @Id
    private String id;
    
    @Indexed
    private String name;
    
    private int age;
}

 

예시

한번 Person("dkswnkk", "JuHyeong", 26)을 저장한다고 가정해 보겠습니다.

@Indexed 없이 저장한 경우

@RedisHash("Person")
public class Person {

    @Id
    private String id;
    
    private String name;
    
    private int age;
}

Redis 로그

"HMSET" "Person:dkswnkk" "_class" "com.example.test.Person" "age" "26" "id" "dkswnkk" "name" "JuHyeong"

 

@Indexed를 사용하여 저장한 경우

@RedisHash("Person")
public class Person {

    @Id
    private String id;
    
    @Indexed
    private String name;
    
    private int age;
}

Redis 로그

"HMSET" "Person:dkswnkk" "_class" "com.example.test.Person" "age" "26" "id" "dkswnkk" "name" "JuHyeong"
"SADD" "Person:name:JuHyeong" "dkswnkk"
"SADD" "Person:dkswnkk:idx" "Person:name:JuHyeong"

로그에서 볼 수 있듯, "Person:name:JuHyeong" "dkswnkk"를 보면 보조 인덱스가 실제로 저장되었음을 알 수 있고, Redis에서 객체의 CRUD 작업을 수행할 때 관련된 보조 인덱스도 함께 업데이트해야 하기에 추가적인 Redis 명령어가 실행되는 것을 확인할 수 있습니다.
 

주의점

여기서 주의할 점은 Time to Live(TTL) 설정 시입니다. Redis에서 TTL은 특정 키에 대한 만료 시간을 설정하는 기능으로 설정된 시간이 지나면 해당 키와 연관된 데이터는 자동으로 삭제됩니다. 하지만 @Indexed로 생성된 보조 인덱스는 해당 데이터의 TTL이 만료되더라도 자동으로 삭제가 되지 않습니다.

때문에 이를 인지하지 못하고 삭제하지 않는다면, 불필요한 보조 인덱스 데이터가 Redis에 계속 남게 되어 메모리 낭비와 잘못된 조회 결과를 초래할 수 있습니다.

실제로 테스트를 해보면 다음과 같습니다.

[Person 객체 저장]

"HMSET" "Person:dkswnkk" "_class" "com.example.test.Person" "age" "26" "id" "dkswnkk" "name" "JuHyeong"
"SADD" "Person:name:JuHyeong" "dkswnkk"
"SADD" "Person:dkswnkk:idx" "Person:name:JuHyeong"

 
[TTL 10초로 설정]

"EXPIRE" "Person:dkswnkk" "10"

 
[10초 후 확인]

"Person:name:JuHyeong"
"Person:dkswnkk:idx"

로그를 보면 10초 후, "Person:dkswnkk" 데이터는 정상적으로 삭제되었지만, "Person:name:JuHyeong"와 "Person:dkswnkk:idx"에 관련된 보조 인덱스 값들은 여전히 남아있는 것을 확인할 수 있습니다.

이러한 원인은 @Indexed 기능이 Redis에서 자체적으로 지원하는 기능이 아니라, Spring Data Redis에서 제공하는 추가 기능이기 때문입니다. 따라서 Redis의 TTL이 만료된 데이터를 자동으로 삭제하는 기능에, Spring Data Redis의 @Indexed로 생성된 보조 인덱스까지 삭제하는 과정이 포함되어있지 않아 삭제가 되지 않는 것입니다.
 

해결방안

Redis의 Key Space Notifications 기능을 활용하면, TTL이 만료되는 시점에 이벤트를 감지하고, 보조인덱스를 삭제할 수 있습니다.

@Configuration
@EnableRedisRepositories(enableKeyspaceEvents = RedisKeyValueAdapter.EnableKeyspaceEvents.ON_STARTUP)
public class RedisConfig {
     //... Configuration details
}

위와 같이 @EnableRedisRepositories(enableKeyspaceEvents = RedisKeyValueAdapter.EnableKeyspaceEvents.ON_STARTUP)를 Redis Config 부분에 명시해 주면 Redis의 Key Space Notifications 기능이 활성화됩니다.

Spring Data Redis는 이 Key Space Notifications 기능을 사용하여 TTL 만료 이벤트를 감지하고, 이를 통해 @Indexed로 지정된 보조 인덱스를 함께 삭제합니다. 

동작 원리는 다음과 같습니다.

1. enableKeyspaceEvents 옵션이 ON_STARTUP으로 설정되면, Spring Data Redis는 애플리케이션을 시작할 때 Redis의 Key Space Notifications 기능을 활성화시킨다.
2. 이후, Redis에 저장된 데이터의 TTL이 만료되면, Redis는 해당 데이터를 삭제하고 이에 관한 알림을 발생시킨다.
3. Spring Data Redis는 이 알림을 감지하고, 해당 데이터와 연결된 보조 인덱스(즉, @Indexed가 붙은 객체)를 자동으로 삭제한다.

 

참고

• https://www.baeldung.com/spring-data-redis-ttl
• https://stackoverflow.com/questions/48192027/spring-data-redis-does-not-clean-up-secondary-geospatial-index-after-ttl-expiry/48205316#48205316