SpringBoot整合RabbitMQ之典型應用場景實戰一

時間 2019-11-07

標籤 springboot 整合 rabbitmq 典型應用場景實戰欄目 Spring 简体版

原文原文鏈接

實戰前言
RabbitMQ 做爲目前應用至關普遍的消息中間件，在企業級應用、微服務應用中充當着重要的角色。特別是在一些典型的應用場景以及業務模塊中具備重要的做用，好比業務服務模塊解耦、異步通訊、高併發限流、超時業務、數據延遲處理等。html

RabbitMQ 官網拜讀
首先，讓咱們先拜讀 RabbitMQ 官網的技術開發手冊以及相關的 Features，感興趣的朋友能夠耐心的閱讀其中的相關介紹，相信會有必定的收穫，地址可見：www.rabbitmq.com/getstarted.…spring

在閱讀該手冊過程當中，咱們能夠得知 RabbitMQ 其實核心就是圍繞「消息模型」來展開的，其中就包括了組成消息模型的相關組件：生產者，消費者，隊列，交換機，路由，消息等！而咱們在實戰應用中，實際上也是牢牢圍繞着「消息模型」來展開擼碼的！數據庫

下面，我就介紹一下這一消息模型的演變歷程，固然，這一歷程在 RabbitMQ 官網也是能夠窺覽獲得的！
後端

上面幾個圖就已經概述了幾個要點，並且，這幾個要點的含義能夠說是字如其名！bash

生產者：發送消息的程序
消費者：監聽接收消費消息的程序
消息：一串二進制數據流
隊列：消息的暫存區/存儲區
交換機：消息的中轉站，用於接收分發消息。其中有 fanout、direct、topic、headers 四種
路由：至關於密鑰/第三者，與交換機綁定便可路由消息到指定的隊列！

正如上圖所展現的消息模型的演變，接下來咱們將以代碼的形式實戰各類典型的業務場景！併發

SpringBoot 整合 RabbitMQ 實戰

工欲善其事，必先利其器。咱們首先須要藉助 IDEA 的 Spring Initializr 用 Maven 構建一個 SpringBoot 的項目，並引入 RabbitMQ、Mybatis、Log4j 等第三方框架的依賴。搭建完成以後，能夠簡單的寫個 RabbitMQController 測試一下項目是否搭建是否成功（能夠暫時用單模塊方式構建）
app

緊接着，咱們進入實戰的核心階段，在項目或者服務中使用 RabbitMQ，其實無非是有幾個核心要點要緊緊把握住，這幾個核心要點在擼碼過程當中須要「時刻的遊蕩在本身的腦海裏」，其中包括：框架

我要發送的消息是什麼
我應該須要建立什麼樣的消息模型：DirectExchange+RoutingKey？TopicExchange+RoutingKey？等
我要處理的消息是實時的仍是須要延時/延遲的？
消息的生產者須要在哪裏寫，消息的監聽消費者須要在哪裏寫，各自的處理邏輯是啥

基於這樣的幾個要點，咱們先小試牛刀一番，採用 RabbitMQ 實戰異步寫日誌與異步發郵件。固然啦，在進行實戰前，咱們須要安裝好 RabbitMQ 及其後端控制檯應用，並在項目中配置一下 RabbitMQ 的相關參數以及相關 Bean 組件。異步

1.RabbitMQ 安裝完成後，打開後端控制檯應用：http://localhost:15672/ guest guest 登陸，看到下圖即表示安裝成功ide

2.而後是項目配置文件層面的配置 application.properties

spring.rabbitmq.host=127.0.0.1
spring.rabbitmq.port=5672
spring.rabbitmq.username=guest
spring.rabbitmq.password=guest
spring.rabbitmq.listener.concurrency=10
spring.rabbitmq.listener.max-concurrency=20
spring.rabbitmq.listener.prefetch=5
複製代碼

其中，後面三個參數主要是用於「併發量的配置」，表示：併發消費者的初始化值，併發消費者的最大值，每一個消費者每次監聽時可拉取處理的消息數量。

接下來，咱們須要以 Configuration 的方式配置 RabbitMQ 並以 Bean 的方式顯示注入 RabbitMQ 在發送接收處理消息時相關 Bean 組件配置其中典型的配置是 RabbitTemplate 以及 SimpleRabbitListenerContainerFactory，前者是充當消息的發送組件，後者是用於管理RabbitMQ監聽器 的容器工廠，其代碼以下：

@Configuration
    public class RabbitmqConfig {
    private static final Logger log= LoggerFactory.getLogger(RabbitmqConfig.class);

    @Autowired
    private Environment env;

    @Autowired
    private CachingConnectionFactory connectionFactory;

    @Autowired
    private SimpleRabbitListenerContainerFactoryConfigurer factoryConfigurer;

    /**
     * 單一消費者
     * @return
     */
    @Bean(name = "singleListenerContainer")
    public SimpleRabbitListenerContainerFactory listenerContainer(){
        SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
        factory.setConnectionFactory(connectionFactory);
        factory.setMessageConverter(new Jackson2JsonMessageConverter());
        factory.setConcurrentConsumers(1);
        factory.setMaxConcurrentConsumers(1);
        factory.setPrefetchCount(1);
        factory.setTxSize(1);
        factory.setAcknowledgeMode(AcknowledgeMode.AUTO);
        return factory;
    }

    /**
     * 多個消費者
     * @return
     */
    @Bean(name = "multiListenerContainer")
    public SimpleRabbitListenerContainerFactory multiListenerContainer(){
        SimpleRabbitListenerContainerFactory factory = new SimpleRabbitListenerContainerFactory();
        factoryConfigurer.configure(factory,connectionFactory);
        factory.setMessageConverter(new Jackson2JsonMessageConverter());
        factory.setAcknowledgeMode(AcknowledgeMode.NONE);
        factory.setConcurrentConsumers(env.getProperty("spring.rabbitmq.listener.concurrency",int.class));
        factory.setMaxConcurrentConsumers(env.getProperty("spring.rabbitmq.listener.max-concurrency",int.class));
        factory.setPrefetchCount(env.getProperty("spring.rabbitmq.listener.prefetch",int.class));
        return factory;
    }

    @Bean
    public RabbitTemplate rabbitTemplate(){
        connectionFactory.setPublisherConfirms(true);
        connectionFactory.setPublisherReturns(true);
        RabbitTemplate rabbitTemplate = new RabbitTemplate(connectionFactory);
        rabbitTemplate.setMandatory(true);
        rabbitTemplate.setConfirmCallback(new RabbitTemplate.ConfirmCallback() {
            @Override
            public void confirm(CorrelationData correlationData, boolean ack, String cause) {
                log.info("消息發送成功:correlationData({}),ack({}),cause({})",correlationData,ack,cause);
            }
        });
        rabbitTemplate.setReturnCallback(new RabbitTemplate.ReturnCallback() {
            @Override
            public void returnedMessage(Message message, int replyCode, String replyText, String exchange, String routingKey) {
                log.info("消息丟失:exchange({}),route({}),replyCode({}),replyText({}),message:{}",exchange,routingKey,replyCode,replyText,message);
            }
        });
        return rabbitTemplate;
    }}
複製代碼

RabbitMQ 實戰：業務模塊解耦以及異步通訊

在一些企業級系統中，咱們常常能夠見到一個執行 function 一般是由許多子模塊組成的，這個 function 在執行過程當中，須要同步的將其代碼從頭開始執行到尾，即執行流程是 module_A -> module_B -> module_C -> module_D，典型的案例能夠參見彙編或者 C 語言等面向過程語言開發的應用，如今的一些 JavaWeb 應用也存在着這樣的寫法。

而咱們知道，這個執行流程其實對於整個 function 來說是有必定的弊端的，主要有兩點：

整個 function 的執行響應時間將好久；
若是某個 module 發生異常而沒有處理得當，可能會影響其餘 module 甚至整個 function 的執行流程與結果；
整個 function 中代碼可能會很冗長，模塊與模塊之間可能須要進行強通訊以及數據的交互，出現問題時難以定位與維護，甚至會陷入「改一處代碼而動全身」的尷尬境地！

故而，咱們須要想辦法進行優化，咱們須要將強關聯的業務模塊解耦以及某些模塊之間實行異步通訊！下面就以兩個場景來實戰咱們的優化措施！

場景一：異步記錄用戶操做日誌

對於企業級應用系統或者微服務應用中，咱們常常須要追溯跟蹤記錄用戶的操做日誌，而這部分的業務在某種程度上是不該該跟主業務模塊耦合在一塊兒的，故而咱們須要將其單獨抽出並以異步的方式與主模塊進行異步通訊交互數據。

下面咱們就用 RabbitMQ 的 DirectExchange+RoutingKey 消息模型也實現「用戶登陸成功記錄日誌」的場景。如前面所言，咱們須要在腦海裏迴盪着幾個要點：

消息模型：DirectExchange+RoutingKey 消息模型
消息：用戶登陸的實體信息，包括用戶名，登陸事件，來源的IP，所屬日誌模塊等信息
發送接收：在登陸的 Controller 中實現發送，在某個 listener 中實現接收並將監聽消費到的消息入數據表；實時發送接收

首先咱們須要在上面的 RabbitmqConfig 類中建立消息模型：包括 Queue、Exchange、RoutingKey 等的創建，代碼以下：

上圖中 env 獲取的信息，咱們須要在 application.properties 進行配置，其中 mq.env=local：

此時，咱們將整個項目/服務跑起來，並打開 RabbitMQ 後端控制檯應用，便可看到隊列以及交換機及其綁定已經創建好了，以下所示：

接下來，咱們須要在 Controller 中執行用戶登陸邏輯，記錄用戶登陸日誌，查詢獲取用戶角色視野資源信息等，因爲篇幅關係，在這裏咱們重點要實現的是用MQ實現「異步記錄用戶登陸日誌」的邏輯，即在這裏 Controller 將充當「生產者」的角色，核心代碼以下：

@RestController
    public class UserController {

    private static final Logger log= LoggerFactory.getLogger(HelloWorldController.class);

    private static final String Prefix="user";

    @Autowired
    private ObjectMapper objectMapper;

    @Autowired
    private UserMapper userMapper;

    @Autowired
    private UserLogMapper userLogMapper;

    @Autowired
    private RabbitTemplate rabbitTemplate;

    @Autowired
    private Environment env;

    @RequestMapping(value = Prefix+"/login",method = RequestMethod.POST,consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
    public BaseResponse login(@RequestParam("userName") String userName,@RequestParam("password") String password){
        BaseResponse response=new BaseResponse(StatusCode.Success);
        try {
            //TODO：執行登陸邏輯
            User user=userMapper.selectByUserNamePassword(userName,password);
            if (user!=null){
                //TODO：異步寫用戶日誌
                try {
                    UserLog userLog=new UserLog(userName,"Login","login",objectMapper.writeValueAsString(user));
                    userLog.setCreateTime(new Date());
                    rabbitTemplate.setMessageConverter(new Jackson2JsonMessageConverter());
                    rabbitTemplate.setExchange(env.getProperty("log.user.exchange.name"));
                    rabbitTemplate.setRoutingKey(env.getProperty("log.user.routing.key.name"));

                    Message message=MessageBuilder.withBody(objectMapper.writeValueAsBytes(userLog)).setDeliveryMode(MessageDeliveryMode.PERSISTENT).build();
                    message.getMessageProperties().setHeader(AbstractJavaTypeMapper.DEFAULT_CONTENT_CLASSID_FIELD_NAME, MessageProperties.CONTENT_TYPE_JSON); 
                    rabbitTemplate.convertAndSend(message);         
                }catch (Exception e){
                    e.printStackTrace();
                }

                //TODO：塞權限數據-資源數據-視野數據
            }else{
                response=new BaseResponse(StatusCode.Fail);
            }
        }catch (Exception e){
            e.printStackTrace();
        }
        return response;
    }}
複製代碼

在上面的「發送邏輯」代碼中，其實也體現了咱們最開始介紹的演進中的幾種消息模型，好比咱們是將消息發送到 Exchange 的而不是 Queue，消息是以二進制流的形式進行傳輸等等。當用 postman 請求到這個 controller 的方法時，咱們能夠在 RabbitMQ 的後端控制檯應用看到一條未確認的消息，經過 GetMessage 便可看到其中的詳情，以下：

最後，咱們將開發消費端的業務代碼，以下：

@Component
    public class CommonMqListener {

    private static final Logger log= LoggerFactory.getLogger(CommonMqListener.class);

    @Autowired
    private ObjectMapper objectMapper;

    @Autowired
    private UserLogMapper userLogMapper;

    @Autowired
    private MailService mailService;

    /**
     * 監聽消費用戶日誌
     * @param message
     */
    @RabbitListener(queues = "${log.user.queue.name}",containerFactory = "singleListenerContainer")
    public void consumeUserLogQueue(@Payload byte[] message){
        try {
            UserLog userLog=objectMapper.readValue(message, UserLog.class);
            log.info("監聽消費用戶日誌 監聽到消息： {} ",userLog);
            //TODO：記錄日誌入數據表
            userLogMapper.insertSelective(userLog);
        }catch (Exception e){
            e.printStackTrace();
        }
    }
複製代碼

將服務跑起來以後，咱們便可監聽消費到上面 Queue 中的消息，即當前用戶登陸的信息，並且，咱們也能夠看到「記錄用戶登陸日誌」的邏輯是由一條異於主業務線程的異步線程去執行的：