不知你是否有过这样的体验:
在调试带JMS组件的应用时, 需要额外启动一个JMS服务器来配合测试。
这样既操作繁琐,又不利于实现单元测试——不符合单元测试AIR原则(自动化,独立性,可重复,请参考《阿里巴巴Java开发手册》中的“单元测试”章节)。
有时侯,我们需要一个随应用启动的JMS服务器,今天我们就来讲一下,如何在SpringBoot应用中内嵌一个ActiveMQ JMS Broker。
让我们开始吧
首先说明所有的文档来源,供各位深入研究。
本文所涉及的文档均来源于各组件的官方网站中。这里列举如下。
如何编写ActiveMQ Embedded broker
ActiveMQ XML配置指南
SpringBoot官方文档
示例代码则请参考我的github目录EmbbededActiveMQ。
第一步:准备配置文件activemq.xml
activemq.xml是ActiveMQ的主要配置文件,可以通过其指定ActiveMQ的行为。
可以在ActiveMQ安装目录下的conf文件夹下找到默认的activemq.xml文件。在其基础上修改。
这里我们采用最小配置。
<broker xmlns="http://activemq.apache.org/schema/core" brokerName="mybroker" useJmx="true">
<persistenceAdapter>
<kahaDB directory="./kahadb"/>
</persistenceAdapter>
<transportConnectors>
<transportConnector name="openwire" uri="tcp://0.0.0.0:61616"/>
</transportConnectors>
</broker>
更多具体的配置项请参考ActiveMQ XML配置指南
第二步:添加依赖
编写maven项目的pom文件。添加一些必要的依赖。
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-activemq</artifactId>
</dependency>
<dependency>
<groupId>org.apache.activemq</groupId>
<artifactId>activemq-spring</artifactId>
<version>5.12.3</version>
</dependency>
<dependency>
<groupId>org.apache.activemq</groupId>
<artifactId>activemq-kahadb-store</artifactId>
<version>5.12.3</version>
</dependency>
</dependencies>
spring-boot-starter-activemq:由SpringBoot官方提供,这里要用来编写收发消息的代码。
activemq-spring :为ActiveMQ嵌入Spring应用提供支持。
activemq-kahadb-store :为ActiveMQ中配置队列持久化提供必要的依赖。
如果在activemq.xml中配置了其它功能,可能需要额外的依赖。可以根据应用启动时的 ClassNotFoundException 报错提示信息自行添加。
第三步:编写测试代码
添加ActiveMQ加载的代码。
@Bean
public BrokerFactoryBean activemq() throws Exception {
BrokerFactoryBean broker = new BrokerFactoryBean();
broker.setConfig(new ClassPathResource("activemq.xml"));
broker.setStart(true);
return broker;
}
添加一个生产者和两个消费者。
// 生产者,启动应用后自动发送10条消息
@Bean
public CommandLineRunner testSend() {
return new CommandLineRunner() {
@Override
public void run(String... args) throws Exception {
for (int i = 0; i < 10; ++i) {
jmsTemplate.convertAndSend("test", "message");
}
}
};
}
// 消费者1
@JmsListener(destination = "test")
public void receive1(String message) {
System.out.println("One Receive: " + message);
}
// 消费者2
@JmsListener(destination = "test")
public void receive2(String message) {
System.out.println("Two Receive: " + message);
}
再添加上SpringBoot应用的application.yml配置。
spring:
activemq:
broker-url:
tcp://localhost:61616
第四步: 运行并查看结果
启动应用,查看日志。
可见两个消费者各收到一半的消息,说明收发消息功能己经成功。
由于打开了JMX功能,使用JvisualVM连上应用,可以从MBean中找到自己定义的broker,并观察其执行状态。
可以看到test队列共入队并出队10条消息。
小功告成。