消息发布

面向切面编程 (AOP) 的消息发布功能允许您在方法调用时构建和发送消息作为副产品。例如，假设您有一个组件，并且每次该组件的状态发生变化时，您都希望通过消息收到通知。发送此类通知的最简单方法是向专用通道发送消息，但是您如何将更改对象状态的方法调用连接到消息发送过程，以及如何构建通知消息？AOP 消息发布功能通过配置驱动的方法处理这些职责。

消息发布配置

Spring Integration 提供两种方法：XML 配置和基于注解的 (Java) 配置。

使用 @Publisher 注解的基于注解的配置

基于注解的方法允许您使用 @Publisher 注解对任何方法进行注解，以指定“channel”属性。从 5.1 版本开始，要启用此功能，您必须在某个 @Configuration 类上使用 @EnablePublisher 注解。有关更多信息，请参见 配置和 @EnableIntegration。消息由方法调用的返回值构建，并发送到“channel”属性指定的通道。为了进一步管理消息结构，您还可以结合使用 @Payload 和 @Header 注解。

在内部，Spring Integration 的此消息发布功能使用 Spring AOP（通过定义 PublisherAnnotationAdvisor）和 Spring 表达式语言 (SpEL)，使您能够灵活地控制它发布的 Message 的结构。

PublisherAnnotationAdvisor 定义并绑定以下变量

  • #return：绑定到返回值，允许您引用它或它的属性（例如，#return.something，其中“something”是绑定到 #return 的对象的属性）

  • #exception：如果方法调用抛出异常，则绑定到异常

  • #args：绑定到方法参数，以便您可以按名称提取单个参数（例如，#args.fname）

请考虑以下示例

@Publisher
public String defaultPayload(String fname, String lname) {
  return fname + " " + lname;
}

在前面的示例中，消息使用以下结构构建

  • 消息有效负载是方法的返回类型和值。这是默认值。

  • 新构建的消息将发送到默认发布者通道，该通道使用注解后处理器进行配置（将在本节后面介绍）。

以下示例与前面的示例相同，只是它没有使用默认发布通道

@Publisher(channel="testChannel")
public String defaultPayload(String fname, @Header("last") String lname) {
  return fname + " " + lname;
}

与使用默认发布通道不同，我们可以通过设置@Publisher注解的'channel'属性来指定发布通道。我们还添加了@Header注解，这会导致名为'last'的消息头具有与'lname'方法参数相同的值。该头将添加到新构造的消息中。

以下示例与前面的示例几乎相同

@Publisher(channel="testChannel")
@Payload
public String defaultPayloadButExplicitAnnotation(String fname, @Header String lname) {
  return fname + " " + lname;
}

唯一的区别是我们使用@Payload注解在方法上显式指定方法的返回值应作为消息的有效负载使用。

以下示例扩展了之前的配置，在@Payload注解中使用Spring表达式语言来进一步指示框架如何构造消息

@Publisher(channel="testChannel")
@Payload("#return + #args.lname")
public String setName(String fname, String lname, @Header("x") int num) {
  return fname + " " + lname;
}

在前面的示例中，消息是方法调用返回值和'lname'输入参数的串联。名为'x'的消息头其值由'num'输入参数确定。该头将添加到新构造的消息中。

@Publisher(channel="testChannel")
public String argumentAsPayload(@Payload String fname, @Header String lname) {
  return fname + " " + lname;
}

在前面的示例中，您看到了@Payload注解的另一种用法。在这里，我们注释了一个方法参数，该参数将成为新构造消息的有效负载。

与 Spring 中大多数其他基于注解的功能一样，您需要注册一个后处理器（PublisherAnnotationBeanPostProcessor）。以下示例展示了如何做到这一点

<bean class="org.springframework.integration.aop.PublisherAnnotationBeanPostProcessor"/>

为了更简洁的配置，您可以使用命名空间支持，如下面的示例所示

<int:annotation-config>
    <int:enable-publisher default-publisher-channel="defaultChannel"/>
</int:annotation-config>

对于 Java 配置，您必须使用@EnablePublisher注解，如下面的示例所示

@Configuration
@EnableIntegration
@EnablePublisher("defaultChannel")
public class IntegrationConfiguration {
    ...
}

从版本 5.1.3 开始，<int:enable-publisher>组件以及@EnablePublisher注解具有proxy-target-class和order属性，用于调整ProxyFactory配置。

类似于其他 Spring 注解（@Component、@Scheduled等），您也可以使用@Publisher作为元注解。这意味着您可以定义自己的注解，这些注解将与@Publisher本身以相同的方式处理。以下示例展示了如何做到这一点

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Publisher(channel="auditChannel")
public @interface Audit {
...
}

在前面的示例中，我们定义了@Audit注解，它本身用@Publisher注解。还要注意，您可以在元注解上定义一个channel属性，以封装消息在此注解内发送的位置。现在，您可以使用@Audit注解注释任何方法，如下面的示例所示

@Audit
public String test() {
    return "Hello";
}

在前面的示例中，test()方法的每次调用都会产生一条消息，其有效负载由其返回值创建。每条消息都发送到名为auditChannel的通道。这种技术的好处之一是，您可以避免在多个注解中重复相同的通道名称。您还可以提供您自己的（可能是特定于域的）注解与框架提供的注解之间的间接级别。

您也可以注释类，这使您可以在该类的每个公共方法上应用此注解的属性，如下面的示例所示

@Audit
static class BankingOperationsImpl implements BankingOperations {

  public String debit(String amount) {
     . . .

  }

  public String credit(String amount) {
     . . .
  }

}

基于 XML 的方法，使用 <publishing-interceptor> 元素

基于 XML 的方法允许您配置与基于命名空间的 MessagePublishingInterceptor 配置相同的基于 AOP 的消息发布功能。与基于注解的方法相比，它确实有一些优势，因为它允许您使用 AOP 切点表达式，从而可能一次拦截多个方法，或者拦截和发布您没有源代码的方法。

要使用 XML 配置消息发布，您只需要执行以下两个步骤：

  • 使用 <publishing-interceptor> XML 元素为 MessagePublishingInterceptor 提供配置。

  • 提供 AOP 配置以将 MessagePublishingInterceptor 应用于托管对象。

以下示例展示了如何配置 publishing-interceptor 元素：

<aop:config>
  <aop:advisor advice-ref="interceptor" pointcut="bean(testBean)" />
</aop:config>
<publishing-interceptor id="interceptor" default-channel="defaultChannel">
  <method pattern="echo" payload="'Echoing: ' + #return" channel="echoChannel">
    <header name="things" value="something"/>
  </method>
  <method pattern="repl*" payload="'Echoing: ' + #return" channel="echoChannel">
    <header name="things" expression="'something'.toUpperCase()"/>
  </method>
  <method pattern="echoDef*" payload="#return"/>
</publishing-interceptor>

<publishing-interceptor> 配置看起来与基于注解的方法非常相似，并且它也利用了 Spring 表达式语言的强大功能。

在前面的示例中，testBean 的 echo 方法的执行将生成一个具有以下结构的 Message：

  • Message 的有效负载类型为 String，内容为：Echoing: [value]，其中 value 是执行方法返回的值。

  • Message 具有一个名为 things 的标头，其值为 something。

  • Message 发送到 echoChannel。

第二种方法与第一种方法非常相似。在这里，每个以 'repl' 开头的执行方法都会生成一个具有以下结构的 Message：

  • Message 的有效负载与前面的示例相同。

  • Message 具有一个名为 things 的标头，其值为 SpEL 表达式 'something'.toUpperCase() 的结果。

  • Message 发送到 echoChannel。

第二种方法，映射任何以 echoDef 开头的执行方法，将生成一个具有以下结构的 Message：

  • Message 的有效负载是执行方法返回的值。

  • 由于没有提供 channel 属性，因此 Message 将发送到 publisher 定义的 defaultChannel。

对于简单的映射规则，您可以依赖 publisher 默认值，如下面的示例所示：

<publishing-interceptor id="anotherInterceptor"/>

前面的示例将与切点表达式匹配的每个方法的返回值映射到有效负载，并发送到 default-channel。如果您没有指定 defaultChannel（如前面的示例没有做），则消息将发送到全局 nullChannel（相当于 /dev/null）。

异步发布

发布发生在与组件执行相同的线程中。因此，默认情况下，它是同步的。这意味着整个消息流必须等到发布者的流程完成。但是，开发人员通常希望完全相反：使用此消息发布功能来启动异步流程。例如，您可能托管一个接收远程请求的服务（HTTP、WS 等）。您可能希望将此请求内部发送到一个可能需要一段时间才能完成的进程。但是，您可能还想立即回复用户。因此，您可以使用“output-channel”或“replyChannel”标头将简单的确认回复发送回调用方，而不是将入站请求发送到输出通道（传统方式）以进行处理，同时使用消息发布功能来启动复杂流程。

以下示例中的服务接收一个复杂有效负载（需要进一步发送以进行处理），但它还需要向调用方回复一个简单的确认。

public String echo(Object complexPayload) {
     return "ACK";
}

因此，我们没有将复杂流程连接到输出通道，而是使用消息发布功能。我们将其配置为使用服务方法的输入参数（如前例所示）创建新消息，并将其发送到“localProcessChannel”。为了确保此流程是异步的，我们只需要将其发送到任何类型的异步通道（下一个示例中的ExecutorChannel）。以下示例展示了如何使用异步publishing-interceptor。

<int:service-activator  input-channel="inputChannel" output-channel="outputChannel" ref="sampleservice"/>

<bean id="sampleService" class="test.SampleService"/>

<aop:config>
  <aop:advisor advice-ref="interceptor" pointcut="bean(sampleService)" />
</aop:config>

<int:publishing-interceptor id="interceptor" >
  <int:method pattern="echo" payload="#args[0]" channel="localProcessChannel">
    <int:header name="sample_header" expression="'some sample value'"/>
  </int:method>
</int:publishing-interceptor>

<int:channel id="localProcessChannel">
  <int:dispatcher task-executor="executor"/>
</int:channel>

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

处理此类场景的另一种方法是使用线缆监听器。请参阅线缆监听器。

基于计划触发器生成和发布消息

在前面的部分中，我们介绍了消息发布功能，该功能在方法调用时构建和发布消息。但是，在这些情况下，您仍然负责调用该方法。Spring Integration 2.0 添加了对计划消息生产者和发布者的支持，在“inbound-channel-adapter”元素上新增了“expression”属性。您可以根据多个触发器进行计划，这些触发器中的任何一个都可以在“poller”元素上配置。目前，我们支持cron、fixed-rate、fixed-delay以及您实现并由“trigger”属性值引用的任何自定义触发器。

如前所述，对计划生产者和发布者的支持是通过<inbound-channel-adapter> XML 元素提供的。请考虑以下示例

<int:inbound-channel-adapter id="fixedDelayProducer"
       expression="'fixedDelayTest'"
       channel="fixedDelayChannel">
    <int:poller fixed-delay="1000"/>
</int:inbound-channel-adapter>

前面的示例创建了一个入站通道适配器，它构造一个Message，其有效负载是expression 属性中定义的表达式的结果。每当fixed-delay 属性指定的延迟发生时，就会创建并发送此类消息。

以下示例与前面的示例类似，只是它使用fixed-rate 属性

<int:inbound-channel-adapter id="fixedRateProducer"
       expression="'fixedRateTest'"
       channel="fixedRateChannel">
    <int:poller fixed-rate="1000"/>
</int:inbound-channel-adapter>

fixed-rate 属性允许您以固定速率发送消息（从每个任务的开始时间测量）。

以下示例展示了如何使用在cron 属性中指定的 value 应用 Cron 触发器

<int:inbound-channel-adapter id="cronProducer"
       expression="'cronTest'"
       channel="cronChannel">
    <int:poller cron="7 6 5 4 3 ?"/>
</int:inbound-channel-adapter>

以下示例展示了如何将额外的标头插入消息

<int:inbound-channel-adapter id="headerExpressionsProducer"
       expression="'headerExpressionsTest'"
       channel="headerExpressionsChannel"
       auto-startup="false">
    <int:poller fixed-delay="5000"/>
    <int:header name="foo" expression="6 * 7"/>
    <int:header name="bar" value="x"/>
</int:inbound-channel-adapter>

额外的消息标头可以采用标量值或评估 Spring 表达式的结果。

如果您需要实现自己的自定义触发器，可以使用trigger 属性提供对任何实现org.springframework.scheduling.Trigger 接口的 spring 配置 bean 的引用。以下示例展示了如何做到这一点

<int:inbound-channel-adapter id="triggerRefProducer"
       expression="'triggerRefTest'" channel="triggerRefChannel">
    <int:poller trigger="customTrigger"/>
</int:inbound-channel-adapter>

<beans:bean id="customTrigger" class="o.s.scheduling.support.PeriodicTrigger">
    <beans:constructor-arg value="9999"/>
</beans:bean>