04.ActiveMQ与Spring JMS整合

SpringJMS使用参考：http://docs.spring.io/spring/docs/current/spring-framework-reference/html/jms.html

1.SpringJMS核心接口介绍

1.JmsTemplate

JmsTemplate: 是Spring自身提供，只需向Spring容器内注册这个类即可，就可以使用JmsTemplate类对象方便的操作JMS，下面介绍他常用的方法。

注意：JmsTemplate类是线程安全的，可以在整个应用范围使用。但并不是说整个引用只能使用一个JmsTemplate实例，可以根据需要注入多个JmsTemplate实例。

// send - 发送一个消息，使用消息创建接口MessageCreator
publicvoid send(MessageCreator messageCreator)
publicvoid send(finalDestination destination,finalMessageCreator messageCreator)
publicvoid send(finalString destinationName,finalMessageCreator messageCreator)
// sendAndReceive - 发送并接收消息
publicMessage sendAndReceive(MessageCreator messageCreator)
publicMessage sendAndReceive(finalDestination destination,finalMessageCreator messageCreator)
publicMessage sendAndReceive(finalString destinationName,finalMessageCreator messageCreator)
// convertAndSend - 使用MessageConverter接口转换消息，先将对象转换成消息再发送消息。与之对应的是receiveAndConvert方法
publicvoid convertAndSend(Object message)throwsJmsException
publicvoid convertAndSend(Destination destination,finalObject message)
publicvoid convertAndSend(String destinationName,finalObject message)
publicvoid convertAndSend(Object message,MessagePostProcessor postProcessor)
publicvoid convertAndSend(Destination destination,finalObject message,finalMessagePostProcessor postProcessor)
publicvoid convertAndSend(String destinationName,finalObject message,finalMessagePostProcessor postProcessor)
// receive - 接收消息
publicMessage receive()
publicMessage receive(Destination destination)
publicMessage receive(String destinationName)
// receiveSelected - 接收消息，并过滤消息
publicMessage receiveSelected(String messageSelector)
publicMessage receiveSelected(finalDestination destination,finalString messageSelector)
publicMessage receiveSelected(finalString destinationName,finalString messageSelector)
// receiveAndConvert - 接收消息，并使用MessageConverter接口转换消息，把一个消息转换成一个对象
publicObject receiveAndConvert()
publicObject receiveAndConvert(Destination destination)
publicObject receiveAndConvert(String destinationName)
// receiveSelectedAndConvert - 接收消息，并使用消息过滤和消息转换
publicObject receiveSelectedAndConvert(String messageSelector)
publicObject receiveSelectedAndConvert(Destination destination,String messageSelector)
publicObject receiveSelectedAndConvert(String destinationName,String messageSelector)
// browse - 浏览消息
public<T> T browse(BrowserCallback<T> action)
public<T> T browse(Queue queue,BrowserCallback<T> action)
public<T> T browse(String queueName,BrowserCallback<T> action)
// browseSelected - 浏览消息，并使用过滤
public<T> T browseSelected(String messageSelector,BrowserCallback<T> action)
public<T> T browseSelected(finalQueue queue,finalString messageSelector,finalBrowserCallback<T> action)
public<T> T browseSelected(finalString queueName,finalString messageSelector,finalBrowserCallback<T> action)
// execute - 执行SessionCallback、ProducerCallback、BrowserCallback回调接口，并得到回调接口返回值
public<T> T execute(SessionCallback<T> action)
public<T> T execute(SessionCallback<T> action,boolean startConnection)
public<T> T execute(ProducerCallback<T> action)
public<T> T execute(finalDestination destination,finalProducerCallback<T> action)
public<T> T execute(finalDestination destination,finalProducerCallback<T> action)

2.连接工厂(连接池)

JmsTemplate需要引用一个ConnectionFactory，JmsTemlate每次发送消息时都会重新创建连接，创建connection，session，创建productor。这是一个非常耗性能的地方，特别是大数据量的情况下。所以出现了PooledConnectionFactory，PooledConnectionFactory是ActiveMQ中的类，它实现了ConnectionFactory。而SpringJMS的实现有SingleConnectionFactory、CachingConnectionFactory。

PooledConnectionFactory：会缓存connection，session和productor，不会缓存consumer。因此只适合于生产者发送消息。
SingleConnectionFactory：对于建立JMS服务器链接的请求会一直返回同一个Connection，并且会忽略Connection的close方法调用(包括调用createConnection()得到的Connection)
CachingConnectionFactory：继承了SingleConnectionFactory，所以它拥有SingleConnectionFactory的所有功能，同时它还新增了缓存功能，它可以缓存Session、MessageProducer和MessageConsumer。

SpringJMS提供了CachingConnectionFactory，这才是首选的方案。然而CachingConnectionFactory有一个问题必须指出，默认情况下，CachingConnectionFactory只缓存一个session，在它的JavaDoc中，它声明对于低并发情况下这是足够的。与之相反，PooledConnectionFactory的默认值是500。这些设置，在很多情况下，需要亲自去测试并验证。我将其设置为100，对我来说还是很不错。

3.接口介绍

以下是SpringJMS的常用接口或类：

MessageCreator -- 消息创建接口，发送消息时需要使用此接口创建消息
SessionCallback -- 使用JMS Session时的回调接口
ProducerCallback -- 使用JMS Session和MessageProducer时的回调接口
BrowserCallback -- 使用JMS Session和QueueBrowser时的回调接口
MessageListener -- 消息监听器接口，注解@JmsListener与其功能相似
ListenerContainer -- 消息侦听器容器接口，实现有SimpleMessageListenerContainer、DefaultMessageListenerContainer
MessageConverter -- 消息转换接口，用于JMS消息到Java对象之间的转换

2.消息监听器

在Spring整合JMS的应用中我们在定义消息监听器的时候一共可以定义三种类型的消息监听器，分别是MessageListener、SessionAwareMessageListener和MessageListenerAdapter。下面就分别来介绍一下这几种类型的区别。

1.MessageListener

MessageListener是最原始的消息监听器，它是JMS规范中定义的一个接口。其中定义了一个用于处理接收到的消息的onMessage方法，该方法只接收一个Message参数。我们前面在讲配置消费者的时候用的消息监听器就是MessageListener，代码如下：

publicclassQueueMessageListenerimplementsMessageListener
{
@Override
publicvoid onMessage(Message message)
{
try
{
if(message instanceofTextMessage)
{
TextMessage tm =(TextMessage) message;
System.out.println("监听消息："+ tm.getText());
}
else
{
System.out.println("消息类型："+ message.getClass());
}
}
catch(JMSException e)
{
e.printStackTrace();
}
}
}

在上面代码中我们只是简单的打印了一些消息相关的信息。

2.SessionAwareMessageListener

SessionAwareMessageListener是Spring为我们提供的，它不是标准的JMS MessageListener。MessageListener的设计只是纯粹用来接收消息的，假如我们在使用MessageListener处理接收到的消息时我们需要发送一个消息通知对方我们已经收到这个消息了，那么这个时候我们就需要在代码里面去重新获取一个Connection或Session。SessionAwareMessageListener的设计就是为了方便我们在接收到消息后发送一个回复的消息，它同样为我们提供了一个处理接收到的消息的onMessage方法，但是这个方法可以同时接收两个参数，一个是表示当前接收到的消息Message，另一个就是可以用来发送消息的Session对象。先来看一段代码：

publicclassQueueSessionAwareMessageListenerimplementsSessionAwareMessageListener<TextMessage>
{
/** 回复消息的目的地 */
privateDestination destination;
@Override
publicvoid onMessage(TextMessage message,Session session)throwsJMSException
{
System.out.println("监听消息内容："+ message.getText());
MessageProducer messageProducer = session.createProducer(destination);
TextMessage replyMessage = session.createTextMessage("已收到消息："+ message.getJMSMessageID());
messageProducer.send(replyMessage);
}
publicDestination getDestination()
{
return destination;
}
publicvoid setDestination(Destination destination)
{
this.destination = destination;
}
}

在上面代码中我们定义了一个SessionAwareMessageListener，在这个Listener中我们在接收到了一个消息之后，利用对应的Session创建了一个到destination的生产者和对应的消息，然后利用创建好的生产者发送对应的消息。

3.MessageListenerAdapter

MessageListenerAdapter类实现了MessageListener接口和SessionAwareMessageListener接口，它的主要作用是将接收到的消息进行类型转换，然后通过反射的形式把它交给一个普通的Java类进行处理。MessageListenerAdapter会把接收到的消息做如下转换：

TextMessage转换为String对象
BytesMessage转换为byte数组
MapMessage转换为Map对象
ObjectMessage转换为对应的Serializable对象

既然前面说了MessageListenerAdapter会把接收到的消息做一个类型转换，然后利用反射把它交给真正的目标处理器——一个普通的Java类进行处理，如果真正的目标处理器是一个MessageListener或者是一个SessionAwareMessageListener，那么Spring将直接使用接收到的Message对象作为参数调用它们的onMessage方法，而不会再利用反射去进行调用。那么我们在定义一个MessageListenerAdapter的时候就需要为它指定这样一个目标类。这个目标类我们可以通过MessageListenerAdapter的构造方法参数指定，也可以通过属性delegate指定，如：


<bean id="messageListenerAdapter"class="org.springframework.jms.listener.adapter.MessageListenerAdapter">

<constructor-arg>
<bean id="readerMessage"class="com.test.ReaderMessage"/>
</constructor-arg>

<property name="defaultListenerMethod" value="receiveMessage"/>

<property name="delegate">
<bean id="readerMessage"class="com.test.ReaderMessage"/>
</property>
</bean>

前面说了如果我们指定的这个目标处理器是一个MessageListener或者是一个SessionAwareMessageListener的时候Spring将直接利用接收到的Message对象作为方法参数调用它们的onMessage方法。但是如果指定的目标处理器是一个普通的Java类时Spring将利用Message进行了类型转换之后的对象作为参数通过反射去调用真正的目标处理器的处理方法，那么Spring是如何知道该调用哪个方法呢？这是通过MessageListenerAdapter的defaultListenerMethod属性来决定的，当我们没有指定该属性时，Spring会默认调用目标处理器的handleMessage方法。若使用以下MessageListenerByAdapter类处理消息，可以配置MessageListenerAdapter的delegate属性来设置处理消息的方法。

publicclassMessageListenerByAdapter
{
publicvoid handleMessage(String message)
{
System.out.println("handleMessage方法处理消息，消息内容是："+ message);
}
publicvoid receiveMessage(String message)
{
System.out.println("receiveMessage方法处理消息，消息内容是："+ message);
}
}

MessageListenerAdapter除了会自动的把一个普通Java类当做MessageListener来处理接收到的消息之外，其另外一个主要的功能是可以自动的发送返回消息。当我们设置的消息处理方法的返回值不为空的时候，SpringJMS会自动将它封装为一个JMS Message，然后自动进行回复。那么这个时候这个回复消息将发送到哪里呢？这主要有两种方式可以指定。

第一，可以通过发送的Message的setJMSReplyTo方法指定该消息对应的回复消息的目的地。这需要生产者发送消息之前调用setJMSReplyTo方法。
第二，通过MessageListenerAdapter的defaultResponseDestination属性来指定。

注意：当两种方式都指定了消息的回复目的地的时候使用发送消息的setJMSReplyTo方法指定的目的地将具有较高的优先级。

4.配置消息监听器

配置以上三种消息监听器，需要使用消息侦听容器(MessageListenerContainer)，在配置一个MessageListenerContainer的时候有三个属性必须指定，一个是表示从哪里监听的ConnectionFactory；一个是表示监听什么的Destination；一个是接收到消息以后进行消息处理的MessageListener。示例如下：

<bean id="jmsContainer"class="org.springframework.jms.listener.DefaultMessageListenerContainer">

<property name="connectionFactory" ref="connectionFactory"/>

<property name="destination" ref="queueDestination"/>

<property name="messageListener" ref="queueMessageListener"/>
</bean>

Spring提供了三种AbstractMessageListenerContainer的子类，每种各有其特点。

SimpleMessageListenerContainer：这个消息侦听容器是三种中最简单的。它在启动时创建一个会话session和消费者Consumer，并且会使用标准的JMS MessageConsumer.setMessageListener()方法注册监听器让JMS提供者调用监听器的回调函数。它不会动态的适应运行时需要和参与外部的事务管理。兼容性方面，它非常接近于独立的JMS规范，但一般不兼容Java EE的JMS限制。
DefaultMessageListenerContainer：这个消息侦听器使用的最多。跟SimpleMessageListenerContainer相比，DefaultMessageListenerContainer会动态的适应运行时需要，并且能够参与外部的事务管理。它很好的平衡了对JMS提供者要求低、先进功能如事务参与和兼容Java EE环境。
ServerSessionMessageListenerContainer：这个监听器容器利用JMS ServerSessionPool SPI动态管理JMS Session。使用者各种消息监听器可以获得运行时动态调优功能，但是这也要求JMS提供者支持ServerSessionPool SPI。如果不需要运行时性能调整，请使用 DefaultMessageListenerContainer 或 SimpleMessageListenerContainer。

3.ActiveMQ与SpringJMS整合示例

本节提供了一个SpringJMS与ActiveMQ整合的示例，本示例可以作为参考。

1.配置spring-context-jms.xml

<?xml version="1.0" encoding="UTF-8"?>
<beansxmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jms="http://www.springframework.org/schema/jms"
xsi:schemaLocation="
http://www.springframework.org/schema/jms
http://www.springframework.org/schema/jms/spring-jms-4.0.xsd
http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-4.0.xsd"
default-lazy-init="false">

<beanid="connectionFactory"class="org.apache.activemq.ActiveMQConnectionFactory">
<propertyname="brokerURL"value="failover:(tcp://localhost:61616)"/>
</bean>

<!--
<bean id="pooledConnectionFactory" class="org.apache.activemq.pool.PooledConnectionFactory" destroy-method="stop">
<property name="connectionFactory" ref="connectionFactory" />
</bean>
-->

<beanid="cachingConnectionFactory"class="org.springframework.jms.connection.CachingConnectionFactory">
<propertyname="targetConnectionFactory"ref="connectionFactory"/>

<propertyname="sessionCacheSize"value="100"/>
</bean>

<beanid="queueDestination01"class="org.apache.activemq.command.ActiveMQQueue">

<constructor-arg>
<value>spring-jms-queue01</value>
</constructor-arg>
</bean>

<beanid="queueDestination02"class="org.apache.activemq.command.ActiveMQQueue">

<constructor-arg>
<value>spring-jms-queue02</value>
</constructor-arg>
</bean>

<beanid="jmsTemplate"class="org.springframework.jms.core.JmsTemplate">
<propertyname="connectionFactory"ref="cachingConnectionFactory"/>
<propertyname="defaultDestination"ref="queueDestination01"/>
<propertyname="receiveTimeout"value="10000"/>
</bean>

<beanid="jmsContainer"class="org.springframework.jms.listener.DefaultMessageListenerContainer">
<propertyname="connectionFactory"ref="cachingConnectionFactory"/>
<propertyname="destination"ref="queueDestination02"/>
<propertyname="messageListener">
<beanid="queueMessageListener"class="spring.QueueMessageListener"/>
</property>
</bean>
</beans>

注意：在配置文件中使用了SpringJMS的命名空间，就可以使用配置：<jms:listener-container>、<jms:jca-listener-container>

2.代码实现

配置文件中的消息监听器spring.QueueMessageListener代码如下：

publicclassQueueMessageListenerimplementsMessageListener
{
@Override
publicvoid onMessage(Message message)
{
try
{
if(message instanceofTextMessage)
{
TextMessage tm =(TextMessage) message;
System.out.println("监听消息："+ tm.getText());
}
else
{
System.out.println("消息类型："+ message.getClass());
}
}
catch(JMSException e)
{
e.printStackTrace();
}
}
}

实现消息创建接口：

/** 自定义消息创建器 */
publicclassMyMessageCreatorimplementsMessageCreator
{
privateString messageStr;
publicMyMessageCreator(String messageStr)
{
this.messageStr = messageStr;
}
@Override
publicMessage createMessage(Session session)throwsJMSException
{
return session.createTextMessage(messageStr);
}
}

根据配置编写测试代码：

publicstaticvoid main(String[] args)throwsException
{
ClassPathXmlApplicationContext applicationContext =newClassPathXmlApplicationContext("spring-context-jms.xml");
// 得到消息队列
Destination queueDestination01 = applicationContext.getBean("queueDestination01",Destination.class);
Destination queueDestination02 = applicationContext.getBean("queueDestination02",Destination.class);
// Spring JMS操作模版
JmsTemplate jmsTemplate = applicationContext.getBean("jmsTemplate",JmsTemplate.class);
// 发送消息
jmsTemplate.send(queueDestination01,newMyMessageCreator("测试消息001"));
jmsTemplate.send(queueDestination01,newMyMessageCreator("测试消息002"));
jmsTemplate.send(queueDestination02,newMyMessageCreator("测试消息003"));
jmsTemplate.send(queueDestination02,newMyMessageCreator("测试消息004"));
//接收消息
TextMessage textMessage =(TextMessage) jmsTemplate.receive(queueDestination01);
System.out.println(textMessage.getText());
textMessage =(TextMessage) jmsTemplate.receive(queueDestination01);
System.out.println(textMessage.getText());
applicationContext.close();
System.out.println("OK!");
}

本示例在配置文件中配置了两个队列：queueDestination01、queueDestination02，并使用监听器queueMessageListener监听队列queueDestination02。在测试代码中分别向两个队列发送消息，然后接收队列queueDestination01的消息，而队列queueDestination02的消息会被监听器queueMessageListener接收处理。

3.运行结果

监听消息：测试消息003
监听消息：测试消息004
测试消息001
测试消息002
OK!

4.消息转换MessageConverter

MessageConverter的作用主要有两方面，一方面它可以把我们的非标准化Message对象转换成我们的目标Message对象，这主要是用在发送消息的时候；另一方面它又可以把我们的Message对象转换成对应的目标对象，这主要是用在接收消息的时候。

例如：我们需要把一个用户信息User对象当JMS消息一样发送和接收，而不需要每次发送与接收之前都需要写转换代码(序列化)，此时我们就可以使用MessageConverter接口。如用户User类定义如下：

publicclassUserimplementsSerializable
{
privatestaticfinallong serialVersionUID =1L;
privateString name;
privateint age;
privateboolean sex;
......
}

1.实现转换接口MessageConverter

MessageConverter接口的实现如下，这里我们简单的使用Json序列化和反序列化实现：

publicclassUserMessageConverterimplementsMessageConverter
{
privateObjectMapper mapper =newObjectMapper();
@Override
publicMessage toMessage(Object object,Session session)throwsJMSException,MessageConversionException
{
String json =null;
try
{
json = mapper.writeValueAsString(object);
}
catch(JsonProcessingException e)
{
e.printStackTrace();
}
System.out.println("toMessage : "+ json);
return session.createTextMessage(json);
}
@Override
publicObject fromMessage(Message message)throwsJMSException,MessageConversionException
{
String json =((TextMessage) message).getText();
Object object =null;
try
{
object = mapper.readValue(json,User.class);
}
catch(Exception e)
{
e.printStackTrace();
}
System.out.println("fromMessage : "+ object);
return object;
}
}

Json的序列化与反序列化使用了jackson库。其实Spring也实现了几种MessageConverter，如下：

org.springframework.jms.support.converter.SimpleMessageConverter
org.springframework.jms.support.converter.MessagingMessageConverter
org.springframework.jms.support.converter.MarshallingMessageConverter
org.springframework.jms.support.converter.MappingJackson2MessageConverter

2.配置MessageConverter


<beanid="jmsTemplate"class="org.springframework.jms.core.JmsTemplate">
<propertyname="connectionFactory"ref="cachingConnectionFactory"/>
<propertyname="defaultDestination"ref="queueDestination01"/>
<propertyname="receiveTimeout"value="10000"/>
<propertyname="messageConverter">
<beanid="userMessageConverter"class="spring.UserMessageConverter"/>
</property>
</bean>

配置文件仍然基于之前的整合示例！

3.测试示例

基于之前的整合示例编写如下测试代码：

User user=newUser("危常焕",20,true);
// 发送消息
jmsTemplate.convertAndSend(user);
//接收消息
Object object = jmsTemplate.receiveAndConvert();
System.out.println(object);

注意：需要调用convertAndSend和receiveAndConvert方法发送和接收消息，运行结果如下：

toMessage :{"name":"危常焕","age":20,"sex":true}
fromMessage :User[name=危常焕, age=20, sex=true]
User[name=危常焕, age=20, sex=true]
OK!

5.事务管理JmsTransactionManager

-------------------------------------------------------------------------------------------------------------------------------

来自为知笔记(Wiz)