消息发布 (Message Publishing) _ Spring Integration6.4.0-SNAPSHOT中文文档(官方文档中文翻译)|Spring 教程 —

此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Integration 6.3.4！spring-doc.cn

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

消息发布配置

Spring 集成提供了两种方法：XML 配置和注释驱动（Java）配置。spring-doc.cn

带有 Annotation 的 Annotation 驱动配置`@Publisher`

注释驱动的方法允许您使用 annotation 对任何方法进行注释，以指定 'channel' 属性。从版本 5.1 开始，要打开此功能，必须在某个类上使用 Comments。有关更多信息，请参阅配置和@EnableIntegration。该消息是根据方法调用的返回值构造的，并发送到由 'channel' 属性指定的通道。要进一步管理消息结构，您还可以结合使用两者和 annotations。@Publisher@EnablePublisher@Configuration@Payload@Headerspring-doc.cn

在内部，Spring Integration 的这个消息发布功能同时使用 Spring AOP by defining 和 Spring 表达式语言（SpEL），为您提供相当大的灵活性和对其发布结构的控制。PublisherAnnotationAdvisorMessagespring-doc.cn

定义并绑定以下变量：PublisherAnnotationAdvisorspring-doc.cn

#return：绑定到返回值，允许您引用它或其属性（例如，，其中 'something' 是绑定到#return.something#return)spring-doc.cn
#exception：如果方法调用引发异常，则绑定到异常spring-doc.cn
#args：绑定到方法参数，以便您可以按名称提取各个参数（例如#args.fname)spring-doc.cn

请考虑以下示例：spring-doc.cn

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

在前面的示例中，消息使用以下结构构造：spring-doc.cn

消息有效负载是方法的返回类型和值。这是默认设置。spring-doc.cn
新构造的消息将发送到配置了 Comments 后处理器的默认 publisher 通道（本节稍后将介绍）。spring-doc.cn

以下示例与前面的示例相同，只是它不使用默认发布渠道：spring-doc.cn

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

我们不是使用默认发布渠道，而是通过设置注释的 'channel' 属性来指定发布渠道。我们还添加了一个注释，这会导致名为 'last' 的消息标头与 'lname' 方法参数具有相同的值。该标头将添加到新构造的消息中。@Publisher@Headerspring-doc.cn

以下示例与前面的示例几乎相同：spring-doc.cn

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

唯一的区别是我们在方法上使用 Comments 来显式指定方法的返回值应该用作消息的有效负载。@Payloadspring-doc.cn

以下示例通过在 Comments 中使用 Spring Expression Language 来扩展前面的配置，以进一步指示框架应如何构造消息：@Payloadspring-doc.cn

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

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

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

在前面的示例中，您会看到 annotation 的另一种用法。在这里，我们注释了一个 method 参数，该参数将成为新构造消息的有效负载。@Payloadspring-doc.cn

与 Spring 中的大多数其他 Comments 驱动的功能一样，你需要注册一个后处理器（）。以下示例显示了如何执行此操作：PublisherAnnotationBeanPostProcessorspring-doc.cn

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

对于更简洁的配置，您可以改用 namespace support，如下例所示：spring-doc.cn

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

对于 Java 配置，您必须使用 Comments，如下例所示：@EnablePublisherspring-doc.cn

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

从版本 5.1.3 开始，组件以及 annotation 具有用于调整配置的 and 属性。<int:enable-publisher>@EnablePublisherproxy-target-classorderProxyFactoryspring-doc.cn

与其他 Spring 注释（、、等）类似，您也可以用作元 Comments。这意味着您可以定义自己的 Comments，这些 Comments 的处理方式与本身相同。以下示例显示了如何执行此操作：@Component@Scheduled@Publisher@Publisherspring-doc.cn

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

在前面的示例中，我们定义了注释，它本身用 . 另请注意，您可以在 meta-annotation 上定义一个属性，以封装此 annotation 内消息的发送位置。现在，您可以使用注释注释任何方法，如下例所示：@Audit@Publisherchannel@Auditspring-doc.cn

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

在前面的示例中，该方法的每次调用都会导致一条消息，其中包含从其返回值创建的有效负载。每条消息都发送到名为的通道。此技术的好处之一是，您可以避免在多个 annotation 中重复相同的通道名称。您还可以在自己的（可能特定于域的）注释和框架提供的注释之间提供间接级别。test()auditChannelspring-doc.cn

您还可以对类进行注释，这样您就可以将此注释的属性应用于该类的每个公共方法，如下例所示：spring-doc.cn

@Audit
static class BankingOperationsImpl implements BankingOperations {

  public String debit(String amount) {
     . . .

  }

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

}

带有元素的基于 XML 的方法`<publishing-interceptor>`

通过基于 XML 的方法，您可以配置与基于命名空间的 . 与注释驱动方法相比，它当然有一些好处，因为它允许您使用 AOP 切入点表达式，因此可能会一次拦截多个方法，或者拦截和发布您没有源代码的方法。MessagePublishingInterceptorspring-doc.cn

要使用 XML 配置消息发布，您只需执行以下两项操作：spring-doc.cn

使用 XML 元素提供配置。MessagePublishingInterceptor<publishing-interceptor>spring-doc.cn
提供 AOP 配置以将应用于托管对象。MessagePublishingInterceptorspring-doc.cn

以下示例显示如何配置元素：publishing-interceptorspring-doc.cn

<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>

该配置看起来与基于 Comments 的方法非常相似，并且它还使用了 Spring Expression Language 的强大功能。<publishing-interceptor>spring-doc.cn

在前面的示例中，执行 a 的方法将呈现具有以下结构的 a：echotestBeanMessagespring-doc.cn

payload 的类型为以下内容：，其中是执行方法返回的值。MessageStringEchoing: [value]valuespring-doc.cn
具有名称为且值为 .Messagethingssomethingspring-doc.cn
将发送到。MessageechoChannelspring-doc.cn

第二种方法与第一种方法非常相似。在这里，每个以 'repl' 开头的方法都以以下结构呈现 a：Messagespring-doc.cn

有效负载与前面的示例中的相同。Messagespring-doc.cn
它有一个名为 Headers 的 Headers，其值是 SpEL expression 的结果。Messagethings'something'.toUpperCase()spring-doc.cn
将发送到。MessageechoChannelspring-doc.cn

第二种方法映射任何以开头的方法的执行，都会生成具有以下结构的 a：echoDefMessagespring-doc.cn

payload 是执行的方法返回的值。Messagespring-doc.cn
由于未提供该属性，因此将发送到由定义的。channelMessagedefaultChannelpublisherspring-doc.cn

对于简单的映射规则，您可以依赖默认值，如下例所示：publisherspring-doc.cn

<publishing-interceptor id="anotherInterceptor"/>

前面的示例将与切入点表达式匹配的每个方法的返回值映射到有效负载，并发送到 . 如果未指定（因为前面的示例未指定），则消息将发送到全局（等效于）。default-channeldefaultChannelnullChannel/dev/nullspring-doc.cn

异步发布

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

以下示例中的服务接收复杂的有效负载（需要进一步发送以进行处理），但它还需要使用简单的确认来回复调用方：spring-doc.cn

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

因此，我们不是将复杂的流挂接到输出通道，而是使用消息发布功能。我们将其配置为使用 service 方法的 input 参数（如前面的示例所示）创建新消息，并将其发送到 'localProcessChannel'。为了确保这个 flow 是异步的，我们需要做的就是将其发送到任何类型的异步通道（在下一个示例中）。以下示例显示如何对 asynchronous ：ExecutorChannelpublishing-interceptorspring-doc.cn

<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"/>

处理此类情况的另一种方法是使用窃听。请参见Wire Tap。spring-doc.cn

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

在前面的部分中，我们了解了消息发布功能，该功能将消息作为方法调用的副产品构建和发布。但是，在这些情况下，您仍然负责调用该方法。 Spring Integration 2.0 在'inbound-channel-adapter'元素上使用新属性添加了对预定消息生产者和发布者的支持。你可以基于多个触发器进行调度，其中任何一个都可以在 'poller' 元素上配置。目前，我们支持由您实现并由 'trigger' 属性值引用的任何自定义触发器。expressioncronfixed-ratefixed-delayspring-doc.cn

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

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

前面的示例创建了一个入站通道适配器，该适配器构造一个，其有效负载是属性中定义的表达式的结果。每次发生属性指定的延迟时，都会创建并发送此类消息。Messageexpressionfixed-delayspring-doc.cn

以下示例与前面的示例类似，不同之处在于它使用了 attribute：fixed-ratespring-doc.cn

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

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

以下示例显示了如何应用具有 attribute 中指定的值的 Cron 触发器：cronspring-doc.cn

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

以下示例显示了如何在消息中插入其他标头：spring-doc.cn

<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 表达式的结果。spring-doc.cn

如果你需要实现自己的自定义触发器，则可以使用该属性提供对实现该接口的任何 Spring 配置的 bean 的引用。以下示例显示了如何执行此操作：triggerorg.springframework.scheduling.Triggerspring-doc.cn

<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>

消息发布配置

带有 Annotation 的 Annotation 驱动配置@Publisher

带有元素的基于 XML 的方法<publishing-interceptor>

异步发布

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

带有 Annotation 的 Annotation 驱动配置`@Publisher`

带有元素的基于 XML 的方法`<publishing-interceptor>`