[Spring Boot] REDIS PUB/SUB 구현

📍 기능 정의

message pub/sub 기능으로 누군가 메세지를 보내게 되면 특정 채널에 구독하고 있는 대상에게 메세지가 전송되는 구조

 

redis pub/sub 구조

https://gh402.tistory.com/69

[REDIS] REDIS PUB/SUB 구조

 

🍭 레디스 자바 클라이언트

• lettuce
• Jedis
• Redisson

spring boot 2.0 이상 부터 spring-boot-starter-data-redis 에 기본 클라이언트는 lettuce 이다. 

lettuce는 Netty(비동기 이벤트 기반 고성능 네트워크 프레임워크) 기반의 Redis 클라이언트이다.

 

2.3.6.RELEASE 버전에 Lettuce client 가 사용된 것을 확인할 수 있다.

🍭  redis pub/sub 특징

Redis pub/sub은 보내는 메세지를 별도로 저장하지 않고, 메세지를 한 번 보내면 재전송은 일어나지 않는다.

Redis 어디에도 저장되지 않고, 클라이언트가 메세지 받는 것을 보장하지 않는다.

실시간 데이터 처리하는 데에 매우 적합하지만 위의 내용을 반드시 인지하고 개발을 해야한다. 

 

 

---

📤 Spring boot 로 Redis pub/sub 구현 

1) redis config 설정

spring-boot-starter-data-redis dependency 추가해줘야 한다! (이 정도는 다 알겠지만,, 혹시나 하여!)

    @Bean
    public RedisMessageListenerContainer redisMessageListener(RedisConnectionFactory connectionFactory) {
        val container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);
        return container;
    }

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(connectionFactory);
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new Jackson2JsonRedisSerializer<>(String.class));
        redisTemplate.setHashKeySerializer(new StringRedisSerializer());
        redisTemplate.setHashValueSerializer(new Jackson2JsonRedisSerializer<>(String.class));

        return redisTemplate;
    }

 

 

2) redis publish (메세지 발송)

publish 함수를 통해 메세지를 발송하고자 하는 topic 과 String 형태의 전달할 message를 파라미터로 넣어주면

topic을 구독하고 있는 모든 client 에게 메세지가 전송된다.

@Slf4j
@RequiredArgsConstructor
public class MessagePublish {
    private final RedisTemplate<String, Object> redisTemplate;
    
    public void publish(ChannelTopic topic, String message) {
        log.info("redis publish >> topic: {}, message: {}", topic.getTopic(), message);

        try {
            redisTemplate.convertAndSend(topic.getTopic(), message);
        } catch (Exception e) {
            log.error("redis connection error : {} ", e.getMessage());
        }
    }
}

 

3) redis publish (메세지 발송)

3-1. @PostConstruct 애노테이션을 통해서 서버가 실행될 때 "channel"이라는 채널에 대해 메세지가 오는지 창구를 열어놓는 역할을 한다.

 

3-2. MessageListener의 onMessage함수를 오버라이드해서 Message가 들어오면 해당 함수에서 메세지를 처리할 수 있다.  

@Slf4j
@Service
@RequiredArgsConstructor
public class MessageSub implements MessageListener {
    private final RedisTemplate<String, Object> redisTemplate;
    private final RedisMessageListenerContainer listenerContainer;

    private static final String REDIS_CHANNEL = "channel";

    @PostConstruct
    public void init() {
        listenerContainer.addMessageListener(this, new ChannelTopic(REDIS_CHANNEL));
    }

    @Override
    public void onMessage(Message message, byte[] pattern) {
        val now = System.currentTimeMillis();
        val msg = (String) redisTemplate.getValueSerializer().deserialize(message.getBody());
        
        log.info("redis recv message. message:{}, pattern:[{}], set now:{}", msg, new String(pattern), now);
    }
}

 

 

📗 참고링크

• https://brunch.co.kr/@springboot/374
• lettuce 공식문서
  • https://lettuce.io/core/release/reference/