RabbitMq之发布确认(高级)

一.发送消息到交换机失败

正常情况下生产者只发布消息到交换机，无法确定是否成功把消息发送到交换机当中，由此发布确认的回调函数可以通知生产者消息是否发送到了交换机。

代码如下
1.先创建交换机、队列等信息

package jot.jothot.testMq;

import org.springframework.amqp.core.*;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 发布确认高级
 */
@Configuration
public class ConfirmConfig {

    //交换机
    public static final String CONFIRM_EXCHANGE_NAME= "confirm_exchange";
    //队列
    public static final String CONFIRM_QUEUE_NAME= "confirm_queue";
    //routingKey
    public static final String CONFIRM_ROUTING_NAME= "confirm_key";

    @Bean("confirmExchange")
    public DirectExchange directExchange(){
        return new DirectExchange(CONFIRM_EXCHANGE_NAME);
    }

    @Bean("confirmQueue")
    public Queue confirmQueue(){
        return QueueBuilder.durable(CONFIRM_QUEUE_NAME).build();
    }

    @Bean
    public Binding queueBindingExchange(@Qualifier("confirmExchange")DirectExchange directExchange,
                                        @Qualifier("confirmQueue")Queue confirmQueue){
        return BindingBuilder.bind(confirmQueue).to(directExchange).with(CONFIRM_ROUTING_NAME);
    }
}

2.创建消费者

package jot.jothot.testMq;

import com.rabbitmq.client.Channel;
import lombok.extern.slf4j.Slf4j;
import org.springframework.amqp.core.Message;
import org.springframework.amqp.rabbit.annotation.RabbitListener;
import org.springframework.stereotype.Component;

import java.util.Date;

@Slf4j
@Component
public class ReceiveMessage {

    @RabbitListener(queues = ConfirmConfig.CONFIRM_QUEUE_NAME ,containerFactory = "rabbitListenerContainerFactory")
    public void receiveMessage(Message message, Channel channel) throws Exception {
        // 处理消息
        String msg = new String(message.getBody());
        log.info("当前时间：{},收到发布确认高级队列的消息：{}",new Date().toString(),msg);
    }
}

3.编写回调接口

package jot.jothot.testMq;

import lombok.extern.slf4j.Slf4j;
import org.springframework.amqp.rabbit.connection.CorrelationData;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

/**
 * 回调实现类
 */
@Slf4j
@Component
public class MyCallBack implements RabbitTemplate.ConfirmCallback {

    @Autowired
    private RabbitTemplate rabbitTemplate;

    /**
     * 1、MyCallBack 实现了接口 RabbitTemplate.ConfirmCallback，注意 ConfirmCallback
     *   是 RabbitTemplate 类中的一个内部接口，所以在实现 RabbitTemplate.ConfirmCallback 接口后，
     *   还需要将其注入到 RabbitTemplate 的实例当中。
     * 2、标有 @PostConstruct 注解的方法，容器在 bean 创建完成并且属性赋值完成后，会调用该初始化方法。
     */
    @PostConstruct
    public void init(){
        rabbitTemplate.setConfirmCallback(this);
    }

    /**
     * 交换机不管是否接收到消息都会回调该方法
     *
     * @param correlationData 保存回调消息的ID及相关信息，由消息生产者确定，如果消息生产者未明确定义CorrelationData，则此处为null
     * @param ack ack=true/false true表示收到消息，false表示未收到消息
     * @param cause 若接收消息成功，则为null；若接收消息失败，则为失败的原因
     */
    @Override
    public void confirm(CorrelationData correlationData, boolean ack, String cause) {
        String id = correlationData !=null ? correlationData.getId():"";
        if(ack){
            log.info("交换机已经收到消息ID为{}的消息",id);
        }else {
            log.info("交换机未经收到消息ID为{}的消息由于原因{}",id,cause);
        }
    }
}

4.配置文件中配置publisher-confirm-type

  rabbitmq:
     host: 192.168.126.130
     port: 5672
     username: root
     password: 123456
     publisher-confirm-type: correlated #发布确认模式属性

publisher-confirm-type属性如下
1.NONE：禁用发布确认模式，是默认值
2.CORRELATED：发布消息成功到交换器后会触发回调方法
3.SIMPLE：有两种效果。一是和 CORRELATED 一样会触发回调方法；二是在发布消息成功后使用 rabbitTemplate 调用 waitForConfirms 或 waitForConfirmsOrDie 方法，等待 broker 节点返回发送结果，根据返回结果来判定下一步的逻辑。要注意的点是 waitForConfirmsOrDie 方法如果返回 false 则会关闭 channel，回导致接下来无法发送消息到 broker。
5.生产者

@PostMapping("/sendMsg")
    public void sendMsg(String message){
        CorrelationData correlationData = new CorrelationData("1");
        //给正确交换机发送消息
        rabbitTemplate.convertAndSend(ConfirmConfig.CONFIRM_EXCHANGE_NAME,ConfirmConfig.CONFIRM_ROUTING_NAME,message,correlationData);
        //给错误交换机发送消息
        rabbitTemplate.convertAndSend("xx",ConfirmConfig.CONFIRM_ROUTING_NAME,message,correlationData);
        log.info("当前时间：{},发送一条信息给队列：{}",new Date().toString(),message);
    }

启动项目调用接口显示如下

二.回退消息

交换机把消息推送到队列失败，也需要通知生产者消息发送失败

1.基于上面的代码，在回调类中实现回退接口

package jot.jothot.testMq;

import lombok.extern.slf4j.Slf4j;
import org.springframework.amqp.core.ReturnedMessage;
import org.springframework.amqp.rabbit.connection.CorrelationData;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;

/**
 * 回调实现类
 */
@Slf4j
@Component
public class MyCallBack implements RabbitTemplate.ConfirmCallback,RabbitTemplate.ReturnsCallback {

    @Autowired
    private RabbitTemplate rabbitTemplate;

    /**
     * 1、MyCallBack 实现了接口 RabbitTemplate.ConfirmCallback，注意 ConfirmCallback
     *   是 RabbitTemplate 类中的一个内部接口，所以在实现 RabbitTemplate.ConfirmCallback 接口后，
     *   还需要将其注入到 RabbitTemplate 的实例当中。
     * 2、标有 @PostConstruct 注解的方法，容器在 bean 创建完成并且属性赋值完成后，会调用该初始化方法。
     */
    @PostConstruct
    public void init(){
        //注入接口
        rabbitTemplate.setConfirmCallback(this);
        //注入消息回退接口
        rabbitTemplate.setReturnsCallback(this);
    }

    /**
     * 交换机不管是否接收到消息都会回调该方法
     *
     * @param correlationData 保存回调消息的ID及相关信息，由消息生产者确定，如果消息生产者未明确定义CorrelationData，则此处为null
     * @param ack ack=true/false true表示收到消息，false表示未收到消息
     * @param cause 若接收消息成功，则为null；若接收消息失败，则为失败的原因
     */
    @Override
    public void confirm(CorrelationData correlationData, boolean ack, String cause) {
        String id = correlationData !=null ? correlationData.getId():"";
        if(ack){
            log.info("交换机已经收到消息ID为{}的消息",id);
        }else {
            log.info("交换机未经收到消息ID为{}的消息由于原因{}",id,cause);
        }
    }

    /**
     * 消息回退接口
     * @param returned
     */
    @Override
    public void returnedMessage(ReturnedMessage returned) {
        log.error("消息{},被交换机{}退回，退回的原因：{}，路由key：{}",returned.getMessage(),returned.getExchange(),returned.getReplyText(),returned.getRoutingKey());
    }
}

2.修改RabbitMq配置文件

 rabbitmq:
     host: 192.168.126.130
     port: 5672
     username: root
     password: 123456
     publisher-confirm-type: correlated #发布确认模式属性
     publisher-returns: true #开启回退消息

3.生产者发送错误的RoutingKey

@PostMapping("/sendMsg")
    public void sendMsg(String message){
        CorrelationData correlationData = new CorrelationData("1")
        //错误队列发送消息
        rabbitTemplate.convertAndSend(ConfirmConfig.CONFIRM_EXCHANGE_NAME,"ConfirmConfig.CONFIRM_ROUTING_NAME",message,correlationData);
        log.info("当前时间：{},发送一条信息给队列：{}",new Date().toString(),message);
    }

演示结果如下

完整错误信息

消息(Body:'发布确认' MessageProperties [headers={spring_returned_message_correlation=1}, contentType=text/plain, 
contentEncoding=UTF-8, contentLength=0, receivedDeliveryMode=PERSISTENT, priority=0, deliveryTag=0]),
被交换机confirm_exchange退回，退回的原因：NO_ROUTE，路由key：ConfirmConfig.CONFIRM_ROUTING_NAME