SpringBoot整合Redis實現訊息釋出與訂閱的範例程式碼

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

@Configuration
public class RedisConfig {
    @Value("${redis.server.nodes}")
    private String redisServerNodes;
 
    @Value("${redis.server.password}")
    private String redisServerPassword;
 
    //Redis叢集設定,單機的redis註釋掉該方法，在application組態檔裡面設定就可以了
    @Bean
    public RedisClusterConfiguration getRedisClusterConfiguration() {
 
        RedisClusterConfiguration redisClusterConfiguration = new RedisClusterConfiguration();
 
        String[] serverArray = redisServerNodes.split(",");
        Set<RedisNode> nodes = new HashSet<RedisNode>();
        for (String ipPort : serverArray) {
            String[] ipAndPort = ipPort.split(":");
            nodes.add(new RedisNode(ipAndPort[0].trim(), Integer.parseInt(ipAndPort[1])));
        }
        redisClusterConfiguration.setClusterNodes(nodes);
        RedisPassword pwd = RedisPassword.of(redisServerPassword);
        redisClusterConfiguration.setPassword(pwd);
        return redisClusterConfiguration;
    }
 
    //指定redisTemplate型別，如下為<String, Object>
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        // 使用JSON格式序列化物件，對快取資料key和value進行轉換
        Jackson2JsonRedisSerializer<Object> jacksonSeial = new Jackson2JsonRedisSerializer<>(Object.class);
        // 解決查詢快取轉換異常的問題
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        jacksonSeial.setObjectMapper(objectMapper);
 
        // 設定RedisTemplate模板API的序列化方式為JSON
        template.setDefaultSerializer(jacksonSeial);
        return template;
    }
 
     /**
     * Redis訊息監聽器容器
     * 這個容器載入了RedisConnectionFactory和訊息監聽器
     * 可新增多個不同話題的redis監聽器，需要將訊息監聽器和訊息頻道繫結，
     * 通過反射呼叫訊息訂閱處理器的相關方法進行業務處理
     *
     * @param  redisConnectionFactory       連線工廠
     * @param  listener                     Redis訊息監聽器
     * @param  MessageListenerAdapter       Redis訊息監聽介面卡
     * @return RedisMessageListenerContainer    訊息監聽容器
     */
    @Bean
    @SuppressWarnings("all")
    public RedisMessageListenerContainer container(RedisConnectionFactory redisConnectionFactory,
                                                   RedisMessageListener listener,
                                                   MessageListenerAdapter adapter) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(redisConnectionFactory);
        // 所有的訂閱訊息，都需要在這裡進行註冊繫結
        // new PatternTopic(TOPIC_NAME1) 表示釋出資訊的頻道
        // 可以新增多個頻道以及設定不同的頻道
        container.addMessageListener(listener, new PatternTopic(SystemConstants.TOPIC_NAME1));
        container.addMessageListener(adapter, new PatternTopic(SystemConstants.TOPIC_NAME2));
 
        /**
         * 設定序列化物件
         * 特別注意：1. 釋出的時候和訂閱方都需要設定序列化
         *         2. 設定序列化物件必須放在 {加入訊息監聽器} 這步後面，不然接收器接收不到訊息
         */
        Jackson2JsonRedisSerializer seria = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        seria.setObjectMapper(objectMapper);
        container.setTopicSerializer(seria);
        return container;
    }
 
    /**
     * 這個地方是給messageListenerAdapter 傳入一個訊息接受的處理器，利用反射的方法呼叫「receiveMessage」
     * 也有好幾個過載方法，這邊預設呼叫處理器的方法 叫OnMessage
     *
     * @param redisMessageReceiver 訊息接收物件
     * @return 訊息監聽介面卡
     */
    @Bean
    public MessageListenerAdapter listenerAdapter(RedisMessageReceiver redisMessageReceiver) {
        MessageListenerAdapter receiveMessage = new MessageListenerAdapter(printMessageReceiver, "onMessage");
        Jackson2JsonRedisSerializer<Object> seria = new Jackson2JsonRedisSerializer<>(Object.class);
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
        seria.setObjectMapper(objectMapper);
        receiveMessage.setSerializer(seria);
        return receiveMessage;
    }
}

//方式一：
@Slf4j
@Component
public class RedisMessageListener implements MessageListener {
 
    @Autowired
    private RedisTemplate<String, Object> redisTemplate;
    @Autowired
    private CacheManager cacheManager;
 
    @Override
    public void onMessage(Message message, byte[] pattern) {
    // 接收的topic
    log.info("接收訊息頻道:" + new String(pattern));
    //序列化物件（特別注意：釋出的時候需要設定序列化；訂閱方也需要設定序列化）
    MessageDto<?> messageDto = (MessageDto<?>) redisTemplate.getValueSerializer().deserialize(message.getBody());
    //MessageDto<T>為自己編寫的一個訊息物件類（如自定義有：String data，String title，T content 等屬性）
    log.info("接收訊息內容：{}", messageDto);
    //根據訊息內容做具體業務邏輯。。。。。。。。。
    //。。。。。。。。。。。。。。。。。。。。。。
    }
}

//方式二
@Slf4j
@Component
public class RedisMessageReceiver {
 
    @Autowired
    private RedisTemplate<String,Object> redisTemplate;
 
    /**
     * 方法命名規則必須為function(Object messageDto) / function(Object messageDto,String topic)
     * @param messageDto 訊息物件
     * @param topic 訊息頻道名稱
     */
    public void onMessage(Object messageDto , String topic) {
        // 接收訊息頻道
        log.info("接收訊息頻道:" + topic);
        //接收訊息內容
        log.info("接收訊息內容:{}",messageDto);
    }
}

@Slf4j
@Component
public class RedisMessageUtils {
 
    @Autowired
    private RedisTemplate<String,Object> redisTemplate;
 
    /**
     * 向通道釋出訊息
     */
    public void sendMessage(String topic, Object message) {
        if (!StringUtils.hasText(topic)) {
            return;
        }
        try {
            redisTemplate.convertAndSend(topic, message);
            log.info("傳送訊息成功，topic：{}，message：{}", topic, message);
        } catch (Exception e) {
            log.info("傳送訊息失敗，topic：{}，message：{}", topic, message);
            e.printStackTrace();
        }
    }
}

@RestController
@RequestMapping("/user")
public class UserController{
 
  @Autowired
  private UserService userService;
 
  @PostMapping("/getUsers")  
  public List<User> queryUsers(@RequestBody UserDto userDto){
   List<User> users=userService.queryUsers(userDto);
   //傳送測試訊息
   RedisMessageUtils.sendMessage(SystemConstants.TOPIC_NAME2, new MessageDto());
   return users;
  }
}