실무에서 Redisson을 연결하면서 겪은 문제점들

Redisson을 실무에 적용하면서 겼었던 연결 문제와 해결 방법을 한번 정리해보려고 한다. 

첫 번째로, 다음과 같은 오류가 발생했다.

Caused by: org.springframework.beans.BeanInstantiationException: Failed to instantiate [org.redisson.api.RedissonClient]: Factory method 'redissonClient' threw exception; nested exception is org.redisson.client.RedisConnectionException: Unable to connect to Redis server: [Redis 주소]
	at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:185)
	at org.springframework.beans.factory.support.ConstructorResolver.instantiate(ConstructorResolver.java:653)
	... 38 common frames omitted
Caused by: org.redisson.client.RedisConnectionException: Unable to connect to Redis server: [addr=redis://Redis 주소:포트]
	at org.redisson.connection.pool.ConnectionPool.lambda$createConnection$0(ConnectionPool.java:132)
	at java.base/java.util.concurrent.CompletableFuture.uniWhenComplete(CompletableFuture.java:859)
	at java.base/java.util.concurrent.CompletableFuture$UniWhenComplete.tryFire(CompletableFuture.java:837)
	at java.base/java.util.concurrent.CompletableFuture.postComplete(CompletableFuture.java:506)
	at java.base/java.util.concurrent.CompletableFuture.completeExceptionally(CompletableFuture.java:2088)
	at org.redisson.connection.pool.ConnectionPool.promiseFailure(ConnectionPool.java:294)
	at org.redisson.connection.pool.ConnectionPool.lambda$createConnection$6(ConnectionPool.java:253)
	at java.base/java.util.concurrent.CompletableFuture.uniWhenComplete(CompletableFuture.java:859)
	at java.base/java.util.concurrent.CompletableFuture$UniWhenComplete.tryFire(CompletableFuture.java:837)
	at java.base/java.util.concurrent.CompletableFuture.postComplete(CompletableFuture.java:506)
	at java.base/java.util.concurrent.CompletableFuture.completeExceptionally(CompletableFuture.java:2088)
	at org.redisson.client.RedisClient$1$1.run(RedisClient.java:248)
	at io.netty.util.concurrent.AbstractEventExecutor.safeExecute(AbstractEventExecutor.java:164)
	at io.netty.util.concurrent.SingleThreadEventExecutor.runAllTasks(SingleThreadEventExecutor.java:469)
	at io.netty.channel.nio.NioEventLoop.run(NioEventLoop.java:503)
	at io.netty.util.concurrent.SingleThreadEventExecutor$4.run(SingleThreadEventExecutor.java:986)
	at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
	at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
	at java.base/java.lang.Thread.run(Thread.java:829)
Caused by: java.util.concurrent.CompletionException: org.redisson.client.RedisTimeoutException: Command execution timeout for command: (AUTH), params: (password masked), Redis client: [addr=redis://Redis 주소:포트]
	at java.base/java.util.concurrent.CompletableFuture.encodeRelay(CompletableFuture.java:367)
	at java.base/java.util.concurrent.CompletableFuture.completeRelay(CompletableFuture.java:376)
	at java.base/java.util.concurrent.CompletableFuture$UniRelay.tryFire(CompletableFuture.java:1019)
	at java.base/java.util.concurrent.CompletableFuture.postComplete(CompletableFuture.java:506)
	at java.base/java.util.concurrent.CompletableFuture.completeExceptionally(CompletableFuture.java:2088)
	at org.redisson.client.RedisConnection.lambda$async$0(RedisConnection.java:257)
	at io.netty.util.HashedWheelTimer$HashedWheelTimeout.run(HashedWheelTimer.java:715)
	at io.netty.util.concurrent.ImmediateExecutor.execute(ImmediateExecutor.java:34)
	at io.netty.util.HashedWheelTimer$HashedWheelTimeout.expire(HashedWheelTimer.java:703)
	at io.netty.util.HashedWheelTimer$HashedWheelBucket.expireTimeouts(HashedWheelTimer.java:790)
	at io.netty.util.HashedWheelTimer$Worker.run(HashedWheelTimer.java:503)
	... 2 common frames omitted
Caused by: org.redisson.client.RedisTimeoutException: Command execution timeout for command: (AUTH), params: (password masked), Redis client: [addr=redis://Redis 주소:포트]
	at org.redisson.client.RedisConnection.lambda$async$0(RedisConnection.java:256)
	... 7 common frames omitted

오류를 보면 Redis 서버에 연결할 수 없어서 타임아웃이 발생했다는데, 이상한 점은 기존에 사용하던 Lettuce에서는 정상적으로 연결이 되고, Redisson Client에서만 연결이 계속해서 실패하는 점이었다.

Lettuce에는 정상적으로 연결이 되기에, password가 틀린 문제도 아니고, Redisson도 Lettuce와 마찬가지로 SSL 통신을 하기 위해 setSslEnableEndpointIdentification(true)를 설정해 주었는데 계속 실패했다. 문서는 Baeldung의 Redisson 가이드 여기를 참고해서 설정했는데 문제가 발생했다.

@Configuration
@EnableRedisRepositories(enableKeyspaceEvents = RedisKeyValueAdapter.EnableKeyspaceEvents.ON_STARTUP)
public class RedisConfig {
...
    private static final String REDISSON_HOST_PREFIX = "redis://";
    private final ObjectMapper objectMapper;
    
    @Value("${redis.host}")
    private String redisHost;
    
    @Value("${redis.port}")
    private Integer redisPort;
    
    @Value("${redis.database}")
    private int redisSessionDatabase;
   
    @Value("${redis.password}")
    private String redisPassword;

    @Bean
    public RedisConnectionFactory redisConnectionFactory() {
        LettuceConnectionFactory connectionFactory =
                new LettuceConnectionFactory(redisStandaloneConfiguration(), lettuceClientConfiguration());
        connectionFactory.setDatabase(this.redisSessionDatabase);
        
        return connectionFactory;
    }

    @Bean
    RedisStandaloneConfiguration redisStandaloneConfiguration() {
        RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration();
        redisStandaloneConfiguration.setHostName(this.redisHost);
        redisStandaloneConfiguration.setPort(this.redisPort);
        redisStandaloneConfiguration.setPassword(this.redisPassword);
        
        return redisStandaloneConfiguration;
    }

    @Bean
    LettuceClientConfiguration lettuceClientConfiguration() {
        return LettuceClientConfiguration
                .builder()
                .useSsl()
                .build();
    }

    @Bean
    public RedissonClient redissonClient() {
        Config config = new Config();
        config.useSingleServer()
                .setAddress(REDISSON_HOST_PREFIX + this.redisHost + ":" + this.redisPort)
                .setPassword(this.redisPassword)
                .setSslEnableEndpointIdentification(true);
                
        return Redisson.create(config);
    }

    @Bean
    public RedisTemplate<String, Object> redisTemplate() {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(redisConnectionFactory());
        redisTemplate.setKeySerializer(new StringRedisSerializer());

        Jackson2JsonRedisSerializer<String> stringJackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(String.class);
        stringJackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        redisTemplate.setValueSerializer(stringJackson2JsonRedisSerializer);

        return redisTemplate;
    }
    ...
}

보안상 가릴 거 다 가리고, 보여줄 수 있는 Config는 위와 같다.

혼자 한 3-4시간 삽질하다가, 팀원분이 해결책을 찾아주었는데, Redisson 연결 설정에서 사용한 REDISSON_HOST_PREFIX가 원인이었다. SSL 통신을 위해서는 "redis://"가 아닌 "rediss://"로 설정해야 했던 것이다.  Lettuce에서는 LettuceClientConfiguration에서 userSsl()을 활성화하여 자동으로 "rediss://"로 설정이 되어서 문제가 발생하지 않았던 것이었다.

실제로 lettuce-core 라이브러리의  RedisURI.java 파일을 확인하면 166번째 줄에 URI_SCHEME_REDIS_SECURE가 "rediss"로 설정되어 있음을 확인할 수 있다.(부가적인 설정은 공식 위키를 확인하자.)

인터넷의 많은 Redisson Client 적용 예시들은 로컬 환경에서 동작하는 것을 기반으로 하므로, secure까지 설정하는 경우가 드물어 "redis://"로 설정한 코드들이 많다. 하지만 보안을 고려한 실무 환경에서는 이러한 세부 설정이 중요하므로 꼭 확인하여 나처럼 시간을 낭비하는 일이 없었으면 좋겠다.(특히나 참고했던 벨덩의 문서에도 나와있지 않았다.)

 

두 번째는 아래오류이다.

Caused by: org.springframework.beans.factory.NoSuchBeanDefinitionException: No qualifying bean of type 'javax.sql.DataSource' available: expected at least 1 bean which qualifies as autowire candidate. Dependency annotations: {@org.springframework.beans.factory.annotation.Qualifier(value="securityDataSource")}
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.raiseNoMatchingBeanFound(DefaultListableBeanFactory.java:1799)
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.doResolveDependency(DefaultListableBeanFactory.java:1394)
	at org.springframework.beans.factory.support.DefaultListableBeanFactory.resolveDependency(DefaultListableBeanFactory.java:1309)
	at org.springframework.beans.factory.support.ConstructorResolver.resolveAutowiredArgument(ConstructorResolver.java:887)
	at org.springframework.beans.factory.support.ConstructorResolver.createArgumentArray(ConstructorResolver.java:791)
	... 188 common frames omitted

NoSuchBeanDefinitionException 오류가 발생했는데, securityDataSource 빈을 찾지 못하는 문제가 발생했다.

코드를 살펴보면, DataSourceConfig 클래스에 여러 DataSource 빈들이 정의되어 있는데, 그중 securityDataSource 빈이 주입되려고 할 때 문제가 발생했다.

@Slf4j
@Configuration
@RequiredArgsConstructor
public class DataSourceConfig {
   // ... 다른 빈 정의들


    @Bean
    public DataSource securityDataSource() {
        return getDataSource();
    }

    private DataSource getDataSource() {
        JndiObjectFactoryBean jndi = new JndiObjectFactoryBean();
        jndi.setProxyInterface(DataSource.class);
        jndi.setJndiName(JndiResource.JNDI_NAME);
        jndi.setResourceRef(true);
        try {
            jndi.afterPropertiesSet();
            return (DataSource) jndi.getObject();
        } catch (NamingException ne) {
            log.error(JndiResource.JNDI_NAME, ne);
            return null;
        }
    }
    
    // ... 다른 메서드들
}

특이한 점은, 저기서 JNDI로 DataSource 주입하는 게 아니라 아래처럼 HikariCP를 사용해서 주입하면 문제가 발생하지 않는다는 점이다. 

@Slf4j
@Configuration
@RequiredArgsConstructor
public class DataSourceConfig {
   // ... 위와 동일
   
    public DataSource securityDataSource() {
        return getDataSource();
    }
    
    private DataSource getDataSource() {
        HikariConfig config = new HikariConfig();
        config.setDriverClassName(Driver.class.getName());
        config.setJdbcUrl("url");
        config.setUsername("username");
        config.setPassword("password");
        config.setMaximumPoolSize(size);

        return new HikariDataSource(config);
    }
}

요것도 혼자 별짓 다해보다가 결국 셀장님이 원인을 찾아주셨는데, 문제의 근원은 RedisConfig에서 ObjectMapper를 주입받는 과정에서 발생했다.

ServletConfig에는 ObjectMapper가 정의되어 있었고, PublicAuthInterceptor에는 DB 접근이 필요한 PrincipalRepository가 포함되어 있었는데, 이로 인해 securityDataSource가 아직 생성되기 전에 접근하려 해서 오류가 발생했던 것이다.

@Configuration
@RequiredArgsConstructor
public class ServletConfig implements WebMvcConfigurer {
    // ... 다른 정의들
   
    private final PublicAuthInterceptor publicAuthInterceptor;

    @Bean
    public ObjectMapper objectMapper() {
      // ... objectMapper 설정
    }

    // ...
}

@Slf4j
@Component
@RequiredArgsConstructor
public class PublicAuthInterceptor implements HandlerInterceptor {

 private final PrincipalRepository principalRepository;
    // ...

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        // principalRepository 사용 코드
    }
    
    // ...
}

해결책은 간단했는데, ObjectMapper를 ServletConfig에서 분리하여 아래처럼 별도의 클래스에서 주입해 주면 해결되었다.

@Configuration
public class ObjectMapperConfig {
    @Bean
    public ObjectMapper objectMapper() {
        // ... objectMapper 설정
    }
}

 

이해되지 않는 점들

결국... 해결은 했지만, 아직까지 왜 RedissonClient 빈을 추가하면 JNDI 주입에서는 문제가 발생하고, HikariCP 주입에서는 발생하지 않는지를 정확히 모르겠다. RedisConfig에서 Redisson 연결을 위한 아래 RedissClient 빈만 빼면 JNDI 주입으로도 전혀 문제가 발생하지 않기 때문이다. 

    @Bean
    public RedissonClient redissonClient() {
        Config config = new Config();
        config.useSingleServer()
                .setAddress(REDISSON_HOST_PREFIX + this.redisHost + ":" + this.redisPort)
                .setPassword(this.redisPassword)
                .setSslEnableEndpointIdentification(true);
                
        return Redisson.create(config);
    }

그리고 RedissonClient 없이, 기존처럼 LettuceClient만 있으면 HikariCP, JNDI 주입 전부 문제가 발생하지 않기에 더더욱 이해가 가지 않는다. RedissonClient랑 Datasource랑 관계가 있는 걸까..?