spring-boot 集成 rabbitmq

本文示例主要参看官方的demo

https://github.com/spring-projects/spring-boot/tree/master/spring-boot-samples/spring-boot-sample-amqp

https://github.com/spring-projects/spring-amqp-samples

RabbitMQ

介绍

RabbitMQ是流行的开源消息队列系统，用erlang语言开发。RabbitMQ是AMQP（高级消息队列协议）的标准实现。

概念

• Broker：简单来说就是消息队列服务器实体。
• Exchange：消息交换机，它指定消息按什么规则，路由到哪个队列。
• Queue：消息队列载体，每个消息都会被投入到一个或多个队列。
• Binding：绑定，它的作用就是把exchange和queue按照路由规则绑定起来。
• Routing Key：路由关键字，exchange根据这个关键字进行消息投递。
• vhost：虚拟主机，一个broker里可以开设多个vhost，用作不同用户的权限分离。
• producer：消息生产者，就是投递消息的程序。
• consumer：消息消费者，就是接受消息的程序。
• channel：消息通道，在客户端的每个连接里，可建立多个channel，每个channel代表一个会话任务。

使用过程

1. 客户端连接到消息队列服务器，打开一个channel。
2. 客户端声明一个exchange，并设置相关属性。
3. 客户端声明一个queue，并设置相关属性。
4. 客户端使用routing key，在exchange和queue之间建立好绑定关系。
5. 客户端投递消息到exchange。

exchange接收到消息后，就根据消息的key和已经设置的binding，进行消息路由，将消息投递到一个或多个队列里。

exchange也有几个类型，完全根据key进行投递的叫做Direct交换机，例如，绑定时设置了routing key为”abc”，那么客户端提交的消息，只有设置了key为”abc”的才会投递到队列。对key进行模式匹配后进行投递的叫做Topic交换机，符号”#”匹配一个或多个词，符号”*”匹配正好一个词。例如”abc.#”匹配”abc.def.ghi”，”abc.*”只匹配”abc.def”。还有一种不需要key的，叫做Fanout交换机，它采取广播模式，一个消息进来时，投递到与该交换机绑定的所有队列。

RabbitMQ支持消息的持久化，也就是数据写在磁盘上，为了数据安全考虑，我想大多数用户都会选择持久化。消息队列持久化包括3个部分：

1. exchange持久化，在声明时指定durable => 1
2. queue持久化，在声明时指定durable => 1
3. 消息持久化，在投递时指定delivery_mode => 2（1是非持久化）

如果exchange和queue都是持久化的，那么它们之间的binding也是持久化的。如果exchange和queue两者之间有一个持久化，一个非持久化，就不允许建立绑定。

以上内容抄自百度百科，RabbitMQ 百度百科

其它关于RabbitMQ的介绍可以看 http://www.cnblogs.com/qiyebao/p/4205626.html

Spring-boot 集成 rabbitmq

添加maven依赖

[html] view plain copy

 print?

1. <dependency>  
2.       <groupId>org.springframework.boot</groupId>  
3.       <artifactId>spring-boot-starter-amqp</artifactId>  
4. </dependency>  

简单实现

配置

在application.properties中增加如下配置

[plain] view plain copy

 print?

1. spring.rabbitmq.addresses=127.0.0.1:5672  
2. spring.rabbitmq.username=guest  
3. spring.rabbitmq.password=guest  
4. spring.rabbitmq.publisher-confirms=true  
5. spring.rabbitmq.virtual-host=/  

rabbitmq端口说明：5672-amqp，25672-clustering，61613-stomp，1883-mqtt

消息生产者

[java] view plain copy

 print?

1. package com.rabbitmq.send;  
2.   
3. import org.springframework.amqp.rabbit.core.RabbitTemplate;  
4. import org.springframework.beans.factory.annotation.Autowired;  
5. import org.springframework.stereotype.Component;  
6.   
7. @Component  
8. public class Sender {  
9.   
10.     @Autowired  
11.     private RabbitTemplate rabbitTemplate;  
12.   
13.     public void send(String msg) {  
14.         this.rabbitTemplate.convertAndSend("foo", msg);  
15.     }  
16. }  

消息监听者

[java] view plain copy

 print?

1. package com.rabbitmq.listener;  
2.   
3. import org.slf4j.Logger;  
4. import org.slf4j.LoggerFactory;  
5. import org.springframework.amqp.core.Queue;  
6. import org.springframework.amqp.rabbit.annotation.RabbitHandler;  
7. import org.springframework.amqp.rabbit.annotation.RabbitListener;  
8. import org.springframework.context.annotation.Bean;  
9. import org.springframework.context.annotation.Configuration;  
10. import org.springframework.messaging.handler.annotation.Payload;  
11.   
12. @Configuration  
13. @RabbitListener(queues = "foo")  
14. public class Listener {  
15.   
16.     private static final Logger LOGGER = LoggerFactory.getLogger(Listener.class);  
17.   
18.     @Bean  
19.     public Queue fooQueue() {  
20.         return new Queue("foo");  
21.     }  
22.   
23.     @RabbitHandler  
24.     public void process(@Payload String foo) {  
25.         LOGGER.info("Listener: " + foo);  
26.     }  
27. }  

测试Controller

[java] view plain copy

 print?

1. package com.rabbitmq.controller;  
2.   
3. import com.rabbitmq.send.Sender;  
4. import org.springframework.beans.factory.annotation.Autowired;  
5. import org.springframework.web.bind.annotation.GetMapping;  
6. import org.springframework.web.bind.annotation.RestController;  
7.   
8. import javax.servlet.http.HttpServletRequest;  
9.   
10. @RestController  
11. public class RabbitmqController {  
12.   
13.     @Autowired  
14.     private Sender sender;  
15.   
16.     @GetMapping("/send")  
17.     public String send(HttpServletRequest request, String msg) {  
18.         sender.send(msg);  
19.         return "Send OK.";  
20.     }  
21. }  

测试

启动服务，在浏览器输入 http://127.0.0.1:8080/send?msg=this%20is%20a%20test，点击回车可以在控制台看到如下输出

[plain] view plain copy

 print?

1. INFO 5559 --- [cTaskExecutor-1] c.rabbitmq.listener.Listener  : Listener: this is a test  
2. [SimpleAsyncTaskExecutor-1] INFO  c.rabbitmq.listener.Listener - Listener: this is a test  

带ConfirmCallback的使用

增加回调处理，这里不再使用application.properties默认配置的方式，会在程序中显示的使用文件中的配置信息。

配置

[java] view plain copy

 print?

1. package com.rabbitmq.config;  
2.   
3. import org.springframework.amqp.rabbit.connection.CachingConnectionFactory;  
4. import org.springframework.amqp.rabbit.connection.ConnectionFactory;  
5. import org.springframework.amqp.rabbit.core.RabbitTemplate;  
6. import org.springframework.beans.factory.annotation.Value;  
7. import org.springframework.beans.factory.config.ConfigurableBeanFactory;  
8. import org.springframework.context.annotation.Bean;  
9. import org.springframework.context.annotation.Configuration;  
10. import org.springframework.context.annotation.Scope;  
11.   
12. @Configuration  
13. public class AmqpConfig {  
14.   
15.     public static final String FOO_EXCHANGE   = "callback.exchange.foo";  
16.     public static final String FOO_ROUTINGKEY = "callback.routingkey.foo";  
17.     public static final String FOO_QUEUE      = "callback.queue.foo";  
18.   
19.     @Value("${spring.rabbitmq.addresses}")  
20.     private String addresses;  
21.     @Value("${spring.rabbitmq.username}")  
22.     private String username;  
23.     @Value("${spring.rabbitmq.password}")  
24.     private String password;  
25.     @Value("${spring.rabbitmq.virtual-host}")  
26.     private String virtualHost;  
27.     @Value("${spring.rabbitmq.publisher-confirms}")  
28.     private boolean publisherConfirms;  
29.   
30.     @Bean  
31.     public ConnectionFactory connectionFactory() {  
32.         CachingConnectionFactory connectionFactory = new CachingConnectionFactory();  
33.         connectionFactory.setAddresses(addresses);  
34.         connectionFactory.setUsername(username);  
35.         connectionFactory.setPassword(password);  
36.         connectionFactory.setVirtualHost(virtualHost);  
37.         /** 如果要进行消息回调，则这里必须要设置为true */  
38.         connectionFactory.setPublisherConfirms(publisherConfirms);  
39.         return connectionFactory;  
40.     }  
41.   
42.     @Bean  
43.     /** 因为要设置回调类，所以应是prototype类型，如果是singleton类型，则回调类为最后一次设置 */  
44.     @Scope(ConfigurableBeanFactory.SCOPE_PROTOTYPE)  
45.     public RabbitTemplate rabbitTemplate() {  
46.         RabbitTemplate template = new RabbitTemplate(connectionFactory());  
47.         return template;  
48.     }  
49.   
50. }  

消息生产者

[java] view plain copy

 print?

1. package com.rabbitmq.send;  
2.   
3. import com.rabbitmq.config.AmqpConfig;  
4. import org.slf4j.Logger;  
5. import org.slf4j.LoggerFactory;  
6. import org.springframework.amqp.rabbit.core.RabbitTemplate;  
7. import org.springframework.amqp.rabbit.support.CorrelationData;  
8. import org.springframework.beans.factory.annotation.Autowired;  
9. import org.springframework.stereotype.Component;  
10.   
11. import java.util.UUID;  
12.   
13. @Component  
14. public class Sender implements RabbitTemplate.ConfirmCallback {  
15.   
16.     private static final Logger LOGGER = LoggerFactory.getLogger(Sender.class);  
17.   
18.     private RabbitTemplate rabbitTemplate;  
19.   
20.     @Autowired  
21.     public Sender(RabbitTemplate rabbitTemplate) {  
22.         this.rabbitTemplate = rabbitTemplate;  
23.         this.rabbitTemplate.setConfirmCallback(this);  
24.     }  
25.   
26.     public void send(String msg) {  
27.         CorrelationData correlationData = new CorrelationData(UUID.randomUUID().toString());  
28.         LOGGER.info("send: " + correlationData.getId());  
29.         this.rabbitTemplate.convertAndSend(AmqpConfig.FOO_EXCHANGE, AmqpConfig.FOO_ROUTINGKEY, msg, correlationData);  
30.     }  
31.   
32.     /** 回调方法 */  
33.     @Override  
34.     public void confirm(CorrelationData correlationData, boolean ack, String cause) {  
35.         LOGGER.info("confirm: " + correlationData.getId());  
36.     }  
37. }  

消息监听者

[java] view plain copy

 print?

1. package com.rabbitmq.listener;  
2.   
3. import com.rabbitmq.config.AmqpConfig;  
4. import org.slf4j.Logger;  
5. import org.slf4j.LoggerFactory;  
6. import org.springframework.amqp.core.Binding;  
7. import org.springframework.amqp.core.BindingBuilder;  
8. import org.springframework.amqp.core.DirectExchange;  
9. import org.springframework.amqp.core.Queue;  
10. import org.springframework.amqp.rabbit.annotation.RabbitHandler;  
11. import org.springframework.amqp.rabbit.annotation.RabbitListener;  
12. import org.springframework.context.annotation.Bean;  
13. import org.springframework.context.annotation.Configuration;  
14. import org.springframework.messaging.handler.annotation.Payload;  
15.   
16. @Configuration  
17. @RabbitListener(queues = AmqpConfig.FOO_QUEUE)  
18. public class Listener {  
19.   
20.     private static final Logger LOGGER = LoggerFactory.getLogger(Listener.class);  
21.   
22.     /** 设置交换机类型  */  
23.     @Bean  
24.     public DirectExchange defaultExchange() {  
25.         /** 
26.          * DirectExchange:按照routingkey分发到指定队列 
27.          * TopicExchange:多关键字匹配 
28.          * FanoutExchange: 将消息分发到所有的绑定队列，无routingkey的概念 
29.          * HeadersExchange ：通过添加属性key-value匹配 
30.          */  
31.         return new DirectExchange(AmqpConfig.FOO_EXCHANGE);  
32.     }  
33.   
34.     @Bean  
35.     public Queue fooQueue() {  
36.         return new Queue(AmqpConfig.FOO_QUEUE);  
37.     }  
38.   
39.     @Bean  
40.     public Binding binding() {  
41.         /** 将队列绑定到交换机 */  
42.         return BindingBuilder.bind(fooQueue()).to(defaultExchange()).with(AmqpConfig.FOO_ROUTINGKEY);  
43.     }  
44.   
45.     @RabbitHandler  
46.     public void process(@Payload String foo) {  
47.         LOGGER.info("Listener: " + foo);  
48.     }  
49. }  

或者使用下面的代码来代替@RabbitHandler注解的process方法

[java] view plain copy

 print?

1. @Bean  
2. public SimpleMessageListenerContainer messageContainer() {  
3.     SimpleMessageListenerContainer container = new SimpleMessageListenerContainer(connectionFactory());  
4.     container.setQueues(fooQueue());  
5.     container.setExposeListenerChannel(true);  
6.     container.setMaxConcurrentConsumers(1);  
7.     container.setConcurrentConsumers(1);  
8.     container.setAcknowledgeMode(AcknowledgeMode.MANUAL); //设置确认模式手工确认  
9.     container.setMessageListener(new ChannelAwareMessageListener() {  
10.   
11.         @Override  
12.         public void onMessage(Message message, Channel channel) throws Exception {  
13.             byte[] body = message.getBody();  
14.             LOGGER.info("Listener onMessage : " + new String(body));  
15.             channel.basicAck(message.getMessageProperties().getDeliveryTag(), false); //确认消息成功消费  
16.         }  
17.     });  
18.     return container;  
19. }  

这里参看了这篇博文 http://blog.csdn.net/liaokailin/article/details/49559571

测试

运行服务，刷新上面的测试链接，可以在控制台看到如下输出

[plain] view plain copy

 print?

1. INFO 15122 --- [nio-8080-exec-1] com.jikefriend.rabbitmq.send.Sender      : send: c678afb7-af8b-42b2-9370-ea7f9d6004a0  
2. [http-nio-8080-exec-1] INFO  com.jikefriend.rabbitmq.send.Sender - send: c678afb7-af8b-42b2-9370-ea7f9d6004a0  
3. INFO 15122 --- [ 127.0.0.1:5672] com.jikefriend.rabbitmq.send.Sender      : confirm: c678afb7-af8b-42b2-9370-ea7f9d6004a0  
4. [AMQP Connection 127.0.0.1:5672] INFO  com.jikefriend.rabbitmq.send.Sender - confirm: c678afb7-af8b-42b2-9370-ea7f9d6004a0  
5. INFO 15122 --- [cTaskExecutor-1] c.jikefriend.rabbitmq.listener.Listener  : Listener: this is a test  
6. [SimpleAsyncTaskExecutor-1] INFO  c.j.rabbitmq.listener.Listener - Listener: this is a test