SpringBoot 整合redis发布订阅

SpringBoot 整合redis发布订阅

笔者SpringBoot版本：2.4.1
SpringBoot整合redis参考：https://blog.csdn.net/qq_27242695/article/details/112618063

1 核心对象简介

1. RedisMessageListenerContainer
   redis监听器容器，简单理解监听器管理对象。
2. MessageListenerAdapter
   监听器适配器,用于配置具体的监听事件MessageListener。
3. MessageListener
   消息消费者对象，具体实现消费消息的业务逻辑。
   三者的关系：
   RedisMessageListenerContainer 可管理多个MessageListenerAdapter，MessageListenerAdapter中配置MessageListener。

2 整合

2.1 pom.xml新增依赖

<!--redis配置 ，版本号由parent的pom.xml适配-->
<dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

<!--进行redisTemplate配置时需要此包，版本号由parent的pom.xml适配-->
<dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-annotations</artifactId>
</dependency>

<!--reids版本为1.4.1版本以上需要添加 ，版本号由parent的pom.xml适配-->
<dependency>
  <groupId>org.apache.commons</groupId>
  <artifactId>commons-pool2</artifactId>
</dependency>

2.2 MessageListener 消费者创建

/**
 * 消费者
 */
@Component
public class CreateHtmlMsgListener implements MessageListener {

    public static final Logger logger = LoggerFactory.getLogger(CreateHtmlMsgListener.class);

    @Autowired
    private ThymeleafService thymeleafService;

    @Override
    public void onMessage(Message message, byte[] pattern) {
        logger.info("消费消息,创建首页静态h5文件 {}", message.toString());
    }
}

2.3 RedisMessageListenerContainer与MessageListenerAdapter创建及相关配置

@Configuration
public class RedisMessageListenerConfig {

    /**
     * redis消息监听器容器
     * 可以添加多个监听不同话题的redis监听器，只需要把消息监听器和相应的消息订阅处理器绑定，该消息监听器
     * 通过反射技术调用消息订阅处理器的相关方法进行一些业务处理
     *
     * @param connectionFactory
     * @return
     */
    @Bean
    RedisMessageListenerContainer container(RedisConnectionFactory connectionFactory,@Qualifier(value = "createHtmlMsgListenerAdapter") MessageListenerAdapter createHtmlMsgListenerAdapter) {
        // 1. 创建redis消息消费监听容器
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);

        // 2. 定义json序列化 以下为修改默认的序列化方式，网上大多数消息发布订阅都是String类型,但是实际中数据类型肯定不止String类型
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Object>(
                Object.class);
        //使用Mapper对象进行转义
        ObjectMapper om = new ObjectMapper();
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        om.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.WRAPPER_ARRAY);
        jackson2JsonRedisSerializer.setObjectMapper(om);

        //  3 监听适配器设置序列化方式
        createHtmlMsgListenerAdapter.setSerializer(jackson2JsonRedisSerializer);
        //  3 首页静态html生成主题绑定消息订阅处理器  container可添加多个订阅处理器
        container.addMessageListener(createHtmlMsgListenerAdapter, new PatternTopic("订阅的主题");
        return container;
    }

    @Bean
    MessageListenerAdapter createHtmlMsgListenerAdapter(@Qualifier(value = "createHtmlMsgListener") CreateHtmlMsgListener createHtmlMsgListener) {
        MessageListenerAdapter messageListenerAdapter = new MessageListenerAdapter(createHtmlMsgListener);
        return messageListenerAdapter;
    }


}

2.3 发布消息

redisTemplate.convertAndSend("发布的主题", "发布的消息");

3 验证测试

3.1 单元测试

@SpringBootTest(classes = Application.class)
public class MsgListenerTest {

    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    @Test
    public void test(){
        redisTemplate.convertAndSend("订阅的主题", "{test}");
    }
}

3.2 结果