Spring Boot中使用RabbitMQ的示例代码

很久没有写spring boot的内容了，正好最近在写spring cloud bus的内容，因为内容会有一些相关性，所以先补一篇关于amqp的整合。

message broker与amqp简介

message broker是一种消息验证、传输、路由的架构模式，其设计目标主要应用于下面这些场景：

1. 消息路由到一个或多个目的地
2. 消息转化为其他的表现方式
3. 执行消息的聚集、消息的分解，并将结果发送到他们的目的地，然后重新组合相应返回给消息用户
4. 调用web服务来检索数据
5. 响应事件或错误
6. 使用发布-订阅模式来提供内容或基于主题的消息路由

amqp是advanced message queuing protocol的简称，它是一个面向消息中间件的开放式标准应用层协议。amqp定义了这些特性：

1. 消息方向
2. 消息队列
3. 消息路由（包括：点到点和发布-订阅模式）
4. 可靠性
5. 安全性

rabbitmq

本文要介绍的rabbitmq就是以amqp协议实现的一种中间件产品，它可以支持多种操作系统，多种编程语言，几乎可以覆盖所有主流的企业级技术平台。

安装

在rabbitmq官网的下载页面中，我们可以获取到针对各种不同操作系统的安装包和说明文档。这里，我们将对几个常用的平台一一说明。

下面我们采用的erlang和rabbitmq server版本说明：

1. erlang/otp 19.1
2. rabbitmq server 3.6.5

windows安装

安装erland，通过官方下载页面获取exe安装包，直接打开并完成安装。

安装rabbitmq，通过官方下载页面获取exe安装包。

下载完成后，直接运行安装程序。

rabbitmq server安装完成之后，会自动的注册为服务，并以默认配置启动起来。

mac os x安装

在mac os x中使用brew工具，可以很容易的安装rabbitmq的服务端，只需要按如下命令操作即可：

1. brew更新到最新版本，执行：brew update
2. 安装erlang，执行：brew install erlang
3. 安装rabbitmq server，执行：brew install rabbitmq

通过上面的命令，rabbitmq server的命令会被安装到/usr/local/sbin，并不会自动加到用户的环境变量中去，所以我们需要在.bash_profile或.profile文件中增加下面内容：

path=$path:/usr/local/sbin

这样，我们就可以通过rabbitmq-server命令来启动rabbitmq的服务端了。

ubuntu安装

在ubuntu中，我们可以使用apt仓库来进行安装

安装erlang，执行：apt-get install erlang
执行下面的命令，新增apt仓库到/etc/apt/sources.list.d

echo 'deb http://www.rabbitmq.com/debian/ testing main' |
    sudo tee /etc/apt/sources.list.d/rabbitmq.list

更新apt仓库的package list，执行sudo apt-get update命令

安装rabbit server，执行sudo apt-get install rabbitmq-server命令

rabbit管理

我们可以直接通过配置文件的访问进行管理，也可以通过web的访问进行管理。下面我们将介绍如何通过web进行管理。

执行rabbitmq-plugins enable rabbitmq_management命令，开启web管理插件，这样我们就可以通过浏览器来进行管理了。

> rabbitmq-plugins enable rabbitmq_management
the following plugins have been enabled:
 mochiweb
 webmachine
 rabbitmq_web_dispatch
 amqp_client
 rabbitmq_management_agent
 rabbitmq_management

applying plugin configuration to rabbit@pc-201602152056... started 6 plugins.

打开浏览器并访问：http://localhost:15672/，并使用默认用户guest登录，密码也为guest。我们可以看到如下图的管理页面：

从图中，我们可以看到之前章节中提到的一些基本概念，比如：connections、channels、exchanges、queue等。第一次使用的读者，可以都点开看看都有些什么内容，熟悉一下rabbitmq server的服务端。

点击admin标签，在这里可以进行用户的管理。

spring boot整合

下面，我们通过在spring boot应用中整合rabbitmq，并实现一个简单的发送、接收消息的例子来对rabbitmq有一个直观的感受和理解。

在spring boot中整合rabbitmq是一件非常容易的事，因为之前我们已经介绍过starter poms，其中的amqp模块就可以很好的支持rabbitmq，下面我们就来详细说说整合过程：

新建一个spring boot工程，命名为：“rabbitmq-hello”。

在pom.xml中引入如下依赖内容，其中spring-boot-starter-amqp用于支持rabbitmq。

<parent>
  <groupid>org.springframework.boot</groupid>
  <artifactid>spring-boot-starter-parent</artifactid>
  <version>1.3.7.release</version>
  <relativepath/> <!-- lookup parent from repository -->
</parent>
<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>
</dependencies>

在application.properties中配置关于rabbitmq的连接和用户信息，用户可以回到上面的安装内容，在管理页面中创建用户。
spring.application.name=rabbitmq-hello

spring.rabbitmq.host=localhost
spring.rabbitmq.port=5672
spring.rabbitmq.username=spring
spring.rabbitmq.password=123456

创建消息生产者sender。通过注入amqptemplate接口的实例来实现消息的发送，amqptemplate接口定义了一套针对amqp协议的基础操作。在spring boot中会根据配置来注入其具体实现。在该生产者，我们会产生一个字符串，并发送到名为hello的队列中。

@component
public class sender {

  @autowired
  private amqptemplate rabbittemplate;

  public void send() {
    string context = "hello " + new date();
    system.out.println("sender : " + context);
    this.rabbittemplate.convertandsend("hello", context);
  }

}

创建消息消费者receiver。通过@rabbitlistener注解定义该类对hello队列的监听，并用@rabbithandler注解来指定对消息的处理方法。所以，该消费者实现了对hello队列的消费，消费操作为输出消息的字符串内容。

@component
@rabbitlistener(queues = "hello")
public class receiver {

  @rabbithandler
  public void process(string hello) {
    system.out.println("receiver : " + hello);
  }

}

创建rabbitmq的配置类rabbitconfig，用来配置队列、交换器、路由等高级信息。这里我们以入门为主，先以最小化的配置来定义，以完成一个基本的生产和消费过程。

@configuration
public class rabbitconfig {

  @bean
  public queue helloqueue() {
    return new queue("hello");
  }

}

创建应用主类：

@springbootapplication
public class helloapplication {

  public static void main(string[] args) {
    springapplication.run(helloapplication.class, args);
  }

}

创建单元测试类，用来调用消息生产：

@runwith(springjunit4classrunner.class)
@springapplicationconfiguration(classes = helloapplication.class)
public class helloapplicationtests {

  @autowired
  private sender sender;

  @test
  public void hello() throws exception {
    sender.send();
  }

}

完成程序编写之后，下面开始尝试运行。首先确保rabbitmq server已经开始，然后进行下面的操作：

启动应用主类，从控制台中，我们看到如下内容，程序创建了一个访问127.0.0.1:5672中springcloud的连接。

o.s.a.r.c.cachingconnectionfactory       : created new connection: simpleconnection@29836d32 [delegate=amqp://springcloud@127.0.0.1:5672/]

同时，我们通过rabbitmq的控制面板，可以看到connection和channels中包含当前连接的条目。

运行单元测试类，我们可以看到控制台中输出下面的内容，消息被发送到了rabbitmq server的hello队列中。

sender : hello sun sep 25 11:06:11 cst 2016

切换到应用主类的控制台，我们可以看到类似如下输出，消费者对hello队列的监听程序执行了，并输出了接受到的消息信息。

receiver : hello sun sep 25 11:06:11 cst 2016

通过上面的示例，我们在spring boot应用中引入spring-boot-starter-amqp模块，进行简单配置就完成了对rabbitmq的消息生产和消费的开发内容。然而在实际应用中，我们还有很多内容没有演示，这里不做更多的讲解，读者可以自行查阅rabbitmq的官方教程，有更全面的了解。

完整示例：chapter5-2-1

开源中国：http://git.oschina.net/didispace/springboot-learning/tree/master/chapter5-2-1
github：https://github.com/dyc87112/springboot-learning/tree/master/chapter5-2-1

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。