[Spring Boot] 스프링 부트 3에 레디스 적용하기

스프링 부트 3에 레디스 적용하기

 

스프링부트

 

📌 서론

스프링 부트 3을 사용하여 Redis를 통한 데이터 처리에 관한 내용을 설명해 보겠다.

 

 

1. Redis 의존성 추가

먼저, build.gradle에 Redis 의존성을 추가한다. 이것은 Spring Boot 프로젝트에 Redis 기능을 통합하는 첫 단계이다.

 

// redis  
implementation 'org.springframework.boot:spring-boot-starter-data-redis'

 

 

2. Redis 설정

application.yml에서 Redis 서버의 연결 정보를 설정한다. 여기에는 호스트, 포트, 비밀번호, 사용할 데이터베이스 번호 등이 포함된다.

 

spring:
    redis:  
      host: localhost  
      port: 6379  
      password: redis
      database: 1   # 1번 데이터베이스 사용 (개발용)

 

 

☝️ 잠깐! 스프링 부트에서 Redis를 설정할 때 고려해야 할 점

 

Redis 설정의 기본 개념

1. Redis 데이터베이스 구조

• Redis는 RDBMS처럼 복잡한 스키마나 별도의 데이터베이스 구조를 사용하지 않는다. 대신, 간단한 키-값 저장소로, 데이터는 database라는 인덱스로 구별된다.
• 이 database는 실제로 별도의 데이터베이스가 아니라, 서로 다른 키 공간(namespace)을 제공하는 인덱스다.

2. database 인덱스의 사용

• Redis에서 database는 0부터 시작하는 인덱스로 구분된다. 기본적으로 Redis는 16개의 데이터베이스(0에서 15까지)를 제공한다.
• application.yml에서 설정하는 database 값은 이 인덱스 중 하나를 선택하여 해당 키 공간에 접근하는 데 사용된다.
• 예: database: 1은 인덱스 1번 데이터베이스를 사용한다는 의미다.

3. redis.conf 설정

• Redis 서버의 설정 파일인 redis.conf에서 데이터베이스 개수를 정의할 수 있다.
• 비밀번호 보안 설정도 redis.conf에서 관리된다. requirepass 옵션을 사용하여 접근에 필요한 비밀번호를 설정할 수 있다.

4. 데이터베이스 인덱스의 목적별 사용

• 팀 내에서 각 데이터베이스 인덱스를 어떤 목적으로 사용할지 결정하고 소통하는 것이 중요하다.
• 우리 프로젝트에서는 redis.conf에서 데이터베이스를 3개(0, 1, 2) 사용한다고 설정했고, 0은 상용, 1은 개발, 2는 테스트 용도로 사용하고 있다.

위 application.yml에서 적용한 redis 설정은 redis.conf에 정의되어 있다. 만약 도커로 Redis를 실행했다면 보통 /usr/local/conf/redis.conf 경로에 저장되어 있다.

 

아래는 우리 프로젝트의 redis.conf 중 일부 내용을 가져왔다.

 

# 기본 사용자 비밀번호를 redis로 설정한다.
requirepass redis
# 총 3개의 데이터베이스를 사용하도록 설정합니다.
databases 3

 

 

3. Redis 설정 클래스

RedisConfig 클래스에서 Redis 연결을 위한 설정을 구성한다. 여기서 RedisConnectionFactory를 통해 Redis 서버에 연결하며, 필요한 경우 비밀번호, 데이터베이스를 설정하면 된다.

 

@Configuration  
public class RedisConfig {  

    @Value("${spring.redis.host}")  
    private String host;  

    @Value("${spring.redis.port}")  
    private int port;  

    @Value("${spring.redis.password}")  
    private String password;  

    @Value("${spring.redis.database}")  
    private int database;  

    // RedisProperties로 yaml에 저장한 host, post, password, database를 연결  
    @Bean  
    public RedisConnectionFactory redisConnectionFactory() {  
        RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration();  
        redisStandaloneConfiguration.setHostName(host);  
        redisStandaloneConfiguration.setPort(port);  
        redisStandaloneConfiguration.setPassword(password);  
        redisStandaloneConfiguration.setDatabase(database);  
        return new LettuceConnectionFactory(redisStandaloneConfiguration);  
    }  

    // serializer 설정으로 redis-cli를 통해 직접 데이터를 조회할 수 있도록 설정  
    @Bean  
    public RedisTemplate<String, Object> redisTemplate() {  
        RedisTemplate<String, Object> template = new RedisTemplate<>();  
        template.setConnectionFactory(redisConnectionFactory());  
        template.setKeySerializer(new StringRedisSerializer());  
        template.setValueSerializer(new StringRedisSerializer()); // 또는 Jackson2JsonRedisSerializer 등  
        return template;  
    }  

}

 

redisConnectionFactory()

이 메서드는 Redis 서버에 연결하기 위한 RedisConnectionFactory를 생성하고 구성한다.

 

기능 및 구성 요소

• @Value 어노테이션을 통해 application.yml 파일에서 Redis 서버 설정(호스트, 포트, 비밀번호, 데이터베이스)을 주입받는다.
• RedisStandaloneConfiguration 객체를 사용하여 단일 노드 Redis 서버에 대한 설정을 정의한다.
• LettuceConnectionFactory를 반환한다. Lettuce는 널리 사용되는 Redis 클라이언트 라이브러리 중 하나로, 비동기 처리를 지원하여 성능이 우수하다.

 

redisTemplate()

이 메서드는 Redis 데이터 작업을 수행하기 위한 RedisTemplate을 생성하고 구성한다.

 

직렬화 설정

• Redis에 데이터를 저장하거나 조회할 때 직렬화 및 역직렬화가 필요하다. 이를 위해 키와 값의 직렬화 방식을 설정한다.
• StringRedisSerializer는 키와 값 모두를 문자열로 직렬화한다. 이는 Redis CLI(Command Line Interface)를 통해 직접 데이터를 조회할 때 유용하다.
• 또 다른 옵션으로 Jackson2JsonRedisSerializer 등을 사용하여 JSON 형태로 데이터를 저장할 수도 있다.

 

이 클래스를 통해 스프링 부트 애플리케이션에서 Redis 서버에 쉽게 연결하고, 데이터를 효율적으로 관리할 수 있다. Redis를 사용하는 스프링 애플리케이션에서는 이러한 설정이 필수적이다.

 

💡 만약 프로젝트를 실행했을때 RedisConfig 클래스에서 에러가 발생한다면?

 

만약 아래와 같은 에러가 난다면 redis.conf를 확인해 보고 application.yml, RedisConfig.java에 누락된 설정들이 있나 확인해 보면 좋을 것 같다.

 

org.springframework.data.redis.RedisConnectionFailureException: Unable to connect to Redis at org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory$ExceptionTranslatingConnectionProvider.translateException(LettuceConnectionFactory.java:1602) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory$ExceptionTranslatingConnectionProvider.getConnection(LettuceConnectionFactory.java:1533) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory$SharedConnection.getNativeConnection(LettuceConnectionFactory.java:1358) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory$SharedConnection.getConnection(LettuceConnectionFactory.java:1341) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory.getSharedConnection(LettuceConnectionFactory.java:1059) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory.getConnection(LettuceConnectionFactory.java:398) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.core.RedisConnectionUtils.fetchConnection(RedisConnectionUtils.java:193) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.core.RedisConnectionUtils.doGetConnection(RedisConnectionUtils.java:144) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.core.RedisConnectionUtils.getConnection(RedisConnectionUtils.java:105) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.data.redis.core.RedisConnectionUtils.getConnection(RedisConnectionUtils.java:92) ~[spring-data-redis-3.1.2.jar:3.1.2] at org.springframework.boot.actuate.data.redis.RedisHealthIndicator.doHealthCheck(RedisHealthIndicator.java:49) ~[spring-boot-actuator-3.1.2.jar:3.1.2] at

 

 

4. Redis에 데이터 저장 - SringRedisTemplate 직접 사용

이제 실제로 레디스에 데이터를 저장해 보자.

 

아래 코드는 스프링 프레임워크의 이벤트 리스너를 사용하여 Redis에 휴대폰 번호를 key로, 휴대폰 번호로 전송된 인증번호를 value로 데이터를 저장하고 만료 시간을 설정하는 예시이다.

 

@RequiredArgsConstructor  
@Component  
public class SpringEventVerifyCodeListener {  

    private final StringRedisTemplate stringRedisTemplate;  

    @EventListener  
    public void eventVerifyCodeListener(SendVerifyCodeSpringEvent event) {  
        String phoneNumber = event.phoneNumber();  
        String verificationCode = event.verificationCode();  

        // 레디스에 저장 (키: 전화번호, 값: 인증코드)  
        stringRedisTemplate.opsForValue().set(phoneNumber, verificationCode);  

        // 설정한 만료 시간 (예: 5분)  
        stringRedisTemplate.expire(phoneNumber, 5, TimeUnit.MINUTES);  
    }  

}

 

이 코드에서 중요한 두 가지 구성 요소는 StringRedisTemplate과 해당 메서드들이다.

 

StringRedisTemplate

StringRedisTemplate은 Spring Framework에서 제공하는 템플릿으로, Redis 데이터 저장소와의 상호작용을 단순화한다.

이 클래스는 RedisTemplate을 상속받으며, 문자열 기반의 데이터 작업에 특화되어 있다.

• Redis의 데이터 구조와 상호작용하는 데 필요한 다양한 메서드를 제공한다.
• Java 객체와 Redis 데이터 구조 간의 직렬화 및 역직렬화를 처리한다.
• StringRedisTemplate은 기본적으로 문자열 키와 값을 사용한다.

 

opsForValue()와 set()

stringRedisTemplate.opsForValue().set(phoneNumber, verificationCode); 이 부분은 Redis에 문자열 데이터를 저장하는 방법을 보여준다.

• opsForValue() 메소드는 Redis의 'string' 타입 데이터 작업을 위한 객체를 반환한다.
• set(String key, String value) 메소드는 주어진 키에 문자열 값을 저장한다. 여기서 phoneNumber는 키, verificationCode는 값으로 사용된다.

 

expire()

stringRedisTemplate.expire(phoneNumber, 5, TimeUnit.MINUTES); 코드는 Redis에 저장된 데이터의 만료 시간을 설정한다.

• expire(String key, long timeout, TimeUnit unit) 메소드는 지정된 키의 값을 일정 시간 후에 만료되도록 설정한다.
• 여기서 phoneNumber는 만료를 설정할 키, 5는 만료 시간(5분), TimeUnit.MINUTES는 시간 단위(분)를 나타낸다.

이렇게 StringRedisTemplate과 그 메서드들을 사용함으로써, 스프링 애플리케이션에서 Redis와의 상호작용을 간편하게 수행할 수 있다. 이를 통해 데이터 캐싱, 세션 관리, 메시지 큐 등 다양한 기능을 구현할 수 있다.

 

실제로 코드를 실행하면 아래와 같이 데이터가 잘 저장된 모습을 확인할 수 있다.

 

redis 저장 로그

 

이렇게 실행하고 이제 실제로 데이터가 잘 들어갔는지 확인해 보자.

 

 

5. redis-cli로 데이터 확인

redis-cli는 Redis 데이터베이스를 관리하고, 데이터를 직접 조회하거나 수정하는 데 매우 유용한 도구다. 개발자나 시스템 관리자는 redis-cli를 사용하여 실시간으로 Redis 데이터베이스의 상태를 모니터링하고, 필요한 작업을 수행할 수 있다.

 

Redis 접속

우선 우리는 docker로 Redis를 띄웠기 때문에 아래 명령어는 redis container 내부에서 명령어를 실행했다.

 

redis-cli로 redis 접속

 

 

redis-cli -a redis 명령어는 Redis 서버에 접속하기 위한 Redis Command Line Interface (CLI) 명령이다. 여기서 -a 옵션은 Redis 서버에 접속하기 위해 필요한 비밀번호를 제공하는 데 사용된다.

• redis-cli는 Redis 서버와 상호작용하기 위한 커맨드 라인 도구다.
• -a 옵션 뒤에 오는 redis는 이 경우 Redis 서버에 설정된 비밀번호다.

이 명령어를 사용할 때, redis-cli는 지정된 비밀번호를 사용하여 Redis 서버에 인증을 시도한다. 이를 통해 보안된 Redis 서버에 안전하게 접근할 수 있다.

 

데이터베이스 선택 (선택 사항)

이 작업은 만약 하나의 데이터베이스를 사용한다면 생략해도 되는 작업이다.

 

Redis는 기본적으로 여러 데이터베이스를 지원한다. 각 데이터베이스는 숫자 인덱스로 구분된다.

• SELECT [index]

SELECT 1 명령어는 Redis의 1번 데이터베이스를 선택하는 명령이다. 이는 개발 환경 또는 특정 목적으로 사용될 수 있는 별도의 데이터베이스 공간으로, 여기서는 1번 데이터베이스를 사용하는 것으로 지정된다.

 

redis 데이터베이스 접속

 

 

데이터 조회 및 결과 확인

• get [key]

get +8201012121212 명령은 키가 +8201012121212인 데이터의 값을 조회한다.
이 경우 +8201012121212는 특정 전화번호를 나타내는 키이며, 이에 대응하는 값(예: 인증 코드 '29211')을 조회한다.

 

redis 데이터 조회

 

 

이를 통해 데이터가 성공적으로 저장되었고, 정상적으로 조회됨을 확인할 수 있다.

 

 

6. RedisService (직접 정의) 사용

이번에는 메서드 내에서 직접 StringRedisTemplate를 사용하지 않고, 공통의 RedisService 클래스를 만들어 공통으로 사용할 수 있게 해 보자.

 

RedisService 클래스는 Redis와 상호작용하기 위한 다양한 메서드를 제공하는 서비스 클래스다.

@Slf4j  
@Component  
@RequiredArgsConstructor  
public class RedisService {  

    private final StringRedisTemplate stringRedisTemplate;  

    public void setValues(String key, String data) {  
        stringRedisTemplate.opsForValue().set(key, data);  
    }  

    public void setValues(String key, String data, Duration duration) {  
        stringRedisTemplate.opsForValue().set(key, data, duration);  
    }  

    @Transactional(readOnly = true)  
    public String getValues(String key) {  
        return stringRedisTemplate.opsForValue().get(key);  
    }  

    public void deleteValues(String key) {  
        stringRedisTemplate.delete(key);  
    }  

    public void expireValues(String key, int timeout) {  
        stringRedisTemplate.expire(key, timeout, TimeUnit.MILLISECONDS);  
    }  

    public void setHashOps(String key, Map<String, String> data) {  
        HashOperations<String, String, String> values = stringRedisTemplate.opsForHash();  
        values.putAll(key, data);  
    }  

    @Transactional(readOnly = true)  
    public String getHashOps(String key, String hashKey) {  
        HashOperations<String, String, String> values = stringRedisTemplate.opsForHash();  
        return values.hasKey(key, hashKey) ? values.get(key, hashKey) : "";  
    }  

    public void deleteHashOps(String key, String hashKey) {  
        HashOperations<String, String, String> values = stringRedisTemplate.opsForHash();  
        values.delete(key, hashKey);  
    }  

    public boolean checkExistsValue(String key) {  
        return stringRedisTemplate.hasKey(key);  
    }  
}

 

RedisService 클래스의 주요 메서드 설명

setValues(String key, String data)

지정된 키에 데이터를 저장한다.

 

setValues(String key, String data, Duration duration)

지정된 키에 데이터를 지정된 시간 동안 저장한다.

 

getValues(String key)

지정된 키의 데이터를 가져온다. 만약 데이터가 없다면 "false"를 반환한다.

 

deleteValues(String key)

지정된 키의 데이터를 삭제한다.

 

expireValues(String key, int timeout)

지정된 키의 만료 시간을 설정한다.

 

setHashOps(String key, Map<String, String> data)

지정된 해시 키에 데이터를 저장한다.

 

getHashOps(String key, String hashKey)

지정된 해시 키와 해시 키의 값을 가져온다.

 

deleteHashOps(String key, String hashKey)

지정된 해시 키의 항목을 삭제한다.

 

checkExistsValue(String value)

"false"가 아닌 값을 확인하여 존재 여부를 반환한다.

 

RedisService 클래스를 사용하는 스프링 이벤트 리스너 클래스

다음은 직접 StringRedisTemplate을 사용하던 코드를 RedisService의 메서드를 사용하는 코드로 변경한 내용이다.

 

@Slf4j  
@RequiredArgsConstructor  
@Component  
public class SpringEventVerifyCodeListener {  

    private final RedisService redisService;  
    private final Duration TIMEOUT = Duration.ofMinutes(5); // 5분  

    @EventListener  
    public void eventVerifyCodeListener(SendVerifyCodeSpringEvent event) {  
        String phoneNumber = event.phoneNumber();  
        String verificationCode = event.verificationCode();  

        // Redis에 저장 (키: 전화번호, 값: 인증코드, 만료 시간: 5분)  
        redisService.setValues(phoneNumber, verificationCode, TIMEOUT);  
        log.info("Saved in Redis with expiration: key {}, value {}, duration {}", phoneNumber, verificationCode, TIMEOUT);  
    }  

}

 

 

이제 SpringEventVerifyCodeListener에서는 RedisService의 메서드를 사용하여 Redis 데이터를 저장하고 관리한다. 코드를 변경하고 설명해 드렸으니, 이를 통해 더 효율적으로 Redis를 활용할 수 있을 것이다.

 

 

🔥 결론

이렇게 간단하게 스프링 부트 3에 레디스를 적용해 봤다. 아직은 간단하게 데이터를 저장하고 조회하는 정도로만 레디스를 사용해 봤지만 나중에 더 다양한 기능을 사용해 봐야겠다.

 

 

[Spring Boot] Spring Boot 3.X 버전에서 Spring Batch 적용하기

[Spring Boot] Spring Boot 3.X 버전에서 Spring Batch 적용하기

 

📣 이 글은 내가 소속된 Team Chillwave에서 진행한 사이드 프로젝트에 적용한 내용을 다시 공부하고 정리한 것이다. 
다른 팀원인 "개발자의 서랍" 님의 블로그도 방문하면 도움이 될 것 같다 :)

개발자의 서랍