此版本仍在开发中,尚不被认为是稳定的。对于最新的稳定版本,请使用 Spring Integration 6.5.1! |
消息发布
(面向方面编程)AOP 消息发布功能允许您构造和发送消息,作为方法调用的副产品。例如,假设您有一个组件,并且每次该组件的状态发生变化时,您都希望收到消息通知。发送此类通知的最简单方法是将消息发送到专用通道,但是如何将更改对象状态的方法调用连接到消息发送过程,以及通知消息应如何构建?AOP 消息发布功能使用配置驱动的方法处理这些职责。
消息发布配置
Spring Integration 提供了两种方法:XML 配置和注释驱动 (Java) 配置。
注释驱动的配置,其中包含@Publisher
注解
注释驱动的方法允许您使用@Publisher
注释来指定“channel”属性。从 5.1 版开始,要打开此功能,您必须使用@EnablePublisher
一些注释@Configuration
类。 看配置和@EnableIntegration
以获取更多信息。消息是根据方法调用的返回值构造的,并发送到 'channel' 属性指定的通道。要进一步管理消息结构,您还可以使用两者的组合@Payload
和@Header
附注。
在内部,Spring Integration 的这个消息发布功能通过定义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
注解。 我们还添加了一个@Header
注释,这会导致名为“last”的消息头与“lname”方法参数具有相同的值。该标头将添加到新构造的消息中。
以下示例与前面的示例几乎相同:
@Publisher(channel="testChannel")
@Payload
public String defaultPayloadButExplicitAnnotation(String fname, @Header String lname) {
return fname + " " + lname;
}
唯一的区别是我们使用@Payload
注释,以显式指定该方法的返回值应用作消息的有效负载。
以下示例通过在@Payload
注释,以进一步指示框架应如何构造消息:
@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”输入参数确定。该标头将添加到新构造的消息中。
@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 切入点表达式,从而可能一次拦截多个方法或拦截和发布您没有源代码的方法。
若要使用 XML 配置消息发布,只需执行以下两件事:
-
提供配置
MessagePublishingInterceptor
通过使用<publishing-interceptor>
XML 元素。 -
提供 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 表达式语言的强大功能。
在前面的示例中,执行echo
方法testBean
渲染一个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
被发送到defaultChannel
由publisher
.
对于简单的映射规则,您可以依赖publisher
defaults,如以下示例所示:
<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 添加了对计划消息生产者和发布者的支持,新的expression
属性。
您可以根据多个触发器进行调度,其中任何一个都可以在“轮询器”元素上配置。
目前,我们支持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
属性:
<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
属性来提供对任何 Spring 配置的 bean 的引用,该 bean 实现了org.springframework.scheduling.Trigger
接口。
以下示例显示了如何执行此作:
<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>