一起来学SpringBoot | 第十二篇：初探RabbitMQ消息队列

曾经终败给现在 2022-05-22 08:58 212阅读 0赞

>  *  **本文作者：**唐亚峰
>  *  **本文链接：**[http://blog.battcn.com/2018/05/22/springboot/v2-queue-rabbitmq/][http_blog.battcn.com_2018_05_22_springboot_v2-queue-rabbitmq]
>  *  **版权声明：**本博客所有文章除特别声明外，均采用[CC BY-NC-SA 3.0][]许可协议。转载请注明出处！

--------------------

> `SpringBoot`是为了简化`Spring`应用的创建、运行、调试、部署等一系列问题而诞生的产物，**`自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程`**

**`MQ全称（Message Queue）`又名消息队列，是一种异步通讯的中间件。**可以将它理解成邮局，发送者将消息传递到邮局，然后由邮局帮我们发送给具体的消息接收者（消费者），具体发送过程与时间我们无需关心，它也不会干扰我进行其它事情。**常见的MQ有`kafka`、`activemq`、`zeromq`、`rabbitmq`等等，各大MQ的对比和优劣势可以自行`Google`**

## rabbitmq ##

**`RabbitMQ`是一个遵循AMQP协议**，由面向高并发的`erlanng`语言开发而成，用在实时的对可靠性要求比较高的消息传递上，支持多种语言客户端。支持`延迟队列（这是一个非常有用的功能）`….

### 基础概念 ###

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

**基于`Centos7.x`安装请参考：**[http://blog.battcn.com/2017/08/20/linux/linux-centos7-ribbitmq/][http_blog.battcn.com_2017_08_20_linux_linux-centos7-ribbitmq]

### 常见应用场景 ###

1.  邮箱发送：用户注册后投递消息到`rabbitmq`中，由消息的消费方异步的发送邮件，提升系统响应速度
2.  流量削峰：一般在秒杀活动中应用广泛，秒杀会因为流量过大，导致应用挂掉，为了解决这个问题，一般在应用前端加入消息队列。用于控制活动人数，将超过此一定阀值的订单直接丢弃。缓解短时间的高流量压垮应用。
3.  订单超时：利用`rabbitmq`的延迟队列，可以很简单的实现**`订单超时`**的功能，比如用户在下单后30分钟未支付取消订单
4.  还有更多应用场景就不一一列举了…..

## 导入依赖 ##

在`pom.xml`中添加`spring-boot-starter-amqp`的依赖

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-amqp</artifactId>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.46</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

## 属性配置 ##

在`application.properties`文件中配置`rabbitmq`相关内容，值得注意的是这里配置了手动ACK的开关

spring.rabbitmq.host=127.0.0.1
    spring.rabbitmq.port=5672
    spring.rabbitmq.virtual-host=/
    # 手动ACK 不开启自动ACK模式,目的是防止报错后未正确处理消息丢失 默认 为 none
    spring.rabbitmq.listener.simple.acknowledge-mode=manual

## 具体编码 ##

### 定义队列 ###

如果手动创建过或者`RabbitMQ`中已经存在该队列那么也可以省略下述代码…

package com.winterchen;
    
    import org.springframework.amqp.core.Queue;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    
    /** * Created by Donghua.Chen on 2018/6/20. */
    @Configuration
    public class RabbitConfig { 
    
        public static final String DEFAULT_BOOK_QUEUE = "dev.book.register.default.queue";
        public static final String MANUAL_BOOK_QUEUE = "dev.book.register.manual.queue";
    
        @Bean
        public Queue defaultBookQueue() {
            // 第一个是 QUEUE 的名字,第二个是消息是否需要持久化处理
            return new Queue(DEFAULT_BOOK_QUEUE, true);
        }
    
        @Bean
        public Queue manualBookQueue() {
            // 第一个是 QUEUE 的名字,第二个是消息是否需要持久化处理
            return new Queue(MANUAL_BOOK_QUEUE, true);
        }
    }

### 实体类 ###

创建一个`User`类

package com.winterchen.domain;
    
    import java.io.Serializable;
    
    /** * Created by Donghua.Chen on 2018/6/20. */
    public class Book implements Serializable { 
        private static final long serialVersionUID = -2164058270260403154L;
    
        private String id;
        private String name;
    
        public Book() {
        }
    
        public Book(String id, String name) {
            this.id = id;
            this.name = name;
        }
    
        // 省略get set ...
    }

### 控制器 ###

编写一个`Controller`类，用于消息发送工作

package com.winterchen.controller;
    
    import com.winterchen.config.RabbitConfig;
    import com.winterchen.domain.Book;
    import org.springframework.amqp.rabbit.core.RabbitTemplate;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    
    /** * Created by Donghua.Chen on 2018/6/20. */
    @RestController
    @RequestMapping(value = "/books")
    public class BookController { 
    
    
        private final RabbitTemplate rabbitTemplate;
    
        @Autowired
        public BookController(RabbitTemplate rabbitTemplate) {
            this.rabbitTemplate = rabbitTemplate;
        }
    
        /** * this.rabbitTemplate.convertAndSend(RabbitConfig.DEFAULT_BOOK_QUEUE, book); 对应 {@link BookHandler#listenerAutoAck} * this.rabbitTemplate.convertAndSend(RabbitConfig.MANUAL_BOOK_QUEUE, book); 对应 {@link BookHandler#listenerManualAck} */
        @GetMapping
        public void defaultMessage() {
            Book book = new Book();
            book.setId("1");
            book.setName("一起来学Spring Boot");
            this.rabbitTemplate.convertAndSend(RabbitConfig.DEFAULT_BOOK_QUEUE, book);
            this.rabbitTemplate.convertAndSend(RabbitConfig.MANUAL_BOOK_QUEUE, book);
        }
    }

### 消息消费者 ###

默认情况下`spring-boot-data-amqp`是自动`ACK`机制，就意味着 MQ 会在消息消费完毕后自动帮我们去ACK，这样依赖就存在这样一个问题：**如果报错了，消息不会丢失，会无限循环消费，很容易就吧磁盘空间耗完，虽然可以配置消费的次数但这种做法也有失优雅。目前比较推荐的就是我们`手动ACK`然后将消费错误的消息转移到其它的消息队列中，做补偿处理**

package com.winterchen.handler;
    
    import com.rabbitmq.client.Channel;
    import com.winterchen.config.RabbitConfig;
    import com.winterchen.domain.Book;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.amqp.core.Message;
    import org.springframework.amqp.rabbit.annotation.RabbitListener;
    import org.springframework.stereotype.Component;
    
    import java.io.IOException;
    
    /** * BOOK_QUEUE 消费者 * Created by Donghua.Chen on 2018/6/20. */
    @Component
    public class BookHandler { 
    
        private static final Logger log = LoggerFactory.getLogger(BookHandler.class);
    
        /** * <p>TODO 该方案是 spring-boot-data-amqp 默认的方式,不太推荐。具体推荐使用 listenerManualAck()</p> * 默认情况下,如果没有配置手动ACK, 那么Spring Data AMQP 会在消息消费完毕后自动帮我们去ACK * 存在问题：如果报错了,消息不会丢失,但是会无限循环消费,一直报错,如果开启了错误日志很容易就吧磁盘空间耗完 * 解决方案：手动ACK,或者try-catch 然后在 catch 里面讲错误的消息转移到其它的系列中去 * spring.rabbitmq.listener.simple.acknowledge-mode=manual * <p> * * @param book 监听的内容 */
        @RabbitListener(queues = {RabbitConfig.DEFAULT_BOOK_QUEUE})
        public void listenerAutoAck(Book book, Message message, Channel channel) {
            // TODO 如果手动ACK,消息会被监听消费,但是消息在队列中依旧存在,如果 未配置 acknowledge-mode 默认是会在消费完毕后自动ACK掉
            final long deliveryTag = message.getMessageProperties().getDeliveryTag();
            try {
                log.info("[listenerAutoAck 监听的消息] - [{}]", book.toString());
                // TODO 通知 MQ 消息已被成功消费,可以ACK了
                channel.basicAck(deliveryTag, false);
            } catch (IOException e) {
                try {
                    // TODO 处理失败,重新压入MQ
                    channel.basicRecover();
                } catch (IOException e1) {
                    e1.printStackTrace();
                }
            }
        }
    
        @RabbitListener(queues = {RabbitConfig.MANUAL_BOOK_QUEUE})
        public void listenerManualAck(Book book, Message message, Channel channel) {
            log.info("[listenerManualAck 监听的消息] - [{}]", book.toString());
            try {
                // TODO 通知 MQ 消息已被成功消费,可以ACK了
                channel.basicAck(message.getMessageProperties().getDeliveryTag(), false);
            } catch (IOException e) {
                // TODO 如果报错了,那么我们可以进行容错处理,比如转移当前消息进入其它队列
            }
        }
    }

### 主函数 ###

package com.winterchen;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class SpringBootRabbitAmqpApplication { 
    
        public static void main(String[] args) {
            SpringApplication.run(SpringBootRabbitAmqpApplication.class, args);
        }
    }

### 测试 ###

完成准备事项后，启动`Chapter11Application`访问[http://localhost:8080/books][http_localhost_8080_books]将会看到如下内容，就代表一切正常….

2018-06-20 18:03:53.260  INFO 2471 --- [cTaskExecutor-1] com.winterchen.handler.BookHandler       : [listenerAutoAck 监听的消息] - [com.winterchen.domain.Book@45f8eb12]
    2018-06-20 18:03:53.261  INFO 2471 --- [cTaskExecutor-1] com.winterchen.handler.BookHandler       : [listenerManualAck 监听的消息] - [com.winterchen.domain.Book@2dc33b9c]

## 总结 ##

目前很多大佬都写过关于**`SpringBoot`**的教程了，如有雷同，请多多包涵，本教程基于最新的`spring-boot-starter-parent：2.0.2.RELEASE`编写，包括新版本的特性都会一起介绍…

## 说点什么 ##

springboot技术交流群：681513531

个人博客：[https://blog.winterchen.com][https_blog.winterchen.com]

全文代码：[https://github.com/WinterChenS/springboot-learning-experience][https_github.com_WinterChenS_springboot-learning-experience]

*  **本文作者：**唐亚峰
 *  **本文链接：**[http://blog.battcn.com/2018/05/22/springboot/v2-queue-rabbitmq/][http_blog.battcn.com_2018_05_22_springboot_v2-queue-rabbitmq]
 *  **版权声明：**本博客所有文章除特别声明外，均采用[CC BY-NC-SA 3.0][]许可协议。转载请注明出处！

[http_blog.battcn.com_2018_05_22_springboot_v2-queue-rabbitmq]: http://blog.battcn.com/2018/05/22/springboot/v2-queue-rabbitmq/
[CC BY-NC-SA 3.0]: https://creativecommons.org/licenses/by-nc-sa/3.0/
[http_blog.battcn.com_2017_08_20_linux_linux-centos7-ribbitmq]: http://blog.battcn.com/2017/08/20/linux/linux-centos7-ribbitmq/
[http_localhost_8080_books]: http://localhost:8080/books
[https_blog.winterchen.com]: https://blog.winterchen.com
[https_github.com_WinterChenS_springboot-learning-experience]: https://github.com/WinterChenS/springboot-learning-experience