SpringBoot Redis发布订阅

1. 引入依赖

<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

2. Redis配置

spring.redis.host=127.0.0.1
spring.redis.port=6379
spring.redis.database=0
spring.redis.password=

3. 设置监听相关对象

3.1 接听对象RedisReceiver

RedisReceiver 可以是普通类或者继承 MessageListener，普通类的写法如下，接收的时候只接收到消息，没有频道名。

@Component
public class RedisReceiver {
    public void onMessage(String message) {
        // TODO 这里是收到消息之后执行的方法
        System.out.println(message);
    }
}

继承 MessageListener，就能拿到消息体和频道名。

@Component
public class RedisReceiver implements MessageListener {
    @Override
    public void onMessage(Message message, byte[] pattern) {
        System.out.println(new String(message.getBody(), StandardCharsets.UTF_8));
        System.out.println(new String(message.getChannel(), StandardCharsets.UTF_8));
    }
}

3.2 配置监听适配器、消息监听容器

@Configuration
public class RedisConfig {

    @Bean
    public RedisMessageListenerContainer redisMessageListenerContainer(RedisConnectionFactory connectionFactory,
                                                                       @Qualifier("messageListenerAdapter") MessageListenerAdapter messageListenerAdapter) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);
        // 可以添加多个 messageListener，配置不同的交换机
        container.addMessageListener(messageListenerAdapter, new PatternTopic("channel:redis_topic"));
        return container;
    }

    @Bean("messageListenerAdapter")
    public MessageListenerAdapter messageListenerAdapter(RedisReceiver redisReceiver) {
        // RedisReceiver 如果是普通类，需要指定方法名 new MessageListenerAdapter(redisReceiver, "onMessage");
        return new MessageListenerAdapter(redisReceiver,"onMessage");
    }

    @Bean(name = "redisTemplate")
    public RedisTemplate<String, String> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, String> template = new RedisTemplate<>();
        RedisSerializer<String> redisSerializer = new StringRedisSerializer();
        template.setConnectionFactory(factory);
        // key序列化方式
        template.setKeySerializer(redisSerializer);
        // value序列化
        template.setValueSerializer(redisSerializer);
        // value hashmap序列化
        template.setHashValueSerializer(redisSerializer);
        // key haspmap序列化
        template.setHashKeySerializer(redisSerializer);
        return template;
    }
}

3.3 消息发送

redisTemplate.convertAndSend("channel:redis_topic", String.format("发送消息: %s", message));

4. Redis 发布订阅原理

Redis 发布订阅 (pub/sub) 是一种消息通信模式：发送者 (pub) 发送消息，订阅者 (sub) 接收消息。

Redis 客户端可以订阅任意数量的频道。
下图展示了频道 channel1 ， 以及订阅这个频道的三个客户端 —— client2 、 client5 和 client1 之间的关系：

当有新消息通过 PUBLISH 命令发送给频道 channel1 时， 这个消息就会被发送给订阅它的三个客户端：

参考文档：
https://www.runoob.com/redis/redis-pub-sub.html