(14)RabbitMQ与Spring的整合使用
本节将会介绍一下RabbitMQ与Spring的整合使用：spring-amqp和spring-rabbit，RabbitTemplate、MessageListener的使用介绍，如何发送消息，如何接收消息，如何设置消费者ack确认，如何添加confirm和return回调。。。。。。
概述
从事Java开发的小伙伴一般都离不了Spring框架吧，本节就介绍一下RabbitMQ与Spring的整合使用。Spring官网的project中可以看到一个项目Spring AMQP。
项目详细介绍地址为https://spring.io/projects/spring-amqp，我们看到红线圈住的部分：该项目包含两部分，spring-amqp是基础抽象，而spring-rabbit是spring-amqp的一个具体的实现。Spring官方的提供的demo地址为https://github.com/spring-projects/spring-amqp-samples，官方参考文档地址为https://docs.spring.io/spring-amqp/docs/1.7.5.RELEASE/reference/html/，可以选择查看对应的版本的文档。
具体实现
项目GitHub地址 https://github.com/RookieMember/RabbitMQ-Learning.git。废话不多说，可以撸代码。项目采用maven构建，项目结构如下
pom.xml内容如下：
4.0.0
com.wkp
rabbitmq-spring-demo
0.0.1
war
rabbitmq-spring-producer Maven Webapp
UTF-8
1.8
1.8
junit
junit
4.12
test
org.springframework.amqp
spring-rabbit
1.7.5.RELEASE
org.springframework
spring-test
4.3.13.RELEASE
org.slf4j
slf4j-log4j12
1.7.7
com.alibaba
fastjson
1.2.28
log4j日志配置如下
log4j.rootLogger=info,A1
log4j.logger.com.taotao = DEBUG
log4j.logger.org.mybatis = DEBUG
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss,SSS} [%t] [%c]-[%p] %m%nSpring配置文件rabbitmq-context.xml内容如下：spring-rabbit的常用配置都在里面，而且也都写了注释，就不再做过多的说明了。配置中包括重试策略，消息转换器，confirm回调，return回调等都是可选的，可以根据自己的需要进行配置。另外listener中还可以设置线程池等。。。。。。里面的配置还是挺多的，可以自己看看。
其实下面xml的配置都对应着相应的类，下面做个简单的说明：如果你是用的Spring4.x，并且用注解配置的话，就可以通过@Bean注解结合下面的类使用了，这样就不用写xml配置了，其实这个跟与SpringBoot的整合就比较像了。
关于消息转换器我使用的是Jackson2JsonMessageConverter，其实一般发个简单文本或者json字符串消息就够日常使用了，如果想要发一些复杂的消息内容也可以自定义消息转换器，实现MessageConverter接口即可。
消费者处理类如下：这里消费者是手动ack确认的。
package com.wkp.consumer;
import com.rabbitmq.client.Channel;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.amqp.core.Message;
import org.springframework.amqp.core.MessageProperties;
import org.springframework.amqp.rabbit.core.ChannelAwareMessageListener;
import java.util.Map;
public class ConsumerHandler implements ChannelAwareMessageListener {
Logger logger = LoggerFactory.getLogger(ConsumerHandler.class);
@Override
public void onMessage(Message message, Channel channel) throws Exception {
String msg = new String(message.getBody(),"utf-8");
MessageProperties pros = message.getMessageProperties();
Map headers = pros.getHeaders();
String routingKey = pros.getReceivedRoutingKey();
logger.info("消费者收到消息:{},routingKey:{},headers:{}",msg,routingKey,headers);
//消费者ack确认
channel.basicAck(message.getMessageProperties().getDeliveryTag(), false);
}
} confirm确认回调处理类如下：ack为true表示投递成功，为false表示投递失败（可以重新投递或者记录数据库），CorrelationData参数为发消息时指定的一个唯一ID，可以与发送的消息做关联，表示该消息已经成功发到了RabbitMQ上了，用于做消息可靠性投递。对confirm机制不了解的话可以参考《(10)RabbitMQ生产者确认：事务与confirm机制》
package com.wkp.producer;
import com.wkp.consumer.ConsumerHandler;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.amqp.rabbit.support.CorrelationData;
/**
* 做消息可靠性投递
*/
public class ConfirmCallBackHandler implements RabbitTemplate.ConfirmCallback {
Logger logger = LoggerFactory.getLogger(ConfirmCallBackHandler.class);
@Override
public void confirm(CorrelationData correlationData, boolean ack, String cause) {
//根据回调的correlationDataId判断发送的哪条消息投递成功，哪条没有成功
String correlationDataId =null;
if(correlationData!=null){
correlationDataId = correlationData.getId();
}
if(ack){
logger.info("CONFIRM机制:消息投递成功:correlationId:{}",correlationDataId);
}else{
//TODO 消息投递失败,重新投递
logger.warn("CONFIRM机制:消息投递失败:correlationId:{},cause:{}",correlationDataId,cause);
}
}
}
return回调处理类：当消息无法被路由时会触发return回调处理，并将发送的消息返回。对return机制不了解的话可以参考《(11)RabbitMQ的mandatory、immediate和ReturnListener》
package com.wkp.producer;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.amqp.core.Message;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
/**
* 消息路由失败
*/
public class ReturnCallBackHandler implements RabbitTemplate.ReturnCallback {
Logger logger = LoggerFactory.getLogger(ConfirmCallBackHandler.class);
@Override
public void returnedMessage(Message message, int replyCode, String replyText, String exchange, String routingKey) {
String msg = new String(message.getBody());
logger.warn("RETURN机制:消息路由失败,msg:{},replyCode:{},replyText:{},exchange:{},routingKey:{}",msg,replyCode,replyText,exchange,routingKey);
}
}
测试类如下：RabbitTemplate发送消息的方法常用的有send和convertAndSend（两个方法都提供了非常多的重载的方法），可以结合自己的需求使用对应的方法。发送消息时可以设置属性及header信息，还有消息编码、contenttype等。
package com.wkp.test;
import com.alibaba.fastjson.JSONObject;
import com.alibaba.fastjson.serializer.SerializerFeature;
import com.wkp.consumer.ConsumerHandler;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.amqp.AmqpException;
import org.springframework.amqp.core.*;
import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import org.springframework.amqp.rabbit.core.RabbitAdmin;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.amqp.rabbit.listener.MessageListenerContainer;
import org.springframework.amqp.rabbit.support.CorrelationData;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import javax.annotation.Resource;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations={"classpath:rabbitmq-context.xml"})
public class ProducerTest {
Logger logger = LoggerFactory.getLogger(ProducerTest.class);
@Resource
private RabbitTemplate rabbitTemplate;
//CorrelationData中包含一个id(我们可以自定义，将其与发送的消息相关联)，当开启了confirm机制后，会收到包含该参数的回调，用于消息可靠性投递，可选的
private CorrelationData corrData=new CorrelationData(String.valueOf(System.currentTimeMillis()));
/**
* 发送简单文本消息
*/
@Test
public void test_sendTextMsg1(){
//1 创建消息
//可以添加一些消息属性
MessageProperties messageProperties = new MessageProperties();
messageProperties.getHeaders().put("desc", "信息描述..");
messageProperties.getHeaders().put("type", "自定义消息类型..");
Message message = new Message("send简单文本消息".getBytes(), messageProperties);
rabbitTemplate.send("spring_topic_exchange","test.add", message,corrData);
}
/**
* 发送简单文本消息
*/
@Test
public void test_sendTextMsg2(){
//可以设置消息属性，可选的
MessagePostProcessor mp=new MessagePostProcessor() {
@Override
public Message postProcessMessage(Message message) throws AmqpException {
logger.info("------发消息时添加额外的设置---------");
message.getMessageProperties().getHeaders().put("desc", "额外修改的信息描述");
message.getMessageProperties().getHeaders().put("attr", "额外新加的属性");
return message;
}
};
rabbitTemplate.convertAndSend("spring_topic_exchange","test.add","convertAndSend简单文本消息", mp, corrData);
}
/**
* 发送json文本消息
*/
@Test
public void test_sendJsonStringMsg(){
JSONObject json = new JSONObject();
json.put("name", "张三");
json.put("age", 20);
rabbitTemplate.convertAndSend("spring_topic_exchange","test.add",json.toJSONString(),corrData);
}
/**
* 发送json消息
*/
@Test
public void test_sendJsonObjMsg(){
JSONObject json = new JSONObject();
json.put("name", "李四");
json.put("age", 36);
byte[] bytes = JSONObject.toJSONBytes(json, SerializerFeature.WriteDateUseDateFormat, SerializerFeature.WriteMapNullValue);
MessageProperties props=new MessageProperties();
props.setContentType(MessageProperties.CONTENT_TYPE_JSON);
Message message=new Message(bytes, props);
rabbitTemplate.send("spring_topic_exchange","test.add", message, corrData);
}
/**
* 测试消息无法被路由，触发return回调
*/
@Test
public void test_return_noRoute(){
rabbitTemplate.convertAndSend("spring_topic_exchange","errorKey","无法路由的消息",corrData);
}
}
运行test_sendTextMsg1（）方法，可以看到控制台有如下输出：可以看到消费者收到了消息，confirm回调也触发了。
消费者收到消息:send简单文本消息,routingKey:test.add,headers:{spring_listener_return_correlation=dd87b185-dbfb-4a34-b782-44e663a1f9f0, type=自定义消息类型.., desc=信息描述..}
CONFIRM机制:消息投递成功:correlationId:1556161128811运行test_return_noRoute（）方法，可以看到控制台有如下输出：可以看到消费者没有收到消息，触发了return回调表示消息无法被路由，另外confirm回调也触发了。
RETURN机制:消息路由失败,msg:无法路由的消息,replyCode:312,replyText:NO_ROUTE,exchange:spring_topic_exchange,routingKey:errorKey
CONFIRM机制:消息投递成功:correlationId:1556161346932更多的测试方法输出结果就不一一贴出了，关于RabbitMQ与Spring的整合就介绍到这里，下一节将会介绍与SpringBoot的整合。