Preface

This article will realize the integration of spring and activemq, mainly demonstrating how to realize the point-to-point and publish-subscribe communication model, and how to send persistent messages and achieve persistent subscription. For an introduction to persistent messages and persistent subscriptions, please refer to:< ActiveMQ - Persistent Messages and Subscriptions for Persistent Themes>.

Drivers get on the bus

Recall that to receive and send messages, you need the following components: connection factory, destination, producer, consumer and message. Yes, spring integration activemq also requires these components.

Connecting factories
spring has established its own connection management class to better manage connections. The original JMS connection factory is included in the connection management class in a combined way. The operation of creating connections is performed by the original JMS connection factory. spring's connection management class has two main implementations: SingleConnectionFactory and ChaingConnectionFactory.

Single Connection Factory: All requests to create connections return the same connection, and the returned connection cannot be close d.

Caching Connection Factory: It inherits the features of Single Connection Factory and adds caching capabilities that can cache Session, Message Producer and Message Consumer.

<!--Configure Connection Factory-->
<bean id="connectionFactory"
      class="org.springframework.jms.connection.CachingConnectionFactory">
    <property name="sessionCacheSize" value="10"/>
    <property name="targetConnectionFactory">
        <bean class="org.apache.activemq.ActiveMQConnectionFactory">
            <!-- MQ address -->
            <!--
                 <property name="userName" value="admin"/>
                 <property name="password" value="123456"/>
                 <property name="brokerURL" value="tcp://192.168.88.18:61616"/>
             -->
            <property name="brokerURL" value="tcp://127.0.0.1:61616"/>
            <!-- Whether to send asynchronously -->
            <property name="useAsyncSend" value="true"/>
        </bean>
    </property>
</bean>

Destination destination

Configure the destination, where you configure a queue and a topic, and give them a name, which is retrieved from the configuration file.

    <!--Configuration queue-->
    <bean id="activeMQQueue" class="org.apache.activemq.command.ActiveMQQueue">
        <constructor-arg value="${queue.name}"/>
    </bean>

    <!--Configuration theme-->
    <bean id="activeMQTopic" class="org.apache.activemq.command.ActiveMQTopic">
        <constructor-arg value="${topic.name}"/>
    </bean>

Message producer
spring defines templates for message producers, which configure the destination of the message delivered by the producer and the persistence of the message.

    <!-- **************Configuring message producers************* -->
    <!--Point-to-point model-->
    <bean id="queueJmsTemplate" class="org.springframework.jms.core.JmsTemplate">
        <constructor-arg ref="connectionFactory"/>
        <!--Message persistence-->
        <property name="deliveryPersistent" value="true"/>
        <property name="defaultDestination" ref="activeMQQueue"/>
        <property name="pubSubDomain" value="false"/>
    </bean>

    <!--Release/Subscription model-->
    <bean id="topicJmsTemplate" class="org.springframework.jms.core.JmsTemplate">
        <constructor-arg ref="connectionFactory"/>
        <!--Message persistence-->
        <property name="deliveryPersistent" value="true"/>
        <!--Destination-->
        <property name="defaultDestination" ref="activeMQTopic"/>
        <!--Subscription model -->
        <property name="pubSubDomain" value="true"/>
    </bean>

News consumers
Previously, to use persistent subscribers, an ID must be assigned to the connection and a name must be assigned to the subscriber. The combination of client_id and subcriber name must determine the only subscriber. In order to use persistent subscriptions, an additional connection factory is created and an ID is assigned to the connection.

<!--Configure Connection Factory-->
    <bean id="consumerConnectionFactory"
          class="org.springframework.jms.connection.CachingConnectionFactory">
        <property name="sessionCacheSize" value="10"/>
        <property name="targetConnectionFactory">
            <bean class="org.apache.activemq.ActiveMQConnectionFactory">
                <!-- MQ address -->
                <!--
                     <property name="userName" value="admin"/>
                     <property name="password" value="123456"/>
                     <property name="brokerURL" value="tcp://192.168.88.18:61616"/>
                 -->
                <property name="brokerURL" value="tcp://127.0.0.1:61616"/>
                <property name="useAsyncSend" value="true"/>
                <!-- to connection distribution ID -->
                <property name="clientID" value="client_id"/>
            </bean>
        </property>
    </bean>

With connections, consumers also need to specify message receivers to listen for and process messages.

public class MyQueueMessageListener implements MessageListener {
    @Override
    public void onMessage(Message message) {
        try {
            TextMessage textMessage = (TextMessage) message;
            System.out.println("MyQueueMessageListener Received the message:" + textMessage.getText());
        } catch (JMSException e) {
            e.printStackTrace();
        }
    }
}

Sprjms provides a MessageListener Container interface to manage connections, consumers, destinations, and message receipts. spring provides two implementation classes, SimpleMessageListenerContainer and DefaultMessageListenerContainer.

SimpleMessageListener Container, which creates a session and Consumer consumer from the beginning, registers the listener using the standard JMS MessageConsumer.setMessageListener() method to let the JMS provider call the callback function of the listener. It does not dynamically adapt to runtime needs and participate in external transaction management. In terms of compatibility, it is very close to the independent JMS specification, but generally incompatible with the JMS limitations of Java EE.

Compared with SimpleMessageListener Container, DefaultMessageListener Container dynamically adapts to runtime needs and can participate in external transaction management. It balances low requirements for JMS providers, advanced functions such as transaction participation and compatibility with Java EE environments. In general, DefaultMessageListener Container is used.

      <bean class="org.springframework.jms.listener.DefaultMessageListenerContainer">
        <property name="connectionFactory" ref="consumerConnectionFactory"/>
        <!--Destination name, consistent with the previous destination configuration-->
        <property name="destinationName" value="${queue.name}"/>
        <!--Automatic confirmation-->
        <property name="sessionAcknowledgeMode" value="1"/>
        <!--Point-to-point model-->
        <property name="pubSubDomain" value="false"/>
        <!--MessageListener-->
        <property name="messageListener" ref="myQueueMessageListener"/>
    </bean>
    <bean class="org.springframework.jms.listener.DefaultMessageListenerContainer">
        <property name="connectionFactory" ref="consumerConnectionFactory"/>
        <!--Destination name, consistent with the previous destination configuration-->
        <property name="destinationName" value="${topic.name}"/>
        <!--Automatic confirmation-->
        <property name="sessionAcknowledgeMode" value="1"/>
        <!--Subscription model-->
        <property name="pubSubDomain" value="true"/>
        <!--Persistent Subscription Name-->
        <property name="durableSubscriptionName" value="durable_sub_name"/>
        <!--durable subscription-->
        <property name="subscriptionDurable" value="true"/>
        <!--MessageListener-->
        <property name="messageListener" ref="myQueueMessageListener"/>
    </bean>

All configuration files are given below:

• spring-context.xml

  <beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.springframework.org/schema/beans
         http://www.springframework.org/schema/beans/spring-beans-4.2.xsd">
  <bean class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
      <property name="location">
          <value>classpath:activemq.properties</value>
      </property>
  </bean>
  </beans>

• spring-activemq-producer.xml

  <?xml version="1.0" encoding="UTF-8"?>
  <beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.springframework.org/schema/beans
         http://www.springframework.org/schema/beans/spring-beans-4.2.xsd">
  
  <!--Configure Connection Factory-->
  <bean id="producerConnectionFactory"
        class="org.springframework.jms.connection.CachingConnectionFactory">
      <property name="sessionCacheSize" value="10"/>
      <property name="targetConnectionFactory">
          <bean class="org.apache.activemq.ActiveMQConnectionFactory">
              <!-- MQ address -->
              <!--
                   <property name="userName" value="admin"/>
                   <property name="password" value="123456"/>
                   <property name="brokerURL" value="tcp://192.168.88.18:61616"/>
               -->
              <property name="brokerURL" value="tcp://127.0.0.1:61616"/>
              <!-- Whether to send asynchronously -->
              <property name="useAsyncSend" value="true"/>
          </bean>
      </property>
  </bean>
  
  <!-- **************Configuring message producers************* -->
  <!--Point-to-point model-->
  <bean id="queueJmsTemplate" class="org.springframework.jms.core.JmsTemplate">
      <constructor-arg ref="producerConnectionFactory"/>
      <!--Message persistence-->
      <property name="deliveryPersistent" value="true"/>
      <property name="defaultDestination" ref="activeMQQueue"/>
      <property name="pubSubDomain" value="false"/>
  </bean>
  
  <!--Release/Subscription model-->
  <bean id="topicJmsTemplate" class="org.springframework.jms.core.JmsTemplate">
      <constructor-arg ref="producerConnectionFactory"/>
      <!--Message persistence-->
      <property name="deliveryPersistent" value="true"/>
      <!--Destination-->
      <property name="defaultDestination" ref="activeMQTopic"/>
      <!--Subscription model -->
      <property name="pubSubDomain" value="true"/>
  </bean>
  
  <!--Configuration queue-->
  <bean id="activeMQQueue" class="org.apache.activemq.command.ActiveMQQueue">
      <constructor-arg value="${queue.name}"/>
  </bean>
  
  <!--Configuration theme-->
  <bean id="activeMQTopic" class="org.apache.activemq.command.ActiveMQTopic">
      <constructor-arg value="${topic.name}"/>
  </bean>
  </beans>

• spring-activemq-consumer.xml

    <!--Configure Connection Factory-->
    <bean id="consumerConnectionFactory"
          class="org.springframework.jms.connection.CachingConnectionFactory">
        <property name="sessionCacheSize" value="10"/>
        <property name="targetConnectionFactory">
            <bean class="org.apache.activemq.ActiveMQConnectionFactory">
                <!-- MQ address -->
                <!--
                     <property name="userName" value="admin"/>
                     <property name="password" value="123456"/>
                     <property name="brokerURL" value="tcp://192.168.88.18:61616"/>
                 -->
                <property name="brokerURL" value="tcp://127.0.0.1:61616"/>
                <!-- Whether to send asynchronously -->
                <property name="useAsyncSend" value="true"/>
                <property name="clientID" value="client_id"/>
            </bean>
        </property>
    </bean>

    <!--*******Here are some of the relevant consumer configurations bean*******-->

    <!--messages receiving bean-->
    <bean id="myQueueMessageListener"
          class="com.github.thinwonton.activemq.MyQueueMessageListener"/>
    <bean id="myTopicMessageListener"
          class="com.github.thinwonton.activemq.MyTopicMessageListener"/>

    <bean class="org.springframework.jms.listener.DefaultMessageListenerContainer">
        <property name="connectionFactory" ref="consumerConnectionFactory"/>
        <!--Destination name, consistent with the previous destination configuration-->
        <property name="destinationName" value="${queue.name}"/>
        <!--Automatic confirmation-->
        <property name="sessionAcknowledgeMode" value="1"/>
        <!--Point-to-point model-->
        <property name="pubSubDomain" value="false"/>
        <!--MessageListener-->
        <property name="messageListener" ref="myQueueMessageListener"/>
    </bean>
    <bean class="org.springframework.jms.listener.DefaultMessageListenerContainer">
        <property name="connectionFactory" ref="consumerConnectionFactory"/>
        <!--Destination name, consistent with the previous destination configuration-->
        <property name="destinationName" value="${topic.name}"/>
        <!--Automatic confirmation-->
        <property name="sessionAcknowledgeMode" value="1"/>
        <!--Subscription model-->
        <property name="pubSubDomain" value="true"/>
        <!--Persistent Subscription Name-->
        <property name="durableSubscriptionName" value="durable_sub_name"/>
        <!--durable subscription-->
        <property name="subscriptionDurable" value="true"/>
        <!--MessageListener-->
        <property name="messageListener" ref="myQueueMessageListener"/>
    </bean>

</beans>