第15课:Spring

第15课:Spring Boot 中集成 ActiveMQ

JMS 和 ActiveMQ 介绍

JMS 是什么

根据百度百科的解释:

JMS 即 Java 消息服务(Java Message Service)应用程序接口,是 Java 平台中面向消息中间件(MOM)的 API,用在两个应用程序之间,或分布式系统间发送消息,从而实现异步通信。JMS 是一个与具体平台无关的 API,绝大多数 MOM 提供商都对 JMS 提供支持。

JMS 只是接口,不同的提供商或者开源组织对其有不同的实现,ActiveMQ 就是其中之一,它支持 JMS,由 Apache 推出。

JMS 中有几个对象模型:

连接工厂:ConnectionFactory
JMS 连接:Connection
JMS 会话:Session
JMS 目的:Destination
JMS 生产者:Producer
JMS 消费者:Consumer
JMS 消息两种类型:点对点和发布/订阅。

可以看出 JMS 实际上和 JDBC 有点类似,JDBC 可以用来访问许多不同关系数据库的 API,而 JMS 同样提供了与厂商无关的访问方法,以访问消息收发服务。本文主要使用的是 ActiveMQ。

ActiveMQ

ActiveMQ 是 Apache 推出的一个能力强劲的开源消息总线。ActiveMQ 完全支持 JMS 1.1 和 J2EE 1.4 规范,尽管 JMS 规范出台已经很久了,JMS 在当今的 Java EE 应用中仍扮演着特殊的地位。ActiveMQ 主要用在异步消息的处理上,所谓异步消息即消息发送者无需等待消息接收者的处理以及返回,甚至无需关心消息是否发送成功。

异步消息主要有两种形式,队列(Queue)和主题(Topic),队列用于点对点形式的消息通信,主题用于发布/订阅式的消息通信。本文主要来学习一下在 Spring Boot 中如何使用这两种形式的消息。

ActiveMQ 安装

使用 ActiveMQ,首先需要去官网下载

本课程选用 apache-activemq-5.15.3 版本,下载解压后会产生一个名为 apache-activemq-5.15.3 的文件夹,没错,这就安装好了,非常简单,开箱即用。

打开文件夹,可以看到有个 activemq-all-5.15.3.jar,我们可以将 Jar 加入工程里,如果使用 Maven,这个 Jar 就不需要了。

使用 ActiveMQ 之前,首先需先启动它。刚才解压后的目录中有一个 bin 目录,里面有 Win32 和 Win64 两个目录,根据自己的电脑选择其中一个打开,并运行其中的 activemq.bat 即可启动 ActiveMQ。

消息生产者生产消息发布到 Queue 中,消息消费者从 Queue 中取出,并且消费消息。这里需要注意,消息被消费者消费以后,Queue 中不再对其存储,所以消息消费者不会再消费到已被消费的消息。Queue 支持多个消息消费者,但对一个消息而言,只会有一个消费者消费,这也就是我们所说的点对点形式的消息通讯。

启动完成后,在浏览器中输入:http://127.0.0.1:8161/admin/,访问 ActiveMQ 服务器,用户名和密码均是 admin。如下:

activemq

我们可以看到有 Queues 和 Topics 两个选项,这两个选项分别是点对点消息和发布/订阅消息的查看窗口。上面介绍了点对点消息通讯,那什么是发布/订阅消息消息通讯呢?

发布/订阅消息,即消息生产者(发布)将消息发布到 Topic 中,同时有多个消息消费者(订阅)消费该消息。和点对点方式不同,发布到 Topic 的消息会被所有订阅者消费。下文会分析两者的具体实现方式。

ActiveMQ 集成

依赖导入和配置

在 Spring Boot 中集成 ActiveMQ 需要导入如下 starter 依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-activemq</artifactId>
</dependency>

然后在 application.yml 配置文件中,对 ActiveMQ 做下配置:

spring:
  activemq:
      # activemq url
    broker-url: tcp://localhost:61616
    in-memory: true
    pool:
      # 如果此处设置为true,需要添加activemq-pool的依赖包,否则会自动配置失败,无法注入JmsMessagingTemplate
      enabled: false

Queue 和 Topic 的创建

首先需要创建两种消息 Queue 和 Topic,我们放到 ActiveMqConfig 中创建,如下:

/**
 * activemq的配置
 * @author  shengwu ni
 */
@Configuration
public class ActiveMqConfig {
    /**
     * 发布/订阅模式队列名称
     */
    public static final String TOPIC_NAME = "activemq.topic";
    /**
     * 点对点模式队列名称
     */
    public static final String QUEUE_NAME = "activemq.queue";

    @Bean
    public Destination topic() {
        return new ActiveMQTopic(TOPIC_NAME);
    }

    @Bean
    public Destination queue() {
        return new ActiveMQQueue(QUEUE_NAME);
    }
}

可以看出 Queue 和 Topic 两种消息,分别使用 new ActiveMQQueuenew ActiveMQTopic 来创建,后面的参数写上对应的消息名称即可。这样,在其他地方就可以直接将这两种消息作为组件注入进来。

消息的发送接口

在 Spring Boot 中,我们只要注入 JmsMessagingTemplate 模板即可快速发送消息,如下:

/**
 * 消息发送者
 * @author shengwu ni
 */
@Service
public class MsgProducer {

    @Resource
    private JmsMessagingTemplate jmsMessagingTemplate;

    public void sendMessage(Destination destination, String msg) {
        jmsMessagingTemplate.convertAndSend(destination, msg);
    }
}

convertAndSend 方法中第一个参数是消息发送的目的地,第二个参数是具体的消息内容。

点对点消息生产与消费

点对点消息的生产

消息的生产,我们放到 Controller 中来做,由于上面已经生成了 Queue 消息的组件,所以在 Controller 中我们直接注入进来即可。之后调用上文的消息发送方法 sendMessage 即可成功生产一条消息。

/**
 * ActiveMQ controller
 * @author shengwu ni
 */
@RestController
@RequestMapping("/activemq")
public class ActiveMqController {

    private static final Logger logger = LoggerFactory.getLogger(ActiveMqController.class);

    @Resource
    private MsgProducer producer;
    @Resource
    private Destination queue;

    @GetMapping("/send/queue")
    public String sendQueueMessage() {

        logger.info("===开始发送点对点消息===");
        producer.sendMessage(queue, "Queue: hello activemq!");
        return "success";
    }
}
点对点消息的消费

点对点消息的消费很简单,只要我们指定目的地即可,JMS 监听器一直在监听是否有消息过来,如果有,则消费。

/**
 * 消息消费者
 * @author shengwu ni
 */
@Service
public class QueueConsumer {

    /**
     * 接收点对点消息
     * @param msg
     */
    @JmsListener(destination = ActiveMqConfig.QUEUE_NAME)
    public void receiveQueueMsg(String msg) {
        System.out.println("收到的消息为:" + msg);
    }
}

可以看出,使用 @JmsListener 注解来指定要监听的目的地,在消息接收方法内部,我们可以根据具体的业务需求做相应的逻辑处理。

测试一下

启动项目,在浏览器中输入:http://localhost:8081/activemq/send/queue,观察控制台的输出日志,出现下面的日志说明消息发送和消费成功。

收到的消息为:Queue: hello activemq!

发布/订阅消息的生产和消费

发布/订阅消息的生产

和点对点消息一样,我们注入 Topic 并调用 producer 的 sendMessage 方法即可发送订阅消息,如下,不再赘述:

@RestController
@RequestMapping("/activemq")
public class ActiveMqController {

    private static final Logger logger = LoggerFactory.getLogger(ActiveMqController.class);

    @Resource
    private MsgProducer producer;
    @Resource
    private Destination topic;

    @GetMapping("/send/topic")
    public String sendTopicMessage() {

        logger.info("===开始发送订阅消息===");
        producer.sendMessage(topic, "Topic: hello activemq!");
        return "success";
    }
}
发布/订阅消息的消费

发布/订阅消息的消费和点对点不同,订阅消息支持多个消费者一起消费。其次,Spring Boot 中默认的是点对点消息,所以在使用 Topic 时,会不起作用,我们需要在配置文件 application.yml 中添加一个配置:

spring:
  jms:
    pub-sub-domain: true

该配置是 false 的话,则为点对点消息,也是 Spring Boot 默认的。这样确实可以解决问题,但这样配置的话,上面提到的点对点消息又不能正常消费了。二者不可兼得,所以这并非一个好的解决办法。

我们来看一个比较好的解决办法。定义一个工厂,@JmsListener 注解默认只接收 Queue 消息,如果要接收 Topic 消息,需要设置一下 containerFactory。我们还在上面那个 ActiveMqConfig 配置类中添加:

/**
 * activemq的配置
 *
 * @author shengwu ni
 */
@Configuration
public class ActiveMqConfig {
    // 省略其他内容

    /**
     * JmsListener注解默认只接收queue消息,如果要接收topic消息,需要设置containerFactory
     */
    @Bean
    public JmsListenerContainerFactory topicListenerContainer(ConnectionFactory connectionFactory) {
        DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();
        factory.setConnectionFactory(connectionFactory);
        // 相当于在application.yml中配置:spring.jms.pub-sub-domain=true
        factory.setPubSubDomain(true);
        return factory;
    }
}

经过这样的配置之后,在 @JmsListener 注解中指定这个容器工厂即可消费 Topic 消息。如下:

/**
 * Topic消息消费者
 * @author shengwu ni
 */
@Service
public class TopicConsumer1 {

    /**
     * 接收订阅消息
     * @param msg
     */
    @JmsListener(destination = ActiveMqConfig.TOPIC_NAME, containerFactory = "topicListenerContainer")
    public void receiveTopicMsg(String msg) {
        System.out.println("收到的消息为:" + msg);
    }

}

指定 containerFactory 属性为上面我们自己配置的 topicListenerContainer 即可。Topic 消息可以被多次消费,该消费的类我们可以拷贝多个来测试一下,这里我就不贴代码了,可以参考我的源码测试。

测试一下

启动项目,在浏览器中输入:http://localhost:8081/activemq/send/topic,观察控制台的输出日志,出现下面的日志说明消息发送和消费成功。

收到的消息为:Topic: hello activemq!
收到的消息为:Topic: hello activemq!

总结

本文主要介绍了 JMS 和 ActiveMQ 的相关概念及安装与启动,并详细分析了 Spring Boot 中点对点消息和发布/订阅消息两种方式的配置、消息生产和消费方式。ActiveMQ 是能力强劲的开源消息总线,在异步消息的处理上很有用,希望大家好好消化一下。

课程源代码下载地址:

戳我下载

上一篇
下一篇
目录