弹簧ApplicationEvent支持

ApplicationEventsSpring Integration 为底层 Spring Framework 定义的inbound 和 outbound 提供支持。有关 Spring 对事件和侦听器的支持的更多信息，请参阅Spring 参考手册。

您需要将此依赖项包含到您的项目中：

Maven
<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-event</artifactId>
    <version>5.5.13</version>
</dependency>
Gradle
compile "org.springframework.integration:spring-integration-event:5.5.13"

接收 Spring 应用程序事件

要接收事件并将它们发送到通道，您可以定义 Spring Integration 的ApplicationEventListeningMessageProducer. 这个类是 SpringApplicationListener接口的一个实现。默认情况下，它将所有接收到的事件作为 Spring Integration 消息传递。要根据事件类型进行限制，您可以使用“eventTypes”属性来配置要接收的事件类型列表。如果接收到的事件有一个Message实例作为其“源”，Message则按原样传递。否则，如果提供了基于 SpEL 的payloadExpression，则针对ApplicationEvent实例进行评估。如果事件的源不是Message实例并且没有payloadExpression提供，则将ApplicationEvent其本身作为有效负载传递。

从版本 4.2 开始，ApplicationEventListeningMessageProducer实现GenericApplicationListener并且可以配置为不仅接受ApplicationEvent类型，而且接受任何类型来处理有效负载事件（自 Spring Framework 4.2 起也支持）。当接受的事件是 的实例时PayloadApplicationEvent，它payload用于发送消息。

为方便起见，提供了命名空间支持来配置ApplicationEventListeningMessageProducer元素inbound-channel-adapter，如以下示例所示：

<int-event:inbound-channel-adapter channel="eventChannel"
                                   error-channel="eventErrorChannel"
                                   event-types="example.FooEvent, example.BarEvent, java.util.Date"/>

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

在前面的示例中，与“event-types”（可选）属性指定的类型之一匹配的所有应用程序上下文事件都作为 Spring Integration 消息传递到名为“eventChannel”的消息通道。如果下游组件抛出异常，则将MessagingException包含失败消息和异常的 a 发送到名为“eventErrorChannel”的通道。如果error-channel指定 no 并且下游通道是同步的，则将异常传播给调用者。

使用Java配置同一个适配器：

@Bean
public ApplicationEventListeningMessageProducer eventsAdapter(
            MessageChannel eventChannel, MessageChannel eventErrorChannel) {

    ApplicationEventListeningMessageProducer producer =
        new ApplicationEventListeningMessageProducer();
    producer.setEventTypes(example.FooEvent.class, example.BarEvent.class, java.util.Date.class);
    producer.setOutputChannel(eventChannel);
    producer.setErrorChannel(eventErrorChannel);
    return producer;
}

使用 Java DSL：

@Bean
public ApplicationEventListeningMessageProducer eventsAdapter() {

    ApplicationEventListeningMessageProducer producer =
        new ApplicationEventListeningMessageProducer();
    producer.setEventTypes(example.FooEvent.class, example.BarEvent.class, java.util.Date.class);
    return producer;
}

@Bean
public IntegrationFlow eventFlow(ApplicationEventListeningMessageProducer eventsAdapter,
        MessageChannel eventErrorChannel) {

    return IntegrationFlows.from(eventsAdapter, e -> e.errorChannel(eventErrorChannel))
        .handle(...)
        ...
        .get();
}

发送 Spring 应用程序事件

要发送 Spring ApplicationEvents，请创建 的实例ApplicationEventPublishingMessageHandler并将其注册到端点中。该MessageHandler接口的实现也实现了 Spring 的ApplicationEventPublisherAware接口，因此充当了 Spring Integration 消息和ApplicationEvents.

为方便起见，提供了命名空间支持来配置ApplicationEventPublishingMessageHandler元素outbound-channel-adapter，如以下示例所示：

<int:channel id="eventChannel"/>

<int-event:outbound-channel-adapter channel="eventChannel"/>

如果使用 a PollableChannel（如 a QueueChannel），还可以提供该元素的poller子outbound-channel-adapter元素。您还可以选择task-executor为该轮询器提供参考。以下示例演示了两者：

<int:channel id="eventChannel">
  <int:queue/>
</int:channel>

<int-event:outbound-channel-adapter channel="eventChannel">
  <int:poller max-messages-per-poll="1" task-executor="executor" fixed-rate="100"/>
</int-event:outbound-channel-adapter>

<task:executor id="executor" pool-size="5"/>

在前面的示例中，发送到“eventChannel”通道的所有消息都作为实例发布到在同一 Spring 中注册的ApplicationEvent任何相关实例。如果消息的有效负载是，则按原样传递。否则，消息本身被包装在一个实例中。ApplicationListenerApplicationContextApplicationEventMessagingEvent

从版本 4.2 开始，您可以使用布尔属性配置ApplicationEventPublishingMessageHandler( <int-event:outbound-channel-adapter>) 以按原样publish-payload发布到应用程序上下文payload，而不是将其包装到MessagingEvent实例中。

使用 Java 配置来配置适配器：

@Bean
@ServiceActivator(inputChannel = "eventChannel")
public ApplicationEventPublishingMessageHandler eventHandler() {
    ApplicationEventPublishingMessageHandler handler =
            new ApplicationEventPublishingMessageHandler();
    handler.setPublishPayload(true);
    return handler;
}

使用 Java DSL：

@Bean
public ApplicationEventPublishingMessageHandler eventHandler() {
    ApplicationEventPublishingMessageHandler handler =
            new ApplicationEventPublishingMessageHandler();
    handler.setPublishPayload(true);
    return handler;
}

@Bean
// MessageChannel is "eventsFlow.input"
public IntegrationFlow eventsOutFlow(ApplicationEventPublishingMessageHandler eventHandler) {
    return f -> f.handle(eventHandler);
}
1. see XML Configuration