ActiveMQ——5.Spring-JmsTemplate之浏览与执行

电玩女神 2021-09-26 09:24 226阅读 0赞

# 浏览 #

## 概述 ##

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

浏览只是针对Queue的概念，Topic没有浏览。浏览是指获取消息而消息依然保持在broker中，而消息的接收会把消息从broker中移除。

浏览可以用来实现对Queue中消息的监控。

## JMS API ##

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

浏览的概念来源于JMS，所以有必要先把JmsTemplate放一放。先看一下下面的API：

根据上面的API，我们应该可以这样使用：

![复制代码][copycode.gif]

1 QueueBrowser browser = session.createBrowser(queue);
    2 Enumeration<Message> msgEnum = browser.getEnumeration();
    3 browser.close();
    4 
    5 while (msgEnum.hasMoreElements()) {
    6     Message msg = msgEnum.nextElement();
    7 }

![复制代码][copycode.gif]

P.S.只是推论，没有验证。

## JmsTemplate的API ##

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

JmsTemplate提供了2组\*3，共计6个浏览的方法。

1.  基本的浏览
2.  带有选择器的浏览

鉴于我们对这种分组的习惯、消息选择器的概念都已经驾轻就熟，所以这里不再分开介绍。我们一鼓作气，解决掉吧：

<table style="margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; max-width:850px; border:1px solid silver; word-break:break-word; width:847px"> 
 <tbody style="margin:0px; padding:0px"> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> <span style="margin:0px; padding:0px">Class org.springframework.jms.core.JmsTemplate</span></td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 
    <ul style="margin:0px 0px 1em 40px; padding:0px"> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T browse(BrowserCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 从默认的Queue中浏览消息，要求设置了默认的Destination，且类型为Queue。action是一个回调对象，它负责浏览消息，并返回浏览的结果。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T browse(Queue queue, BrowserCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 从指定的Queue中浏览消息。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T browse(String queueName, BrowserCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 从指定name的Queue中浏览消息。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc"></li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T browseSelected(String messageSelector, BrowserCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 从默认的Queue中浏览消息，添加了消息选择器。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T browseSelected(Queue queue, String messageSelector, BrowserCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 从指定的Queue中浏览消息，添加了消息选择器。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T browseSelected(String queueName, String messageSelector, BrowserCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 从指定name的Queue中浏览消息，添加了消息选择器。</li> 
    </ul> </td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td colspan="1" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> <span style="margin:0px; padding:0px">Interface&nbsp;org.springframework.jms.core.BrowserCallback&lt;T&gt;</span></td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td colspan="1" style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 
    <ul style="margin:0px 0px 1em 40px; padding:0px"> 
     <li style="margin:0px; padding:0px; list-style-type:disc">T doInJms(Session session, QueueBrowser browser)<br style="margin:0px; padding:0px"> 浏览队列中的消息，并返回浏览的结果。这是一个回调方法，Spring会为我们提供QueueBrowser对象，我们可以据此获取消息，并自由的转换。最后以我们希望的类型返回。</li> 
    </ul> </td> 
  </tr> 
 </tbody> 
</table>

让我们先看下BrowserCallback定义的回调方法。我们在客户端和broker建立连接的整个过程中，截取这样的一段：

我们已经使用Session创建了QueueBrowser的实例，然后我们像前文的demo中那样浏览消息。我们决定对消息再做一下转换，比如如果能确定每一个消息的内容都是一个字符串，我们可以最终转换成java.util.List<String>类型的结果。

这个片段是我们浏览Queue的整个片段，这个片段也是BrowserCallback唯一关心的问题，我们定义了这个片段的具体实现，然后交给JmsTemplate，由它在合适的时候，按照我们定义的方式浏览并返回消息。

下面给个demo：

List<String> contList = jt.browse(DESTINATION_NAME,
            new BrowserCallback<List<String>>() {
            
                public List<String> doInJms(Session session,
                        QueueBrowser browser) throws JMSException {
                        
                    MessageConverter converter = new SimpleMessageConverter();
                    List<String> messContentList = new ArrayList<String>();
                    
                    @SuppressWarnings("unchecked")
                    Enumeration<Message> messageEnum = browser
                            .getEnumeration();
                    while (messageEnum.hasMoreElements()) {
                        Message msg = messageEnum.nextElement();
                        String text = (String) converter.fromMessage(msg);
                        messContentList.add(text);
                    }
                    return messContentList;
                }
            });
            
    for (String text : contList) {
        System.out.println(text);
    }

# **执行** #

## 概述 ##

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

前面我们分别介绍了发送、接收和浏览，这三个的实现都依赖于将要介绍的执行。

执行算是一个相对比较底层的方法系列，一般情况下，我们不需要直接面向将要介绍的方法。

## 执行 ##

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

## 1.关于回调接口 ##

在讲执行之前，我们先回忆一下之前将的发送、接收和浏览。JmsTemplate接管了整个过程，但是考虑到我们可能在某个特殊的阶段做一些特殊的处理，所以又在敏感的点给我们自主行为的机会——以回调接口的方式。我们实现回调，JmsTemplate在到了那个点时，调用我们的回调。让我们看一下我们接触到的回调接口：

接下来，我们来接触两个新的回调接口。

现在我们已经接触了5个回调接口，我们可以把MessageCreator、MessagePostProcessor归为一类，因为它们的名字表达了它们的作用，即它们是有非常强的目的性的，如果你实际上用它们来做其他的事情，恐怕有违设计者的初衷。我们把BrowserCallback、ProducerCallback、SessionCallback归为一类，因为它们的名字强调了它们需要的资源，或者说是被调用的时机。比如BrowserCallback需要QueueBrowser资源，在创建了QueueBrowser之后调用。其中，BrowserCallback和ProducerCallback所需要的资源的本身，也有非常强的目的：你要QueueBrowser就是为了浏览，你要MessageProducer就是为了发送。而SessionCallback需要的是Session资源，JMS中所有的通信类型都需要Session，所以我们也不能确定它的目的——即，它给了我们自由发挥的空间。

Session位于编程模型的唯一主干道，而且在末端，如下面这样：

![Center][]

Spring一贯的思想就是：帮我们做尽量多的事，又给我们留一定的空间做其他的事。

## 2.执行的方法 ##

使用 ProducerCallback和 SessionCallback，JmsTemplate定义了5个方法。

<table style="margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; max-width:850px; border:1px solid silver; word-break:break-word; width:847px"> 
 <tbody style="margin:0px; padding:0px"> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> <span style="margin:0px; padding:0px">Class&nbsp;org.springframework.jms.core.JmsTemplate</span></td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 
    <ul style="margin:0px 0px 1em 40px; padding:0px"> 
     <li style="margin:0px; padding:0px; list-style-type:disc"><span style="margin:0px; padding:0px; line-height:1.6">public &lt;T&gt; T execute(ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> </span>基于默认的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(Destination destination, ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 基于指定的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(String destinationName, ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 基于指定的name所对应的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(SessionCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 创建Session，执行回调方法并提供Session作为参数</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(SessionCallback&lt;T&gt; action, boolean startConnection)<br style="margin:0px; padding:0px"> 创建Session，执行回调方法并提供Session作为参数。startConnection表示是否在调用javax.jms.Connection#start()方法。如果你是写消息到broker，那么使用false；如果你是从broker获取消息（接收或者浏览），那么使用true。</li> 
    </ul> </td> 
  </tr> 
 </tbody> 
</table>

最后我们给一个demo，这个demo来自JmsTemplate\# send(Destination destination, MessageCreator messageCreator):

@Override
    public void send(final Destination destination, final MessageCreator messageCreator) throws JmsException {
        execute(new SessionCallback<Object>() {
            @Override
            public Object doInJms(Session session) throws JMSException {
                doSend(session, destination, messageCreator);
                return null;
            }
        }, false);
    }

<table style="margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; max-width:850px; border:1px solid silver; word-break:break-word; width:847px"> 
 <tbody style="margin:0px; padding:0px"> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> <span style="margin:0px; padding:0px">Class&nbsp;org.springframework.jms.core.JmsTemplate</span></td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 
    <ul style="margin:0px 0px 1em 40px; padding:0px"> 
     <li style="margin:0px; padding:0px; list-style-type:disc"><span style="margin:0px; padding:0px; line-height:1.6">public &lt;T&gt; T execute(ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> </span>基于默认的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(Destination destination, ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 基于指定的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(String destinationName, ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 基于指定的name所对应的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(SessionCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 创建Session，执行回调方法并提供Session作为参数</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(SessionCallback&lt;T&gt; action, boolean startConnection)<br style="margin:0px; padding:0px"> 创建Session，执行回调方法并提供Session作为参数。startConnection表示是否在调用javax.jms.Connection#start()方法。如果你是写消息到broker，那么使用false；如果你是从broker获取消息（接收或者浏览），那么使用true。</li> 
    </ul> </td> 
  </tr> 
 </tbody> 
</table>

最后我们给一个demo，这个demo来自JmsTemplate\# send(Destination destination, MessageCreator messageCreator):

P.S.第6行的doSend是一个protected的方法，简单说下：它需要session和destination来创建producer；需要messageCreator来创建message，然后producer发送message。我们的send并没有Session资源，所以在send和doSend之间，隔了一层SessionCallback，来获取Session资源。

<table style="margin:0px; padding:0px; border-collapse:collapse; border-spacing:0px; max-width:850px; border:1px solid silver; word-break:break-word; width:847px"> 
 <tbody style="margin:0px; padding:0px"> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> <strong style="margin:0px; padding:0px">Class&nbsp;org.springframework.jms.core.JmsTemplate</strong></td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="margin:0px; padding:3px; border:1px solid silver; border-collapse:collapse"> 
    <ul style="margin:0px 0px 1em 40px; padding:0px"> 
     <li style="margin:0px; padding:0px; list-style-type:disc"><span style="margin:0px; padding:0px; line-height:1.6">public &lt;T&gt; T execute(ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> </span>基于默认的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(Destination destination, ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 基于指定的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(String destinationName, ProducerCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 基于指定的name所对应的Destination创建MessageProducer，并在该发送的时候调用回调接口，如何发送由回调接口的实现决定。</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(SessionCallback&lt;T&gt; action)<br style="margin:0px; padding:0px"> 创建Session，执行回调方法并提供Session作为参数</li> 
     <li style="margin:0px; padding:0px; list-style-type:disc">public &lt;T&gt; T execute(SessionCallback&lt;T&gt; action, boolean startConnection)<br style="margin:0px; padding:0px"> 创建Session，执行回调方法并提供Session作为参数。startConnection表示是否在调用javax.jms.Connection#start()方法。如果你是写消息到broker，那么使用false；如果你是从broker获取消息（接收或者浏览），那么使用true。</li> 
    </ul> </td> 
  </tr> 
 </tbody> 
</table>

最后我们给一个demo，这个demo来自JmsTemplate\# send(Destination destination, MessageCreator messageCreator):

[copycode.gif]: /images/20210923/d0cbae2d6c1645099be249ee600b1f18.png
[Center]: /images/20210923/e688714ab1e447e691f3d0376cc3d41b.png