# 核心消息传递

# 消息传递通道

# 消息通道

虽然Message在封装数据方面发挥着关键作用,但将消息生产者与消息消费者分离开来的是MessageChannel

# MessageChannel 接口

Spring 集成的顶级MessageChannel接口定义如下:

public interface MessageChannel {

    boolean send(Message message);

    boolean send(Message message, long timeout);
}

发送消息时,如果消息发送成功,则返回值为true。如果发送调用超时或被中断,它将返回false

# PollableChannel

由于消息通道可能会或可能不会缓冲消息(如Spring Integration Overview中所讨论的),因此两个子接口定义了缓冲和非缓冲通道行为。下面的清单显示了PollableChannel接口的定义:

public interface PollableChannel extends MessageChannel {

    Message<?> receive();

    Message<?> receive(long timeout);

}

与发送方法一样,当接收到消息时,在超时或中断的情况下,返回值为 null。

# SubscribableChannel

SubscribableChannel基本接口是通过将消息直接发送到其订阅的MessageHandler实例的通道来实现的。因此,它们不提供用于轮询的接收方法。相反,他们定义了管理这些订阅者的方法。下面的清单显示了SubscribableChannel接口的定义:

public interface SubscribableChannel extends MessageChannel {

    boolean subscribe(MessageHandler handler);

    boolean unsubscribe(MessageHandler handler);

}

# 消息通道实现

Spring 集成提供了几种不同的消息通道实现方式。下面几节简要介绍每一种方法。

# PublishSubscribeChannel

PublishSubscribeChannel实现将发送给它的任何Message广播给其所有订阅的处理程序。这通常用于发送事件消息,其主要作用是通知(与文档消息相反,文档消息通常由单个处理程序处理)。请注意,PublishSubscribeChannel仅用于发送。由于它在调用send(Message)方法时直接向订阅者广播,因此消费者无法轮询消息(它没有实现PollableChannel,因此没有receive()方法)。相反,任何订阅服务器本身必须是MessageHandler,并且依次调用订阅服务器的handleMessage(Message)方法。

在版本 3.0 之前,在没有订阅服务器的PublishSubscribeChannel上调用send方法返回false。当与MessagingTemplate一起使用时,将抛出MessageDeliveryException。从版本 3.0 开始,行为发生了变化,如果至少存在最小的订阅服务器(并成功处理消息),则send总是被认为是成功的。可以通过设置minSubscribers属性来修改此行为,该属性的默认值为0

如果使用TaskExecutor,则仅使用存在正确数量的订阅服务器来进行此确定,因为消息的实际处理是异步执行的。
# QueueChannel

QueueChannel实现封装了一个队列。与PublishSubscribeChannel不同,QueueChannel具有点对点语义。换句话说,即使该通道有多个消费者,其中只有一个应该接收到发送到该通道的任何Message。它提供了一个默认的无参数构造函数(提供了一个基本上是无界的Integer.MAX_VALUE的容量),以及一个接受队列容量的构造函数,如下面的清单所示:

public QueueChannel(int capacity)

未达到容量限制的通道将消息存储在其内部队列中,并且send(Message<?>)方法立即返回,即使没有接收者准备好处理该消息。如果队列已达到容量,发送方将阻塞该队列,直到该队列中有可用的空间为止。或者,如果使用具有附加超时参数的 send 方法,则队列将阻塞,直到可用的房间或超时周期(以先发生的为准)过去为止。类似地,如果队列上有消息可用,则receive()调用将立即返回,但是,如果队列是空的,则接收调用可能会阻塞,直到消息可用或超时(如果提供了超时)为止。在这两种情况下,都可以通过传递 0 的超时值来强制立即返回,而不管队列的状态如何。但是,请注意,这将无限期地调用send()receive()参数块的版本。

# PriorityChannel

虽然QueueChannel强制执行先进先出排序,但PriorityChannel是一种替代实现,它允许基于优先级在通道内对消息进行排序。默认情况下,优先级由每个消息中的priority头决定。但是,对于自定义优先级确定逻辑,可以向Comparator<Message<?>>构造函数提供类型PriorityChannel的比较器。

# RendezvousChannel

RendezvousChannel启用了一个“直接切换”场景,其中,发送方会阻塞,直到另一方调用该通道的receive()方法。另一方屏蔽,直到发送方发送消息。在内部,这种实现与QueueChannel非常相似,只是它使用了SynchronousQueueBlockingQueue的零容量实现)。这在发送方和接收方在不同线程中操作的情况下很好地工作,但是在队列中异步丢弃消息是不合适的。换句话说,对于RendezvousChannel,发送者知道某些接收者已经接受了该消息,而对于QueueChannel,该消息将被存储到内部队列中,并且可能永远不会被接收。

请记住,所有这些基于队列的通道在默认情况下仅在内存中存储消息。
当需要持久性时,你可以在“queue”元素中提供一个“message-store”属性来引用一个持久的MessageStore实现,或者你可以用一个持久代理支持的本地通道替换该本地通道,如 JMS 支持的通道或通道适配器,
后一种选项允许你利用任何 JMS 提供者的消息持久性实现,如JMS 支持中所讨论的,
但是,当不需要在队列中进行缓冲时,最简单的方法是依赖DirectChannel,在下一节中讨论。

RendezvousChannel对于实现请求-回复操作也很有用。发送方可以创建RendezvousChannel的临时匿名实例,然后在构建Message时将其设置为“replychannel”头。在发送Message之后,发送者可以立即调用receive(可选地提供超时值),以便在等待答复Message时阻塞。这与 Spring 集成的许多请求-应答组件内部使用的实现非常相似。

# DirectChannel

DirectChannel具有点对点语义,但在其他方面比前面描述的任何基于队列的通道实现更类似于PublishSubscribeChannel。它实现了SubscribableChannel接口,而不是PollableChannel接口,因此它直接将消息分派给订阅服务器。然而,作为点对点信道,它与PublishSubscribeChannel的不同之处在于,它将每个Message发送到一个订阅的MessageHandler

除了是最简单的点对点通道选项外,它最重要的特性之一是,它使单个线程能够在通道的“两边”执行操作。例如,如果处理程序订阅了DirectChannel,那么在send()方法调用返回之前,向该通道发送Message将触发该处理程序的handleMessage(Message)方法的调用。

提供具有这种行为的通道实现的主要动机是支持必须跨越通道的事务,同时仍然受益于通道提供的抽象和松耦合。如果发送调用是在事务的范围内调用的,那么处理程序调用的结果(例如,更新数据库记录)将在确定该事务的最终结果(提交或回滚)中起到一定的作用。

由于DirectChannel是最简单的选项,并且不会增加调度和管理 Poller 线程所需的任何额外开销,因此它是 Spring 集成中的默认通道类型,
的一般思想是为应用程序定义通道,考虑其中哪些需要提供缓冲或限制输入,并将其修改为基于队列的PollableChannels
同样,如果一个频道需要广播消息,它不应该是DirectChannel,而应该是PublishSubscribeChannel
,稍后,我们展示了如何配置这些通道中的每一个。

DirectChannel在内部委托给消息调度器以调用其订阅的消息处理程序,并且该调度器可以具有由load-balancerload-balancer-ref属性(互斥)公开的负载平衡策略。消息调度器使用负载平衡策略来帮助确定当多个消息处理程序订阅同一通道时消息如何在消息处理程序之间分配。为了方便起见,load-balancer属性公开指向LoadBalancingStrategy的预先存在的实现的值的枚举。唯一可用的值是round-robin(旋转中处理程序之间的负载平衡)和none(对于希望显式禁用负载平衡的情况)。在将来的版本中可能会添加其他策略实现。然而,自版本 3.0 以来,你可以提供自己的LoadBalancingStrategy实现,并通过使用load-balancer-ref属性注入它,该属性应该指向实现LoadBalancingStrategy的 Bean,如下例所示:

aFixedSubscriberChannel是一个SubscribableChannel只支持一个不能取消订阅的MessageHandler订阅服务器的SubscribableChannel。当不涉及其他订阅服务器且不需要通道拦截器时,这对于高吞吐量性能用例非常有用。

<int:channel id="lbRefChannel">
  <int:dispatcher load-balancer-ref="lb"/>
</int:channel>

<bean id="lb" class="foo.bar.SampleLoadBalancingStrategy"/>

注意,load-balancerload-balancer-ref属性是互斥的。

负载平衡还与布尔failover属性一起工作。如果failover值为真(默认值),则当前面的处理程序抛出异常时,Dispatcher 将返回到任何后续的处理程序(根据需要)。顺序是由在处理程序本身上定义的可选订单值确定的,或者,如果不存在这样的值,则由处理程序订阅的顺序确定。

如果在特定的情况下,要求调度器总是尝试调用第一个处理程序,然后在每次发生错误时以相同的固定顺序返回,则不应提供负载平衡策略。换句话说,即使没有启用负载平衡,Dispatcher 仍然支持failover布尔属性。然而,在没有负载平衡的情况下,处理程序的调用总是根据它们的顺序从第一个开始。例如,当对小学、中学、大学等有一个明确的定义时,这种方法很有效。当使用名称空间支持时,任一端点上的order属性决定顺序。

请记住,负载平衡和failover仅在通道具有多个订阅消息处理程序时才适用。
在使用名称空间支持时,这意味着多个端点共享在input-channel属性中定义的相同通道引用。

从版本 5.2 开始,当failover为真时,当前处理程序的失败以及失败的消息将分别记录在debuginfo(如果已分别配置)下。

# ExecutorChannel

ExecutorChannel是一个点对点通道,支持与DirectChannel相同的 Dispatcher 配置(负载平衡策略和failover布尔属性)。这两种调度通道类型之间的主要区别是,ExecutorChannel委托给TaskExecutor的一个实例来执行调度。这意味着发送方法通常不会阻塞,但也意味着处理程序调用可能不会发生在发送方的线程中。因此,它不支持跨越发送者和接收处理程序的事务。

例如,当使用带有抑制客户机的拒绝策略(例如ThreadPoolExecutor.CallerRunsPolicy)的TaskExecutor时,发送方有时会阻塞.,在线程池达到最大容量且执行者的工作队列已满的任何时候,发送者的线程都可以执行该方法。
由于这种情况只会以不可预测的方式发生,因此不应依赖它进行事务。
# FluxMessageChannel

FluxMessageChannelorg.reactivestreams.Publisher实现的org.reactivestreams.Publisher,用于将消息发送到内部reactor.core.publisher.Flux,以供下游的响应订阅者按需消费。该通道实现既不是SubscribableChannel,也不是PollableChannel,因此只有org.reactivestreams.Subscriber实例可以用于从该通道消耗具有背压特性的反应流。另一方面,FluxMessageChannel实现了ReactiveStreamsSubscribableChannel及其subscribeTo(Publisher<Message<?>>)契约,允许接收来自反应源发布者的事件,将反应流连接到集成流。为了在整个集成流程中实现完全无反应的行为,必须在流程中的所有端点之间放置这样的通道。

有关与反应流的交互的更多信息,请参见反应流支持

# 作用域信道

Spring Integration1.0 提供了ThreadLocalChannel的实现,但自 2.0 起该实现已被移除。现在,处理相同需求的更一般的方法是将scope属性添加到通道中。属性的值可以是上下文中可用的作用域的名称。例如,在 Web 环境中,某些作用域是可用的,任何自定义作用域实现都可以在上下文中注册。下面的示例显示了应用于通道的线程本地作用域,包括作用域本身的注册:

<int:channel id="threadScopedChannel" scope="thread">
     <int:queue />
</int:channel>

<bean class="org.springframework.beans.factory.config.CustomScopeConfigurer">
    <property name="scopes">
        <map>
            <entry key="thread" value="org.springframework.context.support.SimpleThreadScope" />
        </map>
    </property>
</bean>

在前面的示例中定义的通道也在内部委托给一个队列,但是该通道绑定到当前线程,因此队列的内容也是类似地绑定的。这样,发送到该通道的线程以后可以接收这些相同的消息,但没有其他线程能够访问它们。虽然很少需要线程范围的通道,但在DirectChannel实例被用来强制执行单个线程操作但任何回复消息都应该发送到“终端”通道的情况下,它们可能是有用的。如果该终端通道是线程范围的,则原始发送线程可以从终端通道收集其回复。

现在,由于任何通道都可以被作用域定义,所以除了线程本地之外,你还可以定义自己的作用域。

# 信道拦截器

消息传递体系结构的优势之一是能够提供公共行为,并以非侵入性的方式捕获有关通过系统的消息的有意义的信息。由于Message实例被发送到MessageChannel实例并从MessageChannel实例接收,这些通道提供了截获发送和接收操作的机会。下面的清单中显示了ChannelInterceptor策略接口,它为每个操作提供了方法:

public interface ChannelInterceptor {

    Message<?> preSend(Message<?> message, MessageChannel channel);

    void postSend(Message<?> message, MessageChannel channel, boolean sent);

    void afterSendCompletion(Message<?> message, MessageChannel channel, boolean sent, Exception ex);

    boolean preReceive(MessageChannel channel);

    Message<?> postReceive(Message<?> message, MessageChannel channel);

    void afterReceiveCompletion(Message<?> message, MessageChannel channel, Exception ex);
}

在实现接口之后,使用通道注册拦截器只需要进行以下调用:

channel.addInterceptor(someChannelInterceptor);

返回Message实例的方法可以用于转换Message,也可以返回’null’以阻止进一步的处理(当然,任何方法都可以抛出RuntimeException)。同样,preReceive方法可以返回false以阻止接收操作继续进行。

请记住,receive()调用仅与PollableChannels相关,
实际上,SubscribableChannel接口甚至没有定义receive()方法。
的原因是,当Message被发送到SubscribableChannel时,它被直接发送到零个或多个订阅者,这取决于信道的类型(例如,
aPublishSubscribeChannel发送到其所有订阅者)。因此,只有当拦截器应用到
时,才调用preReceive(…​)afterReceiveCompletion(…​)拦截器方法。

Spring 集成还提供了Wire Tap (opens new window)模式的实现方式。这是一个简单的拦截器,它在不改变现有流的情况下将Message发送到另一个信道。它对于调试和监视非常有用。一个例子如Wire Tap所示。

因为很少需要实现所有的拦截器方法,所以接口提供了 no-op 方法(返回void方法没有代码,Message-返回方法返回Message为-is,而boolean方法返回true)。

拦截器方法的调用顺序取决于信道的类型。
如前所述,基于队列的信道是接收方法首先被拦截的唯一信道,
此外,发送和接收拦截之间的关系取决于单独的发送者和接收者线程的时间安排。
例如,如果接收者在等待消息时已经被阻止,则顺序可以如下:preSendpreReceivepostReceivepostSend但是,
,如果接收方在发送方在该通道上放置了消息并已返回之后进行轮询,则顺序如下:preSendpostSend(some-time-elapses),preReceivepostReceive
在这种情况下经过的时间取决于许多因素,因此通常是不可预测的(实际上,接收可能永远不会发生)。
队列的类型也起到一定的作用(例如,会合与优先级)。,简而言之,
,除了preSendpostSendpreReceivepostReceive之前这一事实外,你不能依赖该顺序。

从 Spring Framework4.1 和 Spring Integration4.1 开始,ChannelInterceptor提供了新的方法:afterSendCompletion()afterReceiveCompletion()。它们是在send()' and 'receive()调用后调用的,而不考虑引发的允许资源清理的任何异常。请注意,通道在ChannelInterceptor列表中以与初始值preSend()preReceive()调用相反的顺序调用这些方法。

从版本 5.1 开始,全局信道拦截器现在应用于动态注册的信道-例如,当使用 爪哇 DSL 时,通过使用beanFactory.initializeBean()IntegrationFlowContext初始化的 bean。以前,在刷新应用程序上下文后创建 bean 时,不会应用拦截器。

此外,从版本 5.1 开始,当没有接收到消息时,将不再调用ChannelInterceptor.postReceive();不再需要检查null``Message<?>。以前,这种方法被称为。如果你的拦截器依赖于前面的行为,那么可以实现afterReceiveCompleted(),因为无论是否接收到消息,该方法都会被调用。

从版本 5.2 开始, Spring 消息传递模块中的ChannelInterceptorAware被弃用,而支持InterceptableChannel,它现在对其进行了扩展,以实现向后兼容。

# MessagingTemplate

Spring 当引入端点及其各种配置选项时,集成为消息传递组件提供了一个基础,该组件允许从消息传递系统非侵入性地调用你的应用程序代码。但是,有时需要从应用程序代码中调用消息传递系统。 Spring 在实现这样的用例时,为了方便起见,集成提供了一个MessagingTemplate,它支持跨消息通道的各种操作,包括请求和应答场景。例如,可以发送请求并等待答复,如下所示:

MessagingTemplate template = new MessagingTemplate();

Message reply = template.sendAndReceive(someChannel, new GenericMessage("test"));

在前面的示例中,模板将在内部创建一个临时匿名通道。模板上也可以设置“sendtimeout”和“receiveTimeout”属性,还支持其他交换类型。下面的清单显示了这些方法的签名:

public boolean send(final MessageChannel channel, final Message<?> message) { ...
}

public Message<?> sendAndReceive(final MessageChannel channel, final Message<?> request) { ...
}

public Message<?> receive(final PollableChannel<?> channel) { ...
}
在[Enter theGatewayProxyFactoryBean](./gateway.html#gateway-proxy)中描述了一种侵入性较小的方法,它允许你调用带有有效负载或头值的简单接口,而不是Message实例。

# 配置消息通道

要创建消息通道实例,可以使用<channel/>元素表示 XML,也可以使用DirectChannel实例表示 爪哇 配置,如下所示:

爪哇

@Bean
public MessageChannel exampleChannel() {
    return new DirectChannel();
}

XML

<int:channel id="exampleChannel"/>

当使用不带任何子元素的<channel/>元素时,它将创建一个DirectChannel实例(aSubscribableChannel)。

要创建发布-订阅通道,请使用<publish-subscribe-channel/>元素(在 爪哇 中是PublishSubscribeChannel),如下所示:

爪哇

@Bean
public MessageChannel exampleChannel() {
    return new PublishSubscribeChannel();
}

XML

<int:publish-subscribe-channel id="exampleChannel"/>

你可以替代地提供各种<queue/>子元素来创建任何可对应信道类型(如消息通道实现中所描述的)。下面的部分展示了每种通道类型的示例。

# DirectChannel配置

如前所述,DirectChannel是默认类型。下面的清单显示了谁来定义一个:

爪哇

@Bean
public MessageChannel directChannel() {
    return new DirectChannel();
}

XML

<int:channel id="directChannel"/>

默认通道具有循环负载均衡器,并且还启用了故障转移(有关更多详细信息,请参见[DirectChannel](#channel-implementations-directchannel))。要禁用其中的一个或两个,请添加<dispatcher/>子元素(LoadBalancingStrategy``DirectChannel的构造函数)并按以下方式配置属性:

爪哇

@Bean
public MessageChannel failFastChannel() {
    DirectChannel channel = new DirectChannel();
    channel.setFailover(false);
    return channel;
}

@Bean
public MessageChannel failFastChannel() {
    return new DirectChannel(null);
}

XML

<int:channel id="failFastChannel">
    <int:dispatcher failover="false"/>
</channel>

<int:channel id="channelWithFixedOrderSequenceFailover">
    <int:dispatcher load-balancer="none"/>
</int:channel>
# 数据类型通道配置

有时,使用者只能处理特定类型的有效负载,这迫使你确保输入消息的有效负载类型。首先想到的可能是使用消息过滤器。然而,消息过滤器所能做的就是过滤掉不符合使用者需求的消息。另一种方法是使用基于内容的路由器,将具有不兼容数据类型的消息路由到特定的转换器,以强制转换和转换到所需的数据类型。这可能行得通,但要实现同样的事情,一种更简单的方法是应用数据类型通道 (opens new window)模式。对于每个特定的有效负载数据类型,可以使用单独的数据类型通道。

要创建只接受包含特定有效负载类型的消息的数据类型通道,请在通道元素的datatype属性中提供数据类型的完全限定类名称,如下例所示:

爪哇

@Bean
public MessageChannel numberChannel() {
    DirectChannel channel = new DirectChannel();
    channel.setDatatypes(Number.class);
    return channel;
}

XML

<int:channel id="numberChannel" datatype="java.lang.Number"/>

请注意,类型检查传递的是可分配给通道数据类型的任何类型。换句话说,前面示例中的numberChannel将接受有效负载为java.lang.Integerjava.lang.Double的消息。可以以逗号分隔的列表的形式提供多个类型,如下例所示:

爪哇

@Bean
public MessageChannel numberChannel() {
    DirectChannel channel = new DirectChannel();
    channel.setDatatypes(String.class, Number.class);
    return channel;
}

XML

<int:channel id="stringOrNumberChannel" datatype="java.lang.String,java.lang.Number"/>

因此,前面示例中的“numberchannel”仅接受数据类型为java.lang.Number的消息。但是,如果消息的有效负载不是所需的类型,会发生什么情况?这取决于你是否定义了一个名为integrationConversionService的 Bean,它是 Spring 的转换服务 (opens new window)的实例。如果不是,则将立即抛出Exception。但是,如果你已经定义了integrationConversionService Bean,那么将使用它来尝试将消息的有效负载转换为可接受类型。

你甚至可以注册自定义转换器。例如,假设你向上面配置的“numberchannel”发送了一条带有String有效负载的消息。你可以按以下方式处理此消息:

MessageChannel inChannel = context.getBean("numberChannel", MessageChannel.class);
inChannel.send(new GenericMessage<String>("5"));

通常情况下,这将是一个完全合法的操作。然而,由于我们使用了数据类型通道,这样的操作的结果将产生类似于以下的异常:

Exception in thread "main" org.springframework.integration.MessageDeliveryException:
Channel 'numberChannel'
expected one of the following datataypes [class java.lang.Number],
but received [class java.lang.String]
…

出现异常是因为我们要求有效负载类型为Number,但是我们发送了String。因此,我们需要将String转换为Number。为此,我们可以实现类似于以下示例的转换器:

public static class StringToIntegerConverter implements Converter<String, Integer> {
    public Integer convert(String source) {
        return Integer.parseInt(source);
    }
}

然后,我们可以将其注册为集成转换服务的转换器,如下例所示:

爪哇

@Bean
@IntegrationConverter
public StringToIntegerConverter strToInt {
    return new StringToIntegerConverter();
}

XML

<int:converter ref="strToInt"/>

<bean id="strToInt" class="org.springframework.integration.util.Demo.StringToIntegerConverter"/>

或者在StringToIntegerConverter类中,当它被标记为用于自动扫描的@Component注释时。

解析“转换器”元素时,如果一个元素尚未定义,它将创建integrationConversionService Bean。有了该转换器,send操作现在就会成功,因为数据类型通道使用该转换器将String有效负载转换为Integer

有关有效载荷类型转换的更多信息,请参见有效载荷类型转换

从版本 4.0 开始,integrationConversionServiceDefaultDatatypeChannelMessageConverter调用,后者在应用程序上下文中查找转换服务。要使用不同的转换技术,可以在通道上指定message-converter属性。这必须是对MessageConverter实现的引用。只使用fromMessage方法。它为转换器提供了对消息头的访问(如果转换可能需要来自消息头的信息,例如content-type)。该方法只能返回转换后的有效载荷或完整的Message对象。如果是后者,转换器必须小心地从入站消息中复制所有的头。

或者,你可以声明一个 ID 为datatypeChannelMessageConverter<bean/>类型的MessageConverter,并且该转换器被所有具有datatype的通道使用。

# QueueChannel配置

要创建QueueChannel,请使用<queue/>子元素。你可以按以下方式指定频道的容量:

爪哇

@Bean
public PollableChannel queueChannel() {
    return new QueueChannel(25);
}

XML

<int:channel id="queueChannel">
    <queue capacity="25"/>
</int:channel>
如果你没有为这个<queue/>子元素上的“capacity”属性提供一个值,则生成的队列是无界的。
为了避免内存耗尽等问题,我们强烈建议你为有界队列设置一个显式的值。
# 持久QueueChannel配置

由于QueueChannel提供了缓冲消息的功能,但在默认情况下仅在内存中进行缓冲,因此它还引入了一种可能性,即在系统故障的情况下,消息可能会丢失。为了减轻这种风险,QueueChannel策略接口的持久实现可以支持MessageGroupStore策略。有关MessageGroupStoreMessageStore的更多详细信息,请参见消息存储

当使用message-store属性时,不允许使用capacity属性。

QueueChannel接收到Message时,它将消息添加到消息存储中。当从QueueChannelMessage进行轮询时,它将从消息存储中删除。

默认情况下,QueueChannel将其消息存储在内存队列中,这可能导致前面提到的消息丢失场景。然而, Spring 集成提供了持久性存储,例如JdbcChannelMessageStore

通过添加message-store属性,可以为任何QueueChannel配置消息存储,如下例所示:

<int:channel id="dbBackedChannel">
    <int:queue message-store="channelStore"/>
</int:channel>

<bean id="channelStore" class="o.s.i.jdbc.store.JdbcChannelMessageStore">
    <property name="dataSource" ref="dataSource"/>
    <property name="channelMessageStoreQueryProvider" ref="queryProvider"/>
</bean>

(关于 爪哇/ Kotlin 配置选项,请参见下面的示例)

Spring 集成 JDBC 模块还为许多流行的数据库提供了模式数据定义语言(DDL)。这些模式位于该模块(spring-integration-jdbc)的 org.springframework.integration.jdbc.store.channel 包中。

一个重要的特性是,对于任何事务持久存储(例如JdbcChannelMessageStore),只要 poller 配置了一个事务,从存储中删除的消息只有在事务成功完成的情况下才能被永久删除,
否则事务将回滚,而Message并没有丢失。

随着越来越多的与“NoSQL”数据存储相关的 Spring 项目开始为这些存储提供底层支持,消息存储的许多其他实现都是可用的。如果找不到满足你特定需求的接口,你还可以提供你自己的MessageGroupStore接口实现。

自版本 4.0 以来,如果可能的话,我们建议将QueueChannel实例配置为使用ChannelMessageStore。与一般的消息存储相比,这些通常针对这种使用进行了优化。如果ChannelMessageStoreChannelPriorityMessageStore,则在优先顺序内以 FIFO 方式接收消息。优先级的概念由消息存储实现确定。例如,下面的示例显示了MongoDB 通道消息存储的 爪哇 配置:

爪哇

@Bean
public BasicMessageGroupStore mongoDbChannelMessageStore(MongoDbFactory mongoDbFactory) {
    MongoDbChannelMessageStore store = new MongoDbChannelMessageStore(mongoDbFactory);
    store.setPriorityEnabled(true);
    return store;
}

@Bean
public PollableChannel priorityQueue(BasicMessageGroupStore mongoDbChannelMessageStore) {
    return new PriorityChannel(new MessageGroupQueue(mongoDbChannelMessageStore, "priorityQueue"));
}

爪哇 DSL

@Bean
public IntegrationFlow priorityFlow(PriorityCapableChannelMessageStore mongoDbChannelMessageStore) {
    return IntegrationFlows.from((Channels c) ->
            c.priority("priorityChannel", mongoDbChannelMessageStore, "priorityGroup"))
            ....
            .get();
}

Kotlin DSL

@Bean
fun priorityFlow(mongoDbChannelMessageStore: PriorityCapableChannelMessageStore) =
    integrationFlow {
        channel { priority("priorityChannel", mongoDbChannelMessageStore, "priorityGroup") }
    }
注意MessageGroupQueueclass.
这是一个BlockingQueue实现来使用MessageGroupStore的操作。

定制QueueChannel环境的另一个选项是由<int:queue>子元素的ref属性或其特定的构造函数提供的。此属性提供对任何java.util.Queue实现的引用。例如,分布式的 Hazelcast[IQueue](https://hazelcast.com/use-cases/imdg/imdg-messaging/)可以配置如下:

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance(new Config()
                                           .setProperty("hazelcast.logging.type", "log4j"));
}

@Bean
public PollableChannel distributedQueue() {
    return new QueueChannel(hazelcastInstance()
                              .getQueue("springIntegrationQueue"));
}
# PublishSubscribeChannel配置

要创建PublishSubscribeChannel,请使用 <publish-subscribe-channel/>元素。当使用这个元素时,你还可以指定用于发布消息的task-executor(如果没有指定消息,它将在发送方的线程中发布),如下所示:

爪哇

@Bean
public MessageChannel pubsubChannel() {
    return new PublishSubscribeChannel(someExecutor());
}

XML

<int:publish-subscribe-channel id="pubsubChannel" task-executor="someExecutor"/>

如果在PublishSubscribeChannel的下游提供一个重序列器或聚合器,则可以将通道上的’apply-sequence’属性设置为true。这样做表明通道在传递消息之前应该设置sequence-sizesequence-number消息头以及相关 ID。例如,如果有五个订阅服务器,sequence-size将被设置为5,并且消息将具有sequence-number标头值,范围从15

除了Executor之外,还可以配置ErrorHandler。默认情况下,PublishSubscribeChannel使用MessagePublishingErrorHandler实现从errorChannel头发送一个错误到MessageChannel或全局errorChannel实例。如果不配置Executor,则忽略ErrorHandler,并将异常直接抛出到调用者的线程。

如果在PublishSubscribeChannel的下游提供ResequencerAggregator,则可以将通道上的’apply-sequence’属性设置为true。这样做表明,在传递消息之前,通道应该设置序列大小和序列号消息头以及相关 ID。例如,如果有五个订阅服务器,序列大小将设置为5,并且消息将具有从15的序列号标头值。

下面的示例展示了如何将apply-sequence标头设置为true:

爪哇

@Bean
public MessageChannel pubsubChannel() {
    PublishSubscribeChannel channel = new PublishSubscribeChannel();
    channel.setApplySequence(false);
    return channel;
}

XML

<int:publish-subscribe-channel id="pubsubChannel" apply-sequence="true"/>
默认情况下,apply-sequence值是false,这样,发布-订阅通道就可以向多个出站通道发送完全相同的消息实例。,
自 Spring 集成以来,当标记设置为true时,强制执行有效负载和头引用的不可变性,该通道创建新的Message实例,其有效负载引用相同,但标头值不同。

从版本 5.4.3 开始,PublishSubscribeChannel还可以配置其requireSubscribers选项的requireSubscribers,以指示此通道在没有订阅服务器时不会静默忽略消息。当没有订阅者时,将抛出带有MessageDispatchingException消息的Dispatcher has no subscribers消息,并将此选项设置为true

# ExecutorChannel

要创建ExecutorChannel,请添加带有task-executor属性的<dispatcher>子元素。该属性的值可以引用上下文中的任何TaskExecutor。例如,这样做可以配置线程池,用于将消息分配给订阅的处理程序。如前所述,这样做会破坏发送方和接收方之间的单线程执行上下文,从而处理程序的调用不会共享任何活动事务上下文(即,处理程序可能抛出Exception,但send调用已成功返回)。下面的示例展示了如何使用dispatcher元素并在task-executor属性中指定一个执行器:

爪哇

@Bean
public MessageChannel executorChannel() {
    return new ExecutorChannel(someExecutor());
}

XML

<int:channel id="executorChannel">
    <int:dispatcher task-executor="someExecutor"/>
</int:channel>
load-balancerfailover选项在 <dispatcher/>子元素上也是可用的,如前面在[DirectChannel配置](#channel-configuration-directchannel)中所述。
同样的默认值也适用,因此,
,通道具有循环负载平衡策略,启用了故障转移,除非为其中一个或两个属性提供了显式配置,如以下示例所示:

<br/><int:channel id="executorChannelWithoutFailover"><br/> <int:dispatcher task-executor="someExecutor" failover="false"/><br/></int:channel><br/>
# PriorityChannel配置

要创建PriorityChannel,请使用<priority-queue/>子元素,如下例所示:

爪哇

@Bean
public PollableChannel priorityChannel() {
    return new PriorityChannel(20);
}

XML

<int:channel id="priorityChannel">
    <int:priority-queue capacity="20"/>
</int:channel>

默认情况下,通道查询消息的priority头。但是,你可以提供一个自定义的Comparator引用。另外,请注意PriorityChannel(与其他类型一样)确实支持datatype属性。与QueueChannel一样,它也支持capacity属性。下面的示例演示了所有这些:

Java

@Bean
public PollableChannel priorityChannel() {
    PriorityChannel channel = new PriorityChannel(20, widgetComparator());
    channel.setDatatypes(example.Widget.class);
    return channel;
}

XML

<int:channel id="priorityChannel" datatype="example.Widget">
    <int:priority-queue comparator="widgetComparator"
                    capacity="10"/>
</int:channel>

自版本 4.0 以来,priority-channel子元素支持message-store选项(在这种情况下不允许comparatorcapacity)。消息存储必须是PriorityCapableChannelMessageStorePriorityCapableChannelMessageStore的实现方式目前提供给RedisJDBCMongoDB。有关更多信息,请参见[QueueChannelConfiguration]和消息存储。你可以在支持消息通道中找到示例配置。

# RendezvousChannel配置

当 queue 子元素是<rendezvous-queue>时,将创建RendezvousChannel。它没有为前面描述的那些提供任何额外的配置选项,并且它的队列不接受任何容量值,因为它是一个零容量直接切换队列。下面的示例展示了如何声明RendezvousChannel:

Java

@Bean
public PollableChannel rendezvousChannel() {
    return new RendezvousChannel();
}

XML

<int:channel id="rendezvousChannel"/>
    <int:rendezvous-queue/>
</int:channel>
# 作用域信道配置

任何通道都可以配置scope属性,如下例所示:

<int:channel id="threadLocalChannel" scope="thread"/>
# 信道拦截器配置

消息通道也可以具有拦截器,如信道拦截器中所述。可以将<interceptors/>子元素添加到<channel/>(或更具体的元素类型)中。你可以提供ref属性来引用实现ChannelInterceptor接口的任何 Spring 托管对象,如下例所示:

<int:channel id="exampleChannel">
    <int:interceptors>
        <ref bean="trafficMonitoringInterceptor"/>
    </int:interceptors>
</int:channel>

通常,我们建议在单独的位置定义拦截器实现,因为它们通常提供可以跨多个通道重用的公共行为。

# 全局信道拦截器配置

通道拦截器为每个通道应用横切行为提供了一种简洁的方法。如果应该在多个信道上应用相同的行为,那么为每个信道配置相同的拦截器集合将不是最有效的方法。 Spring 为了避免重复配置,同时也使拦截器能够应用于多个信道,集成提供了全局拦截器。考虑以下两个例子:

<int:channel-interceptor pattern="input*, thing2*, thing1, !cat*" order="3">
    <bean class="thing1.thing2SampleInterceptor"/>
</int:channel-interceptor>
<int:channel-interceptor ref="myInterceptor" pattern="input*, thing2*, thing1, !cat*" order="3"/>

<bean id="myInterceptor" class="thing1.thing2SampleInterceptor"/>

每个<channel-interceptor/>元素都允许你定义一个全局拦截器,它应用于所有与pattern属性定义的任何模式匹配的通道上。在前一种情况下,全局拦截器应用于“Thing1”通道和所有其他以“Thing2”或“Input”开头的通道,但不应用于以“Thing3”开头的通道(自版本 5.0 以来)。

将此语法添加到模式中会导致一个可能的(尽管可能不太可能)问题,
如果你有一个名为!thing1的 Bean 模式,并且你在通道拦截器的!thing1模式中包含了一个pattern模式,它不再匹配。
模式现在匹配所有未命名thing1的 bean。
在这种情况下,你可以在带有\的模式中转义!
模式\!thing1匹配名为!thing1的 Bean。

Order 属性允许你在给定信道上有多个拦截器时管理此拦截器被注入的位置。例如,通道“InputChannel”可以在本地配置单独的拦截器(见下文),如下例所示:

<int:channel id="inputChannel">
  <int:interceptors>
    <int:wire-tap channel="logger"/>
  </int:interceptors>
</int:channel>

一个合理的问题是“相对于本地配置的其他拦截器或通过其他全球拦截器定义配置的其他拦截器,如何注入一个全球拦截器?”当前的实现提供了一种定义拦截器执行顺序的简单机制。order属性中的正数确保在任何现有拦截器之后注入拦截器,而负数确保在现有拦截器之前注入拦截器。这意味着,在前面的示例中,全局拦截器是在本地配置的’wire-tap’拦截器之后注入的(因为其order大于0)。如果存在另一个匹配pattern的全局拦截器,其顺序将通过比较两个拦截器的order属性的值来确定。要在现有拦截器之前注入一个全局拦截器,请使用order属性的负值。

注意,orderpattern属性都是可选的。
order的默认值将为 0,而pattern的默认值为’*’(以匹配所有通道)。
# 丝锥

正如前面提到的, Spring 集成提供了一种简单的线分接拦截器。你可以在<interceptors/>元素内的任何通道上配置线控分接。这样做对于调试特别有用,并且可以与 Spring Integration 的日志通道适配器结合使用,如下所示:

<int:channel id="in">
    <int:interceptors>
        <int:wire-tap channel="logger"/>
    </int:interceptors>
</int:channel>

<int:logging-channel-adapter id="logger" level="DEBUG"/>
“logging-channel-adapter”还接受一个“expression”属性,这样你就可以根据“payload”和“headers”变量计算 SPEL 表达式。,
或者,要记录完整的消息toString()结果,请为“log-full-message”属性提供一个true的值,默认情况下,
,它是false,这样只记录有效负载。
将其设置为true,可以记录除有效负载之外的所有头。
“表达式”选项提供了最大的灵活性(例如,expression="payload.user.name")。

关于线导和其他类似组件(消息发布配置)的一个常见误解是,它们本质上是自动异步的。默认情况下,线接作为一个组件不会被异步调用。 Spring 相反,集成关注于配置异步行为的单一统一方法:消息通道。使消息流的某些部分同步或异步的是在该流中配置的消息通道的类型。这是消息通道抽象的主要好处之一。从框架的一开始,我们就一直强调消息通道作为框架的一流公民的需求和价值。它不只是 EIP 模式的内在的、隐式的实现。它作为可配置组件完全公开给最终用户。因此,线抽头组件只负责执行以下任务:

  • 通过点击一个通道(例如channelA)来拦截消息流。

  • 抓住每条消息

  • 将消息发送到另一个通道(例如,channelB

它本质上是桥模式的一种变体,但它被封装在一个通道定义中(因此更容易启用和禁用,而不会破坏流)。此外,与 Bridge 不同的是,它基本上是分叉另一个消息流。这个流是同步的还是异步的?答案取决于“ChannelB”是什么类型的消息通道。我们有以下几种选择:直接通道、可检索通道和执行器通道。后两种方法打破了线程边界,使得在这些通道上的通信是异步的,因为将消息从该通道发送到其订阅的处理程序的任务发生在不同的线程上,而不是用于将消息发送到该通道的线程上。这就是什么将使你的线接流同步或异步。它与框架中的其他组件(例如 Message Publisher)保持一致,并通过避免你提前担心(除了编写线程安全代码)特定代码块应该实现为同步还是异步,从而增加了一定程度的一致性和简单性。两段代码(例如,组件 A 和组件 B)在消息通道上的实际连接使它们的协作是同步的或异步的。将来,你甚至可能想要从同步转换为异步,而 Message Channel 允许你在不接触代码的情况下快速地执行此操作。

关于线接的最后一点是,尽管上面提供了默认情况下不是异步的理由,但你应该记住,通常希望尽快传递消息。因此,使用异步通道选项作为线控分路器的出站通道将是非常常见的。然而,在默认情况下,我们并不强制执行异步行为。如果我们这样做的话,有许多用例将会被打破,包括你可能不希望打破事务边界。也许你出于审计目的而使用了线接模式,并且你确实希望在原始事务中发送审计消息。例如,你可以将线接连接到一个 JMS 出站通道适配器。这样,你就能两全其美:1)JMS 消息的发送可能发生在事务中,而 2)它仍然是一个“触发并忘记”操作,从而防止主消息流中出现任何明显的延迟。

从 4.0 版本开始,当拦截器(例如[WireTap类](https://DOCS. Spring.io/autorepo/DOCS/ Spring-integration/current/api/org/springframework/integration/channel/interceptor/wiretap.html)引用信道时,避免循环引用是很重要的。
你需要从当前拦截器拦截的信道中排除此类信道。
如果你有自定义的
,可以使用适当的模式或编程地完成此操作。如果你有一个自定义的<gt=”r= 参考channel,考虑实现VetoCapableInterceptor,这样,框架会询问拦截器是否可以拦截每个候选信道,基于提供的模式。
你还可以在拦截器方法中添加运行时保护,以确保信道不是拦截器引用的信道。
WireTap使用了这两种技术。

从版本 4.3 开始,WireTap有额外的构造函数,它们接受channelName而不是MessageChannel实例。这对于 Java 配置和使用通道自动创建逻辑时都很方便。目标MessageChannel Bean 是从提供的channelName以后在与拦截器的第一次交互中解析出来的。

通道解析需要BeanFactory,因此有线分接实例必须是 Spring 管理的 Bean。

这种后期绑定方法还允许使用 Java DSL 配置简化典型的接线模式,如下例所示:

@Bean
public PollableChannel myChannel() {
    return MessageChannels.queue()
            .wireTap("loggingFlow.input")
            .get();
}

@Bean
public IntegrationFlow loggingFlow() {
    return f -> f.log();
}
# 条件式电线分接

通过使用selectorselector-expression属性,可以使电线分接成为有条件的。selector引用了MessageSelector Bean,这可以在运行时确定消息是否应该转到 TAP 通道。类似地,selector-expression是一个执行相同目的的布尔 SPEL 表达式:如果表达式的计算结果为true,则消息将被发送到 TAP 通道。

# 全局线接接头配置

作为全局信道拦截器配置的特殊情况,可以配置全局线接。为此,配置一个顶级wire-tap元素。现在,除了正常的wire-tap名称空间支持外,patternorder属性也得到了支持,并且它们的工作方式与channel-interceptor完全相同。下面的示例展示了如何配置全局线接:

Java

@Bean
@GlobalChannelInterceptor(patterns = "input*,thing2*,thing1", order = 3)
public WireTap wireTap(MessageChannel wiretapChannel) {
    return new WireTap(wiretapChannel);
}

XML

<int:wire-tap pattern="input*, thing2*, thing1" order="3" channel="wiretapChannel"/>
全局线接提供了一种方便的方式,可以在不修改现有通道配置的情况下,在外部配置单通道线接。
要这样做,请将pattern属性设置为目标通道名。
例如,你可以使用此技术来配置测试用例,以验证通道上的消息。

# 特殊频道

默认情况下,在应用程序上下文中定义了两个特殊通道:errorChannelnullChannel。“nullchannel”(NullChannel的实例)的作用类似于/dev/null,记录在DEBUG级别发送到它的任何消息并立即返回。对org.reactivestreams.Publisher发送的消息的有效负载应用了特殊处理:它在此信道中被立即订阅,以启动反应流处理,尽管数据被丢弃。从反应流处理中抛出的错误(参见Subscriber.onError(Throwable))将记录在警告级别下,以进行可能的调查。如果需要对这样的错误做任何事情,则[ReactiveRequestHandlerAdvice](./handler-advice.html#reactive-advice)具有Mono.doOnError()自定义的消息处理程序可以应用于产生Mono的消息处理程序,对此nullChannel进行回复。当你遇到不关心的通道解析错误时,你可以将受影响组件的output-channel属性设置为“nullchannel”(名称“nullchannel”在应用程序上下文中保留)。

“errorchannel”在内部用于发送错误消息,并且可能会被自定义配置覆盖。这在错误处理中有更详细的讨论。

有关消息通道和拦截器的更多信息,请参见 Java DSL 章节中的消息通道

# poller

本节描述了 Spring 集成中轮询的工作方式。

# 轮询消费者

当消息端点(通道适配器)连接到通道并进行实例化时,它们会产生以下实例之一:

  • [PollingConsumer](https://DOCS. Spring.io/ Spring-integration/api/org/springframework/integration/endpoint/pollingconsumer.html)

  • [EventDrivenConsumer](https://DOCS. Spring.io/ Spring-integration/api/org/springframework/integration/endpoint/eventdrivenconsumer.html)

实际的实现取决于这些端点连接到的通道类型。与实现[org.springframework.messaging.SubscribableChannel](https://DOCS. Spring.io/ Spring/DOCS/current/javadoc-api/index.html?org/springframework/messing/subscribablechannel.html)接口的通道适配器产生EventDrivenConsumer的实例。另一方面,与实现了[org.springframework.messaging.PollableChannel](https://DOCS. Spring.io/ Spring/DOCS/current/javadoc-api/index.html?org/springframework/messaging/pollablechannel.html)接口的通道适配器(例如QueueChannel)产生了PollingConsumer的实例。

轮询消费者让 Spring 集成组件主动轮询消息,而不是以事件驱动的方式处理消息。

在许多消息传递场景中,它们代表了一个关键的交叉问题。在 Spring 集成中,轮询消费者是基于具有相同名称的模式,这在 Gregor Hohpe 和 Bobby Woolf 的书Enterprise 整合模式中进行了描述。你可以在Book 的网站 (opens new window)上找到模式的描述。

# 可选消息源

Spring 集成提供了轮询消费者模式的第二种变化。当使用入站通道适配器时,这些适配器通常用SourcePollingChannelAdapter包装。例如,当从远程 FTP 服务器位置检索消息时,FTP 入站通道适配器中描述的适配器配置了一个 poller,以定期检索消息。因此,当组件配置为 Poller 时,生成的实例属于以下类型之一:

  • [PollingConsumer](https://DOCS. Spring.io/ Spring-integration/api/org/springframework/integration/endpoint/pollingconsumer.html)

  • [SourcePollingChannelAdapter](https://DOCS. Spring.io/ Spring-integration/api/org/springframework/integration/endpoint/sourcepollingchanneladapter.html)

这意味着 Poller 在入站和出站消息传递场景中都会使用。以下是使用 Poller 的一些用例:

  • 轮询某些外部系统,例如 FTP 服务器、数据库和 Web 服务

  • 轮询内部(可匹配)消息通道

  • 轮询内部服务(例如在 Java 类上重复执行方法)

AOP 建议类可以应用于 Pollers,在advice-chain中,例如事务通知来启动事务。,
从版本 4.1 开始,提供了PollSkipAdvice
投票者使用触发器来确定下一次投票的时间。
PollSkipAdvice可以用来抑制(跳过)投票,这可能是因为存在一些下游条件,这将阻止消息被处理。
使用此建议,你必须为它提供一个PollSkipStrategy的实现。
从版本 4.2.5 开始,提供了一个SimplePollSkipStrategy
要使用它,你可以将一个实例作为 Bean 添加到应用程序上下文中,将其注入到PollSkipAdvice中,并将其添加到 Poller 的建议链中。
要跳过轮询,请调用skipPolls()
恢复轮询,请调用reset()
4.2 版本在该区域增加了更多的灵活性。
参见消息源的条件 Poller

本章仅对轮询消费者以及他们如何适应消息通道(参见消息通道)和通道适配器(参见通道适配器)的概念进行了高级概述。有关一般消息传递端点和特别是轮询消费者的更多信息,请参见消息端点

# 延迟确认可收集消息源

从版本 5.0.1 开始,某些模块提供MessageSource实现,支持延迟确认,直到下游流完成(或将消息传递给另一个线程)。这目前仅限于AmqpMessageSourceKafkaMessageSource

有了这些消息源,IntegrationMessageHeaderAccessor.ACKNOWLEDGMENT_CALLBACK报头(参见[MessageHeaderAccessorapi](./message.html#message-header-accessor))被添加到消息中。当与可收集的消息源一起使用时,头的值是AcknowledgmentCallback的实例,如下例所示:

@FunctionalInterface
public interface AcknowledgmentCallback {

    void acknowledge(Status status);

    boolean isAcknowledged();

    void noAutoAck();

    default boolean isAutoAck();

    enum Status {

        /**
         * Mark the message as accepted.
         */
        ACCEPT,

        /**
         * Mark the message as rejected.
         */
        REJECT,

        /**
         * Reject the message and requeue so that it will be redelivered.
         */
        REQUEUE

    }

}

并非所有消息源(例如,aKafkaMessageSource)都支持REJECT状态。其处理方法与ACCEPT相同。

应用程序可以随时确认消息,如下例所示:

Message<?> received = source.receive();

...

StaticMessageHeaderAccessor.getAcknowledgmentCallback(received)
        .acknowledge(Status.ACCEPT);

如果MessageSource被连接到SourcePollingChannelAdapter,那么当下游流程完成后,Poller 线程返回适配器时,适配器将检查确认是否已经被确认,如果没有,将其状态设置为ACCEPTit(如果流抛出异常,则设置REJECT)。状态值是在[AcknowledgmentCallback.Status枚举](https://DOCS. Spring.io/ Spring-integration/api/org/springframework/integration/support/concredgmentcallback.status.html)中定义的。

Spring 集成提供了MessageSourcePollingTemplate来执行对MessageSource的临时轮询。这也需要在MessageHandler回调返回(或抛出异常)时在AcknowledgmentCallback上设置ACCEPTREJECT。下面的示例展示了如何使用MessageSourcePollingTemplate进行轮询:

MessageSourcePollingTemplate template =
    new MessageSourcePollingTemplate(this.source);
template.poll(h -> {
    ...
});

在这两种情况下(SourcePollingChannelAdapterMessageSourcePollingTemplate),都可以通过在回调中调用noAutoAck()来禁用 auto ack/nack。如果你将消息传递给另一个线程并希望稍后确认,那么你可能会这样做。并不是所有的实现都支持这一点(例如,Apache Kafka 不支持这一点,因为偏移提交必须在同一个线程上执行)。

# 消息源的条件 Pollers

本节介绍如何使用条件 Pollers。

# 背景

Advice对象,在 poller 上的advice-chain中,为整个轮询任务(消息检索和处理)提供建议。这些“周围建议”方法无法访问投票的任何上下文——只有投票本身。这对于需求很好,比如执行事务任务或由于某些外部条件而跳过轮询,正如前面讨论的那样。如果我们希望根据轮询的receive部分的结果采取某些操作,或者如果我们希望根据条件调整 Poller,该怎么办?在这些情况下, Spring 集成提供了“智能”轮询。

# “智能”民调

5.3 版引入了ReceiveMessageAdvice接口。(在MessageSourceMutator中,AbstractMessageSourceAdvice已被弃用,而支持default方法。)在advice-chain中实现此接口的任何Advice对象仅应用于接收操作-MessageSource.receive()PollableChannel.receive(timeout)。因此,它们只能应用于SourcePollingChannelAdapterPollingConsumer。这样的类实现了以下方法:

  • beforeReceive(Object source)Object.receive()方法之前调用该方法。它允许你检查和重新配置源代码。返回false将取消此轮询(类似于前面提到的PollSkipAdvice)。

  • Message<?> afterReceive(Message<?> result, Object source)该方法是在receive()方法之后调用的。同样,你可以重新配置源代码或采取任何操作(可能取决于结果,如果源代码没有创建消息,结果可能是null)。你甚至可以返回一条不同的消息。

线程安全

如果一个建议会使结果发生变异,那么你不应该使用TaskExecutor来配置 poller。
如果一个建议会使源发生变异,那么这种变异就不是线程安全的,可能会导致意外的结果,特别是对于高频的 poller,
如果你需要同时处理轮询结果,考虑使用下游ExecutorChannel,而不是向 poller 添加执行器。
建议链排序

你应该了解在初始化期间如何处理建议链,Advice不实现ReceiveMessageAdvice的对象将应用于整个轮询过程,并且所有这些对象都将首先被调用,在任何ReceiveMessageAdvice.
之前,ReceiveMessageAdvice对象是按照围绕源receive()方法的顺序被调用的。
如果你有,例如,Advice对象a, b, c, d,其中bd是,则这些对象也按照以下顺序应用:a, c, b, d。如果源已经是Proxy,则在任何现有的Advice对象之后调用ReceiveMessageAdvice
如果你希望更改顺序,则必须自己连接代理。
# SimpleActiveIdleReceiveMessageAdvice

(以前的SimpleActiveIdleMessageSourceAdvice仅用于MessageSource已不推荐。)此建议是ReceiveMessageAdvice的一个简单实现。当与DynamicPeriodicTrigger结合使用时,它会调整轮询频率,这取决于上一次轮询是否导致了消息。Poller 还必须具有对相同DynamicPeriodicTrigger的引用。

重要提示:异步切换

SimpleActiveIdleReceiveMessageAdvice基于receive()结果修改触发器。
只有在 poller 线程上调用通知时,此操作才有效。
它不工作如果 poller 有task-executor.
来使用此建议,其中你希望在轮询结果之后使用异步操作,请稍后进行异步切换,也许可以使用ExecutorChannel
# CompoundTriggerAdvice

此建议允许根据投票是否返回消息来选择两个触发器中的一个。考虑一个使用CronTrigger的 poller。CronTrigger实例是不可变的,因此一旦构造它们,就不能对它们进行更改。考虑一个用例,我们希望使用 CRON 表达式每小时触发一次轮询,但是如果没有收到消息,则每分钟轮询一次,并且在检索到消息时,恢复为使用 CRON 表达式。

建议(和 Poller)为此目的使用CompoundTrigger。触发器的primary触发器可以是CronTrigger。当通知检测到没有收到消息时,它会将辅助触发器添加到CompoundTrigger。当CompoundTrigger实例的nextExecutionTime方法被调用时,如果存在,它将委托给辅助触发器。否则,它将委托给主触发器。

Poller 还必须具有对相同CompoundTrigger的引用。

下面的示例显示了每小时 CRON 表达式的配置,并将其退回到每分钟:

<int:inbound-channel-adapter channel="nullChannel" auto-startup="false">
    <bean class="org.springframework.integration.endpoint.PollerAdviceTests.Source" />
    <int:poller trigger="compoundTrigger">
        <int:advice-chain>
            <bean class="org.springframework.integration.aop.CompoundTriggerAdvice">
                <constructor-arg ref="compoundTrigger"/>
                <constructor-arg ref="secondary"/>
            </bean>
        </int:advice-chain>
    </int:poller>
</int:inbound-channel-adapter>

<bean id="compoundTrigger" class="org.springframework.integration.util.CompoundTrigger">
    <constructor-arg ref="primary" />
</bean>

<bean id="primary" class="org.springframework.scheduling.support.CronTrigger">
    <constructor-arg value="0 0 * * * *" /> <!-- top of every hour -->
</bean>

<bean id="secondary" class="org.springframework.scheduling.support.PeriodicTrigger">
    <constructor-arg value="60000" />
</bean>
重要提示:异步切换

CompoundTriggerAdvice基于receive()结果修改触发器。
只有在 poller 线程上调用通知时,此操作才有效。
它不工作如果 poller 有task-executor
使用此建议,其中你希望在轮询结果之后使用异步操作,请稍后进行异步切换,也许可以使用ExecutorChannel
# MessageSource-仅限建议

有些建议可能只适用于MessageSource.receive(),而对于PollableChannel则没有意义。为此,仍然存在MessageSourceMutator接口(ReceiveMessageAdvice的扩展)。对于default方法,它完全替换了已经废弃的AbstractMessageSourceAdvice方法,并且应该在只期望MessageSource代理的实现中使用。有关更多信息,请参见入站通道适配器:轮询多个服务器和目录

# 通道适配器

通道适配器是一个消息端点,它允许将单个发送方或接收方连接到消息通道。 Spring 集成提供了许多适配器以支持各种传输,例如 JMS、文件、HTTP、Web 服务、邮件等。本参考指南的下几章将讨论每个适配器。然而,这一章的重点是简单但灵活的方法-调用通道适配器支持。这里既有入站适配器,也有出站适配器,每个适配器都可以配置为使用核心名称空间中提供的 XML 元素。这些提供了一种扩展 Spring 集成的简单方法,只要你有一个可以作为源或目标调用的方法。

# 配置入站通道适配器

一个inbound-channel-adapter元素(在 Java 配置中是SourcePollingChannelAdapter)可以在 Spring 管理的对象上调用任何方法,并在将方法的输出转换为Message之后,将一个非空返回值发送到MessageChannel。当适配器的订阅被激活时,Poller 尝试从源接收消息。根据提供的配置,用TaskScheduler调度 Poller。要为单个通道适配器配置轮询间隔或 CRON 表达式,可以提供具有调度属性之一的“poller”元素,例如“fixed-rate”或“CRON”。下面的示例定义了两个inbound-channel-adapter实例:

Java DSL

@Bean
public IntegrationFlow source1() {
    return IntegrationFlows.from(() -> new GenericMessage<>(...),
                             e -> e.poller(p -> p.fixedRate(5000)))
                ...
                .get();
}

@Bean
public IntegrationFlow source2() {
    return IntegrationFlows.from(() -> new GenericMessage<>(...),
                             e -> e.poller(p -> p.cron("30 * 9-17 * * MON-FRI")))
                ...
                .get();
}

Java

public class SourceService {

    @InboundChannelAdapter(channel = "channel1", poller = @Poller(fixedRate = "5000"))
    Object method1() {
        ...
    }

    @InboundChannelAdapter(channel = "channel2", poller = @Poller(cron = "30 * 9-17 * * MON-FRI"))
    Object method2() {
        ...
    }
}

Kotlin DSL

@Bean
fun messageSourceFlow() =
    integrationFlow( { GenericMessage<>(...) },
                    { poller { it.fixedRate(5000) } }) {
        ...
    }

XML

<int:inbound-channel-adapter ref="source1" method="method1" channel="channel1">
    <int:poller fixed-rate="5000"/>
</int:inbound-channel-adapter>

<int:inbound-channel-adapter ref="source2" method="method2" channel="channel2">
    <int:poller cron="30 * 9-17 * * MON-FRI"/>
</int:channel-adapter>

另见通道适配器表达式和脚本

如果没有提供 Poller,则必须在上下文中注册一个默认 Poller。
有关更多详细信息,请参见端点命名空间支持
重要:poller 配置

所有inbound-channel-adapter类型都支持SourcePollingChannelAdapter,这意味着它们包含一个 poller 配置,该配置轮询MessageSource(以调用产生该值的自定义方法)这将成为基于 poller 中指定的配置的Message有效负载)。
下面的示例显示了两个 poller 的配置:


在第一个配置中,轮询任务每轮询一次被调用,并且在每个任务(轮询)期间,根据max-messages-per-poll属性值调用该方法(该方法将产生消息)一次,
在第二个配置中,轮询任务将在每个轮询中调用 10 次,或者直到它返回’null’为止,因此,在每次轮询以一秒的间隔进行时,每次轮询可能会产生 10 条消息。
但是,如果配置看起来像以下示例,会发生什么情况:

<br/><int:poller fixed-rate="1000"/><br/>
请注意,没有max-messages-per-poll指定。
,我们将在后面介绍,在PollingConsumer(例如,service-activatorfilterrouter,以及其他)中,相同的 poller 配置将对-1max-messages-per-poll具有默认值,这意味着“不停地执行轮询任务,除非轮询方法返回 null(可能是因为QueueChannel中没有更多的消息)”,然后睡眠一秒。,

但是,在SourcePollingChannelAdapter中,有点不同。
max-messages-per-poll的默认值是1,除非你显式地将其设置为负值(例如-1)。
这可以确保 poller 可以对生命周期事件(例如开始和停止)做出反应,并防止它可能在无限循环中旋转如果MessageSource的自定义方法的实现可能永远不会返回 null,并且碰巧是不可中断的。

但是,如果你确信你的方法可以返回 null,并且你需要对每个轮询中可用的尽可能多的源进行轮询,你应该显式地将max-messages-per-poll设置为负值,如下例所示:

<br/><int:poller max-messages-per-poll="-1" fixed-rate="1000"/><br/>
从版本 5.5 开始,
0值具有特殊的含义-完全跳过MessageSource.receive()调用,这可能被认为是对此入站通道适配器的暂停,直到maxMessagesPerPoll在稍后的时间被更改为非零值,例如通过控制总线。

还请参见全局默认 Poller以获取更多信息。

# 配置出站通道适配器

一个outbound-channel-adapter元素(用于 Java 配置的@ServiceActivator)也可以将MessageChannel连接到任何 POJO 使用者方法,该方法应该使用发送到该通道的消息的有效负载来调用。下面的示例展示了如何定义出站通道适配器:

Java DSL

@Bean
public IntegrationFlow outboundChannelAdapterFlow(MyPojo myPojo) {
    return f -> f
             .handle(myPojo, "handle");
}

Java

public class MyPojo {

    @ServiceActivator(channel = "channel1")
    void handle(Object payload) {
        ...
    }

}

Kotlin DSL

@Bean
fun outboundChannelAdapterFlow(myPojo: MyPojo) =
    integrationFlow {
        handle(myPojo, "handle")
    }

XML

<int:outbound-channel-adapter channel="channel1" ref="target" method="handle"/>

<beans:bean id="target" class="org.MyPojo"/>

如果要调整的通道是PollableChannel,则必须提供一个 poller 子元素(@Poller上的@Poller子注释),如下例所示:

Java

public class MyPojo {

    @ServiceActivator(channel = "channel1", poller = @Poller(fixedRate = "3000"))
    void handle(Object payload) {
        ...
    }

}

XML

<int:outbound-channel-adapter channel="channel2" ref="target" method="handle">
    <int:poller fixed-rate="3000" />
</int:outbound-channel-adapter>

<beans:bean id="target" class="org.MyPojo"/>

如果 POJO 使用者实现可以在其他<outbound-channel-adapter>定义中重用,则应该使用ref属性。然而,如果消费者实现仅由<outbound-channel-adapter>的单个定义引用,则可以将其定义为内部 Bean,如下例所示:

<int:outbound-channel-adapter channel="channel" method="handle">
    <beans:bean class="org.Foo"/>
</int:outbound-channel-adapter>
不允许在同一个<outbound-channel-adapter>配置中同时使用ref属性和内部处理程序定义,因为它会创建一个不明确的条件。
这样的配置会导致引发异常。

可以在没有channel引用的情况下创建任何通道适配器,在这种情况下,它会隐式地创建DirectChannel的实例。创建的通道名称与<inbound-channel-adapter><outbound-channel-adapter>元素的id属性匹配。因此,如果不提供channel,则需要id

# 通道适配器表达式和脚本

与许多其他 Spring 集成组件一样,<inbound-channel-adapter><outbound-channel-adapter>也提供了对 SPEL 表达式求值的支持。要使用 SPEL,在“expression”属性中提供表达式字符串,而不是提供用于 Bean 上的方法调用的“ref”和“method”属性。当计算一个表达式时,它遵循与方法调用相同的契约,其中:当计算结果为非空值时,<inbound-channel-adapter>的表达式会生成消息,而<outbound-channel-adapter>的表达式必须等同于无效返回方法调用。

从 Spring Integration3.0 开始,<int:inbound-channel-adapter/>还可以配置一个 SPEL<expression/>(甚至还可以配置一个<script/>)子元素,用于在需要比使用简单的’expression’属性更复杂的操作时。如果通过使用location属性以Resource的形式提供脚本,还可以设置refresh-check-delay,这允许定期刷新资源。如果你希望在每个投票中检查该脚本,则需要将此设置与 Poller 的触发器进行协调,如下例所示:

<int:inbound-channel-adapter ref="source1" method="method1" channel="channel1">
    <int:poller max-messages-per-poll="1" fixed-delay="5000"/>
    <script:script lang="ruby" location="Foo.rb" refresh-check-delay="5000"/>
</int:inbound-channel-adapter>

另请参阅cacheSeconds子元素时ReloadableResourceBundleExpressionSource上的cacheSeconds属性。有关表达式的更多信息,请参见Spring Expression Language (SpEL)。有关脚本,请参见Groovy 支持脚本支持

<int:inbound-channel-adapter/>SourcePollingChannelAdapter)是一个端点,它通过周期性地触发轮询某个底层MessageSource来启动消息流,
,因为在轮询时,没有消息对象,表达式和脚本无法访问根Message,因此,在大多数其他消息传递 SPEL 表达式中没有可用的有效负载或 headers 属性。
该脚本可以生成并返回一个完整的Message对象,该对象带有 headers 和 payload,或者只有一个 payload,它由框架添加到带有基本 headers 的消息中。

# 消息传递桥

消息传递桥是连接两个消息通道或通道适配器的相对简单的端点。例如,你可能希望将PollableChannel连接到SubscribableChannel,以便订阅端点不必担心任何轮询配置。相反,消息传递桥接会提供轮询配置。

通过在两个通道之间提供中介 Poller,你可以使用消息传递桥来限制入站消息。Poller 的触发器确定消息到达第二个通道的速率,Poller 的maxMessagesPerPoll属性对吞吐量施加限制。

消息传递桥的另一个有效用途是连接两个不同的系统。在这样的场景中, Spring 集成的作用仅限于在这些系统之间建立连接,并在必要时管理 Poller。在两个系统之间至少要有一个转换器,以便在它们的格式之间进行转换,这可能是更常见的做法。在这种情况下,这些通道可以作为变压器端点的“输入通道”和“输出通道”提供。如果不需要数据格式转换,那么消息传递桥接可能就足够了。

# 使用 XML 配置桥

可以使用<bridge>元素在两个消息通道或通道适配器之间创建消息传递桥梁。要做到这一点,请提供input-channeloutput-channel属性,如下例所示:

<int:bridge input-channel="input" output-channel="output"/>

如上所述,消息传递桥接的一个常见用例是将PollableChannel连接到SubscribableChannel。在执行此角色时,消息传递桥也可以充当节流阀:

<int:bridge input-channel="pollable" output-channel="subscribable">
     <int:poller max-messages-per-poll="10" fixed-rate="5000"/>
 </int:bridge>

你可以使用类似的机制来连接通道适配器。下面的示例显示了来自 Spring Integration 的stdin名称空间的stdout适配器之间的一个简单“echo”:

<int-stream:stdin-channel-adapter id="stdin"/>

 <int-stream:stdout-channel-adapter id="stdout"/>

 <int:bridge id="echo" input-channel="stdin" output-channel="stdout"/>

类似的配置也适用于其他(可能更有用的)通道适配器桥,例如文件到 JMS 或邮件到文件。接下来的章节将介绍各种通道适配器。

如果在桥上没有定义“输出通道”,则使用由入站消息提供的应答通道(如果可用)。
如果输出和应答通道都不可用,则抛出异常。

# 使用 Java 配置配置桥

下面的示例展示了如何使用@BridgeFrom注释在 Java 中配置桥:

@Bean
public PollableChannel polled() {
    return new QueueChannel();
}

@Bean
@BridgeFrom(value = "polled", poller = @Poller(fixedDelay = "5000", maxMessagesPerPoll = "10"))
public SubscribableChannel direct() {
    return new DirectChannel();
}

下面的示例展示了如何使用@BridgeTo注释在 Java 中配置桥:

@Bean
@BridgeTo(value = "direct", poller = @Poller(fixedDelay = "5000", maxMessagesPerPoll = "10"))
public PollableChannel polled() {
    return new QueueChannel();
}

@Bean
public SubscribableChannel direct() {
    return new DirectChannel();
}

或者,你可以使用BridgeHandler,如下例所示:

@Bean
@ServiceActivator(inputChannel = "polled",
        poller = @Poller(fixedRate = "5000", maxMessagesPerPoll = "10"))
public BridgeHandler bridge() {
    BridgeHandler bridge = new BridgeHandler();
    bridge.setOutputChannelName("direct");
    return bridge;
}

# 使用 Java DSL 配置桥

你可以使用 Java Domain Specific Language 来配置桥,如下例所示:

@Bean
public IntegrationFlow bridgeFlow() {
    return IntegrationFlows.from("polled")
            .bridge(e -> e.poller(Pollers.fixedDelay(5000).maxMessagesPerPoll(10)))
            .channel("direct")
            .get();
}