RabbitMQ 高级特性之重试机制

1. 简介

在消息传递时，有可能会因为网络故障、内存资源不足等不可控原因，导致消息没有成功发送出去，这时我们就可以选择将这条消息进行重新发送。能够重新发送的前提是代码逻辑没有问题。

2. 需要的配置

spring:
  rabbitmq:
    listener:
      simple:
        acknowledge-mode: auto
        retry:
          enabled: true # 开启消费者失败重试
          initial-interval: 5000ms # 初始失败等待时⻓为5秒
          max-attempts: 5 # 最⼤重试次数(包括自身消费的⼀次)

在配置信息中设置了消息的重发次数，该次数包括一开始生产者发送消息的那一次。

这里我们需要注意，在使用重试机制时，需要搭配 auto 使用，原因下面进行讲解。

3. auto 与重试机制搭配使用的结果

生产者代码如下：

@RequestMapping("/producer")
@RestController
public class ProducerController {

    @Resource(name = "rabbitTemplate")
    private RabbitTemplate rabbitTemplate;

    /**
     * 重试机制
     */
    @RequestMapping("/retry")
    public String retry() {
        String message = "retry test...";

        rabbitTemplate.convertAndSend(Constants.RETRY_EXCHANGE, Constants.RETRY_ROUTINGKEY, message);

        return "消息发送成功";
    }
}

对于无异常版本的消费者代码，其代码运行结果即正常消费消息，下面只使用有异常版本的消费者代码：

@Slf4j
@Component
public class RetryListener {

    @RabbitListener(queues = Constants.RETRY_QUEUE)
    public void listener(Message message) {
        String messageInfo = new String(message.getBody());
        long deliveryTag = message.getMessageProperties().getDeliveryTag();

        log.info("接收消息, message: {}, deliveryTag: {}", messageInfo, deliveryTag);

        int num = 1 / 0;

        log.info("消息消费完成");
    }
}

代码运行结果如下：

由于在消费者代码中出现了除数为 0 的错误，于是消息就消费失败，触发了消息重发机制后兄奥西重发了 4 次，消息一共发送了 5 次。并且在日志中可以看出，这些消息的 deliveryTag 都是相同的。

4. manual 与 重试机制搭配使用的结果

将配置文件的 acknowledge-mode 修改为 manual，并在消费者代码中添加 basicAck 和 basicNack，代码如下：

@Slf4j
@Component
public class RetryListener {

    @RabbitListener(queues = Constants.RETRY_QUEUE)
    public void listener(Message message, Channel channel) throws IOException {

        String messageInfo = new String(message.getBody());
        long deliveryTag = message.getMessageProperties().getDeliveryTag();

        try {
            log.info("接收消息, message: {}, deliveryTag: {}", messageInfo, deliveryTag);

            int num = 1 / 0;

            log.info("消息消费完成");

            channel.basicAck(deliveryTag, false);

        } catch (Exception e) { //此处的异常必须包含 除数为 0 的异常，不然就不会进入到 catch 中，就导致不会执行 basicNack 方法，就无法将消息重新入队列
            channel.basicNack(deliveryTag, false, true);
        }
    }
}

代码运行结果如下：

从结果中可以看出，虽然设置了重发次数为5次，但是 deliveryTag 却一直在递增，就表示该消息一直在入队列并发送，没有受到重发机制的限制。

所以在重试机制下，搭配 auto 确认模式使用才能发挥效果。