SpringBoot集成消息隊列

背景

最近在對公司開發框架進行優化，框架內涉及到多處入庫的日誌記錄，例如登錄日誌/操作日誌/訪問日誌/業務執行日誌，集成在業務代碼中耦合度較高且佔用業務操作執行時間，所以準備集成相關消息隊列進行代碼解耦

方案規劃

現有的成熟消息隊列組件非常多，例如RabbitMQ，ActiveMQ，Kafka等，考慮到業務併發量不高且框架已經應用於多個項目平穩運行，準備提供基於Redis的消息隊列和集成ActiveMQ兩種方案，Redis消息隊列的好處是無需額外安裝部署存量項目可平穩過度但消息無法持久化可能丟失，ActiveMQ解決方案成熟可以保證消息持久化但是需要實施人員額外掌握操作部署

統一設計

增加自定義配置指定消息隊列方式

system:
  #消息隊列方式 redis/activemq
  messageChannel: redis

定義消息傳輸統一模型

public class MessageModel {
    private Class<? extends IMessageReceiver> handleClazz;
    private String bodyContent;
    private Class bodyClass;
    private HashMap extraParam;

    public MessageModel(){
        extraParam = new HashMap();
    }

    public Class<? extends IMessageReceiver> getHandleClazz() {
        return handleClazz;
    }

    public void setHandleClazz(Class<? extends IMessageReceiver> handleClazz) {
        this.handleClazz = handleClazz;
    }

    public HashMap getExtraParam() {
        return extraParam;
    }

    public void setExtraParam(HashMap extraParam) {
        this.extraParam = extraParam;
    }

    public String getBodyContent() {
        return bodyContent;
    }

    public void setBodyContent(String bodyContent) {
        this.bodyContent = bodyContent;
    }

    public Class getBodyClass() {
        return bodyClass;
    }

    public void setBodyClass(Class bodyClass) {
        this.bodyClass = bodyClass;
    }
}

定義標準消息處理接口

public interface IMessageReceiver {
    void handleMessage(Object bodyObject, HashMap extraParam);
}

定義統一對外發送消息工具類

@Component
public class MessageUtil {
    @Autowired
    private SystemConfig systemConfig;
    @Autowired
    private RedisUtil redisUtil;
    @Autowired
    private JmsMessagingTemplate jmsMessagingTemplate;

    public void sendMessage(Object messageBody, Class<? extends IMessageReceiver> handleClass, HashMap<String,Object> extraParam) {
        MessageModel messageModel = new MessageModel();
        messageModel.setHandleClazz(handleClass);
        messageModel.setBodyClass(messageBody.getClass());
        messageModel.setBodyContent(JSON.toJSONString(messageBody));
        if (extraParam != null) {
            for (String key:extraParam.keySet()) {
                messageModel.getExtraParam().put(key,extraParam.get(key));
            }
        }
        if(systemConfig.getMessageChannel().equals("redis")){
            redisUtil.sendMessage("message", JSON.toJSON(messageModel));
        }else{
            jmsMessagingTemplate.convertAndSend("message",JSON.toJSONString(messageModel));
        }
    }
}

集成Redis消息隊列

pom配置

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

連接配置

spring:
  redis:
    host: localhost
    port: 6379
    password:

操作工具類

    @Autowired
    private RedisTemplate redisTemplate;
    public void sendMessage(String channel, Object message) {
        redisTemplate.convertAndSend(channel, message);
    }

消息處理

@Component
@ConditionalOnProperty(name = "system.messageChannel", havingValue = "redis", matchIfMissing = true)
public class RedisMessageReceiver {
    public void receiveMessage(String message) {
        MessageModel messageModel = JSON.parseObject(message, MessageModel.class);
        IMessageReceiver receiver = SpringBootBeanUtil.getBean(messageModel.getHandleClazz());
        receiver.handleMessage(JSON.parseObject(messageModel.getBodyContent(), messageModel.getBodyClass()), messageModel.getExtraParam());
    }
}

配置註冊

@Configuration
public class MessageCenter {
    @Bean
    @ConditionalOnProperty(name = "system.messageChannel", havingValue = "redis", matchIfMissing = true)
    RedisMessageListenerContainer container(RedisConnectionFactory connectionFactory, MessageListenerAdapter listenerAdapter) {
        RedisMessageListenerContainer container = new RedisMessageListenerContainer();
        container.setConnectionFactory(connectionFactory);
        // 可以添加多個 messageListener，配置不同的交換機
        container.addMessageListener(listenerAdapter, new PatternTopic("message"));
        return container;
    }

    /**
     * 消息監聽器適配器，綁定消息處理器，利用反射技術調用消息處理器的業務方法
     *
     * @param receiver
     * @return
     */
    @Bean
    @ConditionalOnProperty(name = "system.messageChannel", havingValue = "redis", matchIfMissing = true)
    MessageListenerAdapter listenerAdapter(RedisMessageReceiver receiver) {
        return new MessageListenerAdapter(receiver, "receiveMessage");
    }
}

集成ActiveMQ消息隊列

pom配置

        <dependency>
            <groupId>org.apache.activemq</groupId>
            <artifactId>activemq-pool</artifactId>
            <version>5.15.0</version>
        </dependency>

注意：jdk1.8對應版本5.15.0

連接配置

spring:
  activemq:
    broker-url: tcp://127.0.0.1:61616 #MQ服務器地址
    user: admin
    password: admin
    pool:
      enabled: true

消息處理

@Component
@ConditionalOnProperty(name = "system.messageChannel", havingValue = "activemq", matchIfMissing = false)
public class ActiveMQMessageReceiver {
    @JmsListener(destination = "message", containerFactory = "customQueueListener")
    public void handleMessage(String message) {
        MessageModel messageModel = JSON.parseObject(message, MessageModel.class);
        IMessageReceiver receiver = SpringBootBeanUtil.getBean(messageModel.getHandleClazz());
        receiver.handleMessage(JSON.parseObject(messageModel.getBodyContent(), messageModel.getBodyClass()), messageModel.getExtraParam());
    }
}

配置註冊

@Configuration
@EnableJms
public class MessageCenter {
    @Bean(name = "customQueueListener")
    @ConditionalOnProperty(name = "system.messageChannel", havingValue = "activemq", matchIfMissing = false)
    public JmsListenerContainerFactory<?> customQueueListener(ConnectionFactory connectionFactory) {
        DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
        factory.setPubSubDomain(false);
        factory.setConnectionFactory(connectionFactory);
        //重連間隔時間
        factory.setRecoveryInterval(1000L);
        factory.setSessionAcknowledgeMode(Session.AUTO_ACKNOWLEDGE);
        //連接數
        factory.setConcurrency("5-10");
        //指定任務線程池
        factory.setTaskExecutor(new ThreadPoolExecutor(5, 10, 1, TimeUnit.MINUTES,
                new LinkedBlockingQueue<>(100), new ThreadPoolExecutor.CallerRunsPolicy()));
        return factory;
    }
}

使用示例

消息處理

@Service
public class RequestLogMessageReceiver implements IMessageReceiver{
    @Autowired
    private F_RequestLogService requestLogService;

    @Override
    public void handleMessage(Object bodyObject, HashMap extraParam) {
        F_RequestLogDO requestLogDO = (F_RequestLogDO)bodyObject;
        requestLogService.insert(requestLogDO);
    }
}

發送消息

@AutoWired
private MessageUtil messageUtil;
messageUtil.sendMessage(requestLogDO,RequestLogMessageReceiver.class,null);