如何在Spring Boot JMS监听器中传递错误原因到DLQ消息

针对你遇到的问题，在监听器端可以通过自定义JMS异常处理器的方式，将最后一次处理的异常根因添加到消息属性中，最终随消息进入DLQ。以下是具体实现步骤：

1. 实现自定义ErrorHandler #

创建一个实现Spring ErrorHandler接口的处理器，捕获监听器抛出的异常，提取根因并添加到消息的自定义属性中：

import org.slf4j.LoggerFactory;
import org.springframework.jms.support.JmsUtils;
import org.springframework.util.ErrorHandler;
import javax.jms.JMSException;
import javax.jms.Message;
import java.io.PrintWriter;
import java.io.StringWriter;

@Component
public class CustomJmsErrorHandler implements ErrorHandler {

    @Override
    public void handleError(Throwable throwable) {
        // 提取当前处理的JMS消息
        Message message = JmsUtils.extractMessage(throwable);
        if (message != null) {
            try {
                // 获取异常的根本原因
                Throwable rootCause = getRootCause(throwable);
                // 将异常栈信息转为字符串
                String errorDetails = stackTraceToString(rootCause);
                // 给消息添加自定义属性，存储异常根因
                message.setStringProperty("errorRootCause", errorDetails);
            } catch (JMSException e) {
                LoggerFactory.getLogger(getClass()).error("Failed to attach error details to message", e);
            }
        }
        // 重新抛出异常，让ActiveMQ继续执行重试和DLQ逻辑
        throw new RuntimeException(throwable);
    }

    // 递归获取异常的根因
    private Throwable getRootCause(Throwable throwable) {
        while (throwable.getCause() != null) {
            throwable = throwable.getCause();
        }
        return throwable;
    }

    // 将异常栈转为字符串
    private String stackTraceToString(Throwable throwable) {
        StringWriter sw = new StringWriter();
        PrintWriter pw = new PrintWriter(sw);
        throwable.printStackTrace(pw);
        return sw.toString();
    }
}

2. 绑定ErrorHandler到监听器 #

有两种方式将自定义处理器绑定到JMS监听器：

方式一：单个监听器指定 #

在@JmsListener注解中直接指定errorHandler：

@JmsListener(destination = "your-target-queue", errorHandler = "customJmsErrorHandler")
public void processMessage(TextMessage message) throws JMSException {
    // 你的业务处理逻辑，抛出异常时会被自定义处理器捕获
}

方式二：全局配置所有监听器 #

在JMS容器工厂中全局设置ErrorHandler，对所有监听器生效：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jms.annotation.EnableJms;
import org.springframework.jms.config.DefaultJmsListenerContainerFactory;
import javax.jms.ConnectionFactory;

@Configuration
@EnableJms
public class JmsConfig {

    @Bean
    public DefaultJmsListenerContainerFactory jmsListenerContainerFactory(
            ConnectionFactory connectionFactory,
            CustomJmsErrorHandler customJmsErrorHandler) {
        DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
        factory.setConnectionFactory(connectionFactory);
        // 绑定自定义异常处理器
        factory.setErrorHandler(customJmsErrorHandler);
        // 其他配置（如并发数、重试相关参数）
        return factory;
    }
}

3. 注意事项 #

• 属性长度限制：ActiveMQ默认对消息属性的长度有限制（默认是1024字节），如果异常栈过长可能会被截断。可以通过修改ActiveMQ broker的activemq.xml配置，调整systemUsage中的propertySize参数来扩大限制：

  <systemUsage>
      <systemUsage>
          <memoryUsage>...</memoryUsage>
          <storeUsage>...</storeUsage>
          <tempUsage>...</tempUsage>
          <propertySize>8192</propertySize> <!-- 调整为合适的大小 -->
      </systemUsage>
  </systemUsage>
  

• 消息体兼容性：如果不想修改消息属性，也可以考虑将异常信息追加到消息体末尾（但需确保业务端能兼容这种格式变化）。

内容的提问来源于stack exchange，提问作者Schumi77