Spring认证指南-了解如何使用 JMS 代理发布和订阅消息

原标题：Spring认证指南-了解如何使用 JMS 代理发布和订阅消息

使用 JMS 进行消息传递

本指南将引导您完成使用 JMS 代理发布和订阅消息的过程。

你将建造什么

您将构建一个应用程序，该应用程序使用 SpringJmsTemplate发布单个消息并@JmsListener使用托管 bean 的注释方法订阅它。

你需要什么

• 约15分钟
• 最喜欢的文本编辑器或 IDE
• JDK 1.8或更高版本
• Gradle 4+或Maven 3.2+
• 您还可以将代码直接导入 IDE：
  • 弹簧工具套件 (STS)
  • IntelliJ IDEA

如何完成本指南

像大多数 Spring入门指南一样，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。无论哪种方式，您最终都会得到工作代码。

要从头开始，请继续[scratch]。

要跳过基础知识，请执行以下操作：

• 下载并解压本指南的源代码库，或使用Git克隆它：git clone https://github.com/spring-guides/gs-messaging-jms.git
• 光盘进入gs-messaging-jms/initial
• 跳转到从 Spring Initializr 开始。

完成后，您可以对照中的代码检查结果gs-messaging-jms/complete。

从 Spring Initializr 开始

您可以使用这个预先初始化的项目并单击 Generate 下载 ZIP 文件。此项目配置为适合本教程中的示例。

手动初始化项目：

1. 导航到https://start.spring.io。该服务提取应用程序所需的所有依赖项，并为您完成大部分设置。
2. 选择 Gradle 或 Maven 以及您要使用的语言。本指南假定您选择了 Java。
3. 单击Dependencies并选择Spring for Apache ActiveMQ 5。
4. 单击生成。
5. 下载生成的 ZIP 文件，该文件是根据您的选择配置的 Web 应用程序的存档。

如果您的 IDE 具有 Spring Initializr 集成，您可以从您的 IDE 完成此过程。

你也可以从 Github 上 fork 项目并在你的 IDE 或其他编辑器中打开它。

创建消息接收器

Spring 提供了将消息发布到任何 POJO（Plain Old Java Object）的方法。

本指南介绍如何通过 JMS 消息代理发送消息。首先，创建一个包含电子邮件详细信息的简单 POJO。请注意，我们不会发送电子邮件。我们将有关要发送什么信息的详细信息从一个地方发送到另一个地方。

src/main/java/hello/Email.java

package hello;

public class Email {

private String to;

private String body;

public Email() {

}

public Email(String to, String body) {

this.to = to;

this.body = body;

}

public String getTo() {

return to;

}

public void setTo(String to) {

this.to = to;

}

public String getBody() {

return body;

}

public void setBody(String body) {

this.body = body;

}

@Override

public String toString() {

return String.format("Email{to=%s, body=%s}", getTo(), getBody());

}

}

这个 POJO 非常简单，包含两个字段（to和body），以及假定的 getter 和 setter 集。

从这里，您可以定义一个消息接收器：

src/main/java/hello/Receiver.java

package hello;

import org.springframework.jms.annotation.JmsListener;

import org.springframework.stereotype.Component;

@Component

public class Receiver {

@JmsListener(destination = "mailbox", containerFactory = "myFactory")

public void receiveMessage(Email email) {

System.out.println("Received <" + email + ">");

}

}

Receiver也称为消息驱动的 POJO。如代码所示，无需实现任何特定接口或方法具有任何特定名称。此外，该方法可以具有灵活的签名。请特别注意，该类没有 JMS API 的导入。

JmsListener注释定义了Destination此方法应侦听的名称以及对用于创建底层消息侦听器容器的引用 JmsListenerContainerFactory。严格来说，除非您需要自定义构建容器的方式，否则最后一个属性不是必需的，因为 Spring Boot 会在必要时注册一个默认工厂。

参考文档对此进行了更详细的介绍。

使用 Spring 发送和接收 JMS 消息

接下来，连接发送器和接收器。

src/main/java/hello/Application.java

package hello;

import javax.jms.ConnectionFactory;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

import org.springframework.boot.autoconfigure.jms.DefaultJmsListenerContainerFactoryConfigurer;

import org.springframework.context.ConfigurableApplicationContext;

import org.springframework.context.annotation.Bean;

import org.springframework.jms.annotation.EnableJms;

import org.springframework.jms.config.DefaultJmsListenerContainerFactory;

import org.springframework.jms.config.JmsListenerContainerFactory;

import org.springframework.jms.core.JmsTemplate;

import org.springframework.jms.support.converter.MappingJackson2MessageConverter;

import org.springframework.jms.support.converter.MessageConverter;

import org.springframework.jms.support.converter.MessageType;

@SpringBootApplication

@EnableJms

public class Application {

@Bean

public JmsListenerContainerFactory<?> myFactory(ConnectionFactory connectionFactory,

DefaultJmsListenerContainerFactoryConfigurer configurer) {

DefaultJmsListenerContainerFactory factory = new DefaultJmsListenerContainerFactory();

// This provides all boot's default to this factory, including the message converter

configurer.configure(factory, connectionFactory);

// You could still override some of Boot's default if necessary.

return factory;

}

@Bean // Serialize message content to json using TextMessage

public MessageConverter jacksonJmsMessageConverter() {

MappingJackson2MessageConverter converter = new MappingJackson2MessageConverter();

converter.setTargetType(MessageType.TEXT);

converter.setTypeIdPropertyName("_type");

return converter;

}

public static void main(String[] args) {

// Launch the application

ConfigurableApplicationContext context = SpringApplication.run(Application.class, args);

JmsTemplate jmsTemplate = context.getBean(JmsTemplate.class);

// Send a message with a POJO - the template reuse the message converter

System.out.println("Sending an email message.");

jmsTemplate.convertAndSend("mailbox", new Email("info@example.com", "Hello"));

}

}

@SpringBootApplication是一个方便的注释，它添加了以下所有内容：

• @Configuration: 将类标记为应用程序上下文的 bean 定义源。
• @EnableAutoConfiguration：告诉 Spring Boot 根据类路径设置、其他 bean 和各种属性设置开始添加 bean。例如，如果spring-webmvc位于类路径上，则此注释将应用程序标记为 Web 应用程序并激活关键行为，例如设置DispatcherServlet.
• @ComponentScan: 告诉 Spring 在包中查找其他组件、配置和服务hello，让它找到控制器。

该main()方法使用 Spring Boot 的SpringApplication.run()方法来启动应用程序。您是否注意到没有一行 XML？也没有web.xml文件。这个 Web 应用程序是 100% 纯 Java，您不必处理任何管道或基础设施的配置。

@EnableJms触发发现用 注释的方法@JmsListener，在幕后创建消息侦听器容器。

为了清楚起见，我们还定义了一个在接收器的注释中myFactory引用的 bean 。JmsListener因为我们使用的 DefaultJmsListenerContainerFactoryConfigurer是 Spring Boot 提供的基础设施，这 JmsMessageListenerContainer与 Boot 默认创建的基础设施相同。

默认MessageConverter只能转换基本类型（如String, Map, Serializable），我们Email不是Serializable故意的。我们想使用 Jackson 并将内容序列化为文本格式的 JSON（即作为 a TextMessage）。Spring Boot 检测到 a 的存在MessageConverter并将其与默认值JmsTemplate和任何 JmsListenerContainerFactory由 DefaultJmsListenerContainerFactoryConfigurer​.

JmsTemplate使将消息发送到 JMS 目标变得简单。在mainrunner 方法中，启动后，您可以使用jmsTemplate发送一个EmailPOJO。因为我们的自定义MessageConverter已经自动关联到它，所以TextMessage只生成了一个 JSON 文档。

您没有看到定义的两个 bean 是JmsTemplate和ConnectionFactory。这些是由 Spring Boot 自动创建的。在这种情况下，ActiveMQ 代理嵌入运行。

默认情况下，Spring Boot通过JmsTemplate设置为. 也以相同的方式配置。要覆盖，请通过 Boot 的属性设置（在内部或通过设置环境变量）进行设置。然后确保接收容器具有相同的设置。 pubSubDomainfalseJmsMessageListenerContainerspring.jms.isPubSubDomain=trueapplication.properties

SpringJmsTemplate可以通过它的方法直接接收消息receive，但这只能同步工作，这意味着它会阻塞。这就是为什么我们建议您使用侦听器容器，例如 DefaultMessageListenerContainer基于缓存的连接工厂，这样您就可以异步使用消息并以最大的连接效率。

构建一个可执行的 JAR

您可以使用 Gradle 或 Maven 从命令行运行应用程序。您还可以构建一个包含所有必要依赖项、类和资源的单个可执行 JAR 文件并运行它。构建可执行 jar 可以在整个开发生命周期、跨不同环境等中轻松地作为应用程序交付、版本化和部署服务。

如果您使用 Gradle，则可以使用./gradlew bootRun. 或者，您可以使用构建 JAR 文件./gradlew build，然后运行 ​​JAR 文件，如下所示：

java -jar build/libs/gs-messaging-jms-0.1.0.jar

如果您使用 Maven，则可以使用./mvnw spring-boot:run. 或者，您可以使用构建 JAR 文件，./mvnw clean package然后运行该 JAR 文件，如下所示：

java -jar 目标/gs-messaging-jms-0.1.0.jar

此处描述的步骤创建了一个可运行的 JAR。您还可以构建经典的 WAR 文件。

当它运行时，隐藏在所有日志记录中，您应该会看到以下消息：

发送电子邮件。
收到 <Email{ to=info@example.com , body=Hello}>

概括

恭喜！您已经开发了基于 JMS 的消息的发布者和使用者。