# 使用RabbitMQ进行消息传递
本指南将引导您完成设置RabbitMQ AMQP服务器以发布和订阅消息的过程，并创建一个Spring Boot应用程序与该RabbitMQ服务器进行交互的过程。
## 你会建立什么
您将使用Spring AMQP构建一个发布消息的应用程序 `RabbitTemplate` 并通过使用以下命令订阅POJO上的消息 `MessageListenerAdapter`.
## 你需要什么
* 约15分钟
* 最喜欢的文本编辑器或IDE
* [JDK 11](http://www.oracle.com/technetwork/java/javase/downloads/index.html) 或更高版本
* [Gradle 4+](http://www.gradle.org/downloads) 或 [Maven 3.2+](https://maven.apache.org/download.cgi)
* 您还可以将代码直接导入到IDE中：
* [弹簧工具套件（STS）](https://spring.io/guides/gs/sts)
* [IntelliJ IDEA](https://spring.io/guides/gs/intellij-idea/)
* 设置RabbitMQ服务器。 请参阅 [设置RabbitMQ Broker](https://spring.io/guides/gs/messaging-rabbitmq/#scratch) 。
## 如何完成本指南
像大多数Spring 一样 [入门指南](https://spring.io/guides) ，您可以从头开始并完成每个步骤，也可以绕过您已经熟悉的基本设置步骤。 无论哪种方式，您最终都可以使用代码。
要 **从头开始** ，请继续 [设置RabbitMQ Broker](https://spring.io/guides/gs/messaging-rabbitmq/#scratch) 。
要 **跳过基础知识** ，请执行以下操作：
* [下载](https://github.com/spring-guides/gs-messaging-rabbitmq/archive/master.zip) 并解压缩本指南的源存储库，或使用 对其进行克隆 [Git](https://spring.io/understanding/Git) ： `git clone [https://github.com/spring-guides/gs-messaging-rabbitmq.git](https://github.com/spring-guides/gs-messaging-rabbitmq.git)`
* 光盘进入 `gs-messaging-rabbitmq/initial`
* 跳到 [从Spring Initializr开始](https://spring.io/guides/gs/messaging-rabbitmq/#initial) 。
**完成后** ，您可以根据中的代码检查结果 `gs-messaging-rabbitmq/complete`.
## 设置RabbitMQ经纪人
在构建消息传递应用程序之前，需要设置服务器以处理接收和发送消息。
RabbitMQ是AMQP服务器。 该服务器可从 免费获得 [https://www.rabbitmq.com/download.html](https://www.rabbitmq.com/download.html) 。 您可以手动下载它，或者，如果您将Mac与Homebrew一起使用，则可以在终端窗口中运行以下命令来下载它：
~~~
brew install rabbitmq
~~~
通过在终端窗口中运行以下命令来打开服务器包装并使用默认设置启动它：
~~~
rabbitmq-server
~~~
您应该看到类似于以下内容的输出：
~~~
RabbitMQ 3.1.3. Copyright (C) 2007-2013 VMware, Inc.
## ## Licensed under the MPL. See https://www.rabbitmq.com/
## ##
########## Logs: /usr/local/var/log/rabbitmq/rabbit@localhost.log
###### ## /usr/local/var/log/rabbitmq/rabbit@localhost-sasl.log
##########
Starting broker... completed with 6 plugins.
~~~
也可以使用 [Docker， Docker Compose](https://docs.docker.com/compose/) 如果您在本地运行 快速启动RabbitMQ服务器。 有一个 `docker-compose.yml` 在 `complete`Github中的项目。 这很简单，如下面的清单所示：
~~~
rabbitmq:
image: rabbitmq:management
ports:
- "5672:5672"
- "15672:15672"
~~~
使用此文件在当前目录中，您可以运行 `docker-compose up` 使RabbitMQ在容器中运行。
## 从Spring Initializr开始
如果您使用Maven，请访问 [Spring Initializr](https://start.spring.io/#!type=maven-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=messaging-rabbitmq&name=messaging-rabbitmq&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.messaging-rabbitmq&dependencies=amqp) 以生成具有所需依赖项的新项目（Spring for RabbitMQ）。
以下清单显示了 `pom.xml` 选择Maven时创建的文件：
~~~
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.4.3</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.example</groupId>
<artifactId>messaging-rabbitmq</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>messaging-rabbitmq</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-amqp</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.springframework.amqp</groupId>
<artifactId>spring-rabbit-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
~~~
如果您使用Gradle，请访问 [Spring Initializr](https://start.spring.io/#!type=gradle-project&language=java&platformVersion=2.4.3.RELEASE&packaging=jar&jvmVersion=1.8&groupId=com.example&artifactId=messaging-rabbitmq&name=messaging-rabbitmq&description=Demo%20project%20for%20Spring%20Boot&packageName=com.example.messaging-rabbitmq&dependencies=amqp) 以生成具有所需依赖项的新项目（Spring for RabbitMQ）。
以下清单显示了 `build.gradle` 选择Gradle时创建的文件：
~~~
plugins {
id 'org.springframework.boot' version '2.4.3'
id 'io.spring.dependency-management' version '1.0.11.RELEASE'
id 'java'
}
group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '1.8'
repositories {
mavenCentral()
}
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-amqp'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testImplementation 'org.springframework.amqp:spring-rabbit-test'
}
test {
useJUnitPlatform()
}
~~~
### 手动初始化（可选）
如果要手动初始化项目而不是使用前面显示的链接，请按照以下步骤操作：
1. 导航到 [https://start.spring.io](https://start.spring.io) 。 该服务提取应用程序所需的所有依赖关系，并为您完成大部分设置。
2. 选择Gradle或Maven以及您要使用的语言。 本指南假定您选择了Java。
3. 单击 **Dependencies** 并 选择 **为RabbitMQ Spring** 。
4. 点击 **生成** 。
5. 下载生成的ZIP文件，该文件是使用您的选择配置的Web应用程序的存档。
如果您的IDE集成了Spring Initializr，则可以从IDE中完成此过程。
## 创建RabbitMQ消息接收器
对于任何基于消息传递的应用程序，您需要创建一个响应已发布消息的接收器。 以下清单（来自 `src/main/java/com.example.messagingrabbitmq/Receiver.java`）显示了如何执行此操作：
~~~
package com.example.messagingrabbitmq;
import java.util.concurrent.CountDownLatch;
import org.springframework.stereotype.Component;
@Component
public class Receiver {
private CountDownLatch latch = new CountDownLatch(1);
public void receiveMessage(String message) {
System.out.println("Received <" + message + ">");
latch.countDown();
}
public CountDownLatch getLatch() {
return latch;
}
}
~~~
这 `Receiver`是一个POJO，它定义了一种接收消息的方法。 注册它以接收消息时，可以随意命名。
为方便起见，此POJO还具有一个 CountDownLatch。 这使其发出已接收到该消息的信号。 这是您不太可能在生产应用程序中实现的东西。
## 注册侦听器并发送消息
春季AMQP `RabbitTemplate`提供使用RabbitMQ发送和接收消息所需的一切。 但是，您需要：
* 配置消息侦听器容器。
* 声明队列，交换以及它们之间的绑定。
* 配置组件以发送一些消息以测试侦听器。
Spring Boot自动创建一个连接工厂和一个RabbitTemplate，从而减少了您必须编写的代码量。
您将使用 `RabbitTemplate` 发送消息，您将注册一个 `Receiver`与消息侦听器容器一起接收消息。 连接工厂既驱动这两个驱动器，又使它们连接到RabbitMQ服务器。 以下清单（来自 `src/main/java/com.example.messagingrabbitmq/MessagingRabbitApplication.java`）展示了如何创建应用程序类：
~~~
package com.example.messagingrabbitmq;
import org.springframework.amqp.core.Binding;
import org.springframework.amqp.core.BindingBuilder;
import org.springframework.amqp.core.Queue;
import org.springframework.amqp.core.TopicExchange;
import org.springframework.amqp.rabbit.connection.ConnectionFactory;
import org.springframework.amqp.rabbit.listener.SimpleMessageListenerContainer;
import org.springframework.amqp.rabbit.listener.adapter.MessageListenerAdapter;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
@SpringBootApplication
public class MessagingRabbitmqApplication {
static final String topicExchangeName = "spring-boot-exchange";
static final String queueName = "spring-boot";
@Bean
Queue queue() {
return new Queue(queueName, false);
}
@Bean
TopicExchange exchange() {
return new TopicExchange(topicExchangeName);
}
@Bean
Binding binding(Queue queue, TopicExchange exchange) {
return BindingBuilder.bind(queue).to(exchange).with("foo.bar.#");
}
@Bean
SimpleMessageListenerContainer container(ConnectionFactory connectionFactory,
MessageListenerAdapter listenerAdapter) {
SimpleMessageListenerContainer container = new SimpleMessageListenerContainer();
container.setConnectionFactory(connectionFactory);
container.setQueueNames(queueName);
container.setMessageListener(listenerAdapter);
return container;
}
@Bean
MessageListenerAdapter listenerAdapter(Receiver receiver) {
return new MessageListenerAdapter(receiver, "receiveMessage");
}
public static void main(String[] args) throws InterruptedException {
SpringApplication.run(MessagingRabbitmqApplication.class, args).close();
}
}
~~~
`@SpringBootApplication` 是一个方便注释，它添加了以下所有内容：
* `@Configuration`：将类标记为应用程序上下文的Bean定义的源。
* `@EnableAutoConfiguration`：告诉Spring Boot根据类路径设置，其他bean和各种属性设置开始添加bean。 例如，如果 `spring-webmvc` 在类路径上，此注释将应用程序标记为Web应用程序并激活关键行为，例如设置 `DispatcherServlet`.
* `@ComponentScan`：告诉Spring在服务器中寻找其他组件，配置和服务 `com/example` 包，让它找到控制器。
这 `main()` 方法使用Spring Boot的 `SpringApplication.run()`启动应用程序的方法。 您是否注意到没有一行XML？ 没有 `web.xml`文件。 该Web应用程序是100％纯Java，因此您无需处理任何管道或基础结构。
在中定义的bean `listenerAdapter()` 方法被注册为容器中的消息侦听器（在 `container()`）。 它在 `spring-boot`队列。 因为 `Receiver` 类是一个POJO，需要包装在 `MessageListenerAdapter`，在其中指定它调用的位置 `receiveMessage`.
JMS队列和AMQP队列具有不同的语义。 例如，JMS仅将排队的消息发送给一个使用者。 尽管AMQP队列执行相同的操作，但AMQP生产者不会将消息直接发送到队列。 而是将消息发送到交换机，该交换机可以转到单个队列，也可以扇出到多个队列，以模拟JMS主题的概念。
消息侦听器容器和接收者Bean就是您侦听消息所需的全部。 要发送消息，您还需要一个Rabbit模板。
这 `queue()`方法创建一个AMQP队列。 这 `exchange()`方法创建主题交流。 这 `binding()` 方法将这两者绑定在一起，定义了在以下情况下发生的行为 `RabbitTemplate` 发布到交易所。
Spring AMQP要求 Queue， 这 TopicExchange和 Binding 被声明为顶级Spring Bean，以便正确设置。
在这种情况下，我们使用主题交换，并且队列与路由键绑定 `foo.bar.#`，这意味着任何以以下开头的路由键发送的邮件 `foo.bar.` 被路由到队列。
## 发送测试信息
在此示例中，测试消息是通过以下方式发送的： `CommandLineRunner`，它也等待接收器中的闩锁并关闭应用程序上下文。 以下清单（来自 `src/main/java/com.example.messagingrabbitmq/Runner.java`）显示其工作原理：
~~~
package com.example.messagingrabbitmq;
import java.util.concurrent.TimeUnit;
import org.springframework.amqp.rabbit.core.RabbitTemplate;
import org.springframework.boot.CommandLineRunner;
import org.springframework.stereotype.Component;
@Component
public class Runner implements CommandLineRunner {
private final RabbitTemplate rabbitTemplate;
private final Receiver receiver;
public Runner(Receiver receiver, RabbitTemplate rabbitTemplate) {
this.receiver = receiver;
this.rabbitTemplate = rabbitTemplate;
}
@Override
public void run(String... args) throws Exception {
System.out.println("Sending message...");
rabbitTemplate.convertAndSend(MessagingRabbitmqApplication.topicExchangeName, "foo.bar.baz", "Hello from RabbitMQ!");
receiver.getLatch().await(10000, TimeUnit.MILLISECONDS);
}
}
~~~
请注意，该模板使用以下路由键将消息路由到交换机 `foo.bar.baz`，它与绑定匹配。
在测试中，您可以模拟运行器，以便可以单独测试接收器。
## 运行应用程序
这 `main()`方法通过创建Spring应用程序上下文来启动该过程。 这将启动消息侦听器容器，该容器开始侦听消息。 有一个 `Runner`bean，然后自动运行。 它检索 `RabbitTemplate` 从应用程序上下文中发送一个 `Hello from RabbitMQ!` 上的讯息 `spring-boot`队列。 最后，它关闭Spring应用程序上下文，然后应用程序结束。
## 建立可执行的JAR
您可以使用Gradle或Maven从命令行运行该应用程序。 您还可以构建一个包含所有必需的依赖项，类和资源的可执行JAR文件，然后运行该文件。 生成可执行jar使得在整个开发生命周期中，跨不同环境等等的情况下，都可以轻松地将服务作为应用程序进行发布，版本控制和部署。
如果您使用Gradle，则可以通过使用以下命令运行该应用程序 `./gradlew bootRun`。 或者，您可以通过使用以下命令构建JAR文件： `./gradlew build` 然后运行JAR文件，如下所示：
~~~
java -jar build/libs/gs-messaging-rabbitmq-0.1.0.jar
~~~
如果您使用Maven，则可以通过使用以下命令运行该应用程序 `./mvnw spring-boot:run`。 或者，您可以使用以下命令构建JAR文件： `./mvnw clean package` 然后运行JAR文件，如下所示：
~~~
java -jar target/gs-messaging-rabbitmq-0.1.0.jar
~~~
此处描述的步骤将创建可运行的JAR。 您还可以 构建经典的WAR文件 。
您应该看到以下输出：
~~~
Sending message...
Received <Hello from RabbitMQ!>
~~~
## 概括
恭喜你！ 您刚刚使用Spring和RabbitMQ开发了一个简单的发布和订阅应用程序。 使用 可以做的事情 [Spring和RabbitMQ](https://docs.spring.io/spring-amqp/reference/#_introduction) 比这里介绍的要多，但是本指南应该为您提供一个良好的开端。
- springboot概述
- springboot构建restful服务
- spring构建一个RESTful Web服务
- spring定时任务
- 消费RESTful Web服务
- gradle构建项目
- maven构建项目
- springboot使用jdbc
- springboot应用上传文件
- 使用LDNA验证用户
- 使用 spring data redis
- 使用 spring RabbitTemplate消息队列
- 用no4j访问nosql数据库
- springboot验证web表单
- Spring Boot Actuator构j建服务
- 使用jms传递消息
- springboot创建批处理服务
- spring security保护web 安全
- 在Pivotal GemFire中访问数据
- 使用Spring Integration
- 使用springboot jpa进行数据库操作
- 数据库事务操作
- 操作mongodb
- springmvc+tymleaf创建web应用
- 将Spring Boot JAR应用程序转换为WAR
- 创建异步服务
- spring提交表单
- 使用WebSocket构建交互式Web应用程序
- 使用REST访问Neo4j数据
- jquery消费restful
- springboot跨域请求
- 消费SOAP Web服务
- springboot使用缓存
- 使用Vaadin创建CRUD UI
- 使用REST访问JPA数据
- 使用REST访问Pivotal GemFire中的数据
- 构建soap服务
- 使用rest访问mongodb数据
- 构建springboot应用docker镜像
- 从STS部署到Cloud Foundry
- springboot测试web应用
- springboot访问mysql
- springboot编写自定义模块并使用
- 使用Google Cloud Pub / Sub进行消息传递
- 构建反应式RESTful Web服务
- 使用Redis主动访问数据
- Spring Boot 部署到Kubernetes
- 使用反应式协议R2DBC访问数据
- Spring Security架构
- spring构建Docker镜像详解
- Spring Boot和OAuth2
- springboot应用部署到k8s
- spring构建rest服务详解