跳到主要内容

注解支持

QWen Plus 中英对照 Annotation Support

除了用于配置消息端点的 XML 命名空间支持外，您还可以使用注解。首先，Spring Integration 提供了类级别的 @MessageEndpoint 作为立体类型注解，这意味着它本身被 Spring 的 @Component 注解所标注，因此可以被 Spring 的组件扫描自动识别为 bean 定义。

更为重要的是各种方法级别的注解。它们表明被注解的方法能够处理消息。以下示例同时演示了类级别和方法级别的注解：

@MessageEndpoint
public class FooService {

    @ServiceActivator
    public void processMessage(Message message) {
        ...
    }
}
java

方法“处理”消息的确切含义取决于特定的注解。Spring Integration 中可用的注解包括：

备注

如果您将 XML 配置与注解结合使用，则 @MessageEndpoint 注解不是必需的。如果您希望从 <service-activator/> 元素的 ref 属性配置一个 POJO 引用，您可以仅提供方法级别的注解。在这种情况下，即使 <service-activator/> 元素上不存在方法级别的属性，注解也可以防止歧义。

在大多数情况下，带有注解的处理方法不应该需要 Message 类型作为其参数。相反，方法参数类型可以匹配消息的有效载荷类型，如下例所示：

public class ThingService {

    @ServiceActivator
    public void bar(Thing thing) {
        ...
    }

}
java

当方法参数应映射自 MessageHeaders 中的值时，另一种选择是使用参数级别的 @Header 注解。一般来说，带有 Spring Integration 注解的方法可以接受 Message 本身、消息负载或带有 @Header 的头值作为参数。实际上，该方法可以接受这些内容的组合，如下例所示：

public class ThingService {

    @ServiceActivator
    public void otherThing(String payload, @Header("x") int valueX, @Header("y") int valueY) {
        ...
    }

}
java

您也可以使用 @Headers 注解将所有消息头作为 Map 提供，如下例所示：

public class ThingService {

    @ServiceActivator
    public void otherThing(String payload, @Headers Map<String, Object> headerMap) {
        ...
    }

}
java
备注

注解的值也可以是一个 SpEL 表达式（例如，someHeader.toUpperCase()），当你希望在注入之前操作头值时，这非常有用。它还提供了一个可选的 required 属性，用于指定属性值是否必须在头中可用。required 属性的默认值是 true。

对于这些注解中的几个，当消息处理方法返回非空值时，端点会尝试发送回复。这在两种配置选项（命名空间和注解）中是一致的，即使用此类端点的输出通道（如果可用），并且将 REPLY_CHANNEL 消息头值用作回退。

提示

端点上的输出通道和回复通道消息头的结合使得管道方法成为可能，其中多个组件具有输出通道，最终组件允许回复消息转发到回复通道（如原始请求消息中指定）。换句话说，最终组件依赖于原始发送者提供的信息，并且可以动态支持任意数量的客户端。这是返回地址模式的一个例子。

除了这里显示的示例外，这些注解还支持 inputChannel 和 outputChannel 属性，如下例所示：

@Service
public class ThingService {

    @ServiceActivator(inputChannel="input", outputChannel="output")
    public void otherThing(String payload, @Headers Map<String, Object> headerMap) {
        ...
    }

}
java

这些注解的处理会创建与相应 XML 组件相同的 bean — AbstractEndpoint 实例和 MessageHandler 实例（或对于入站通道适配器的 MessageSource 实例）。参见 方法上的 @Bean 注解。bean 名称是根据以下模式生成的：[componentName].[methodName].[小写的注解类短名称]。在前面的例子中，AbstractEndpoint 的 bean 名称是 thingService.otherThing.serviceActivator，而 MessageHandler (MessageSource) bean 的名称则是在此基础上加上一个额外的 .handler (.source) 后缀。这样的名称可以通过与这些消息注解一起使用 @EndpointId 注解来进行自定义。MessageHandler 实例 (MessageSource 实例) 也有资格被 消息历史记录 跟踪。

从 4.0 版本开始，所有消息注解提供了 SmartLifecycle 选项（autoStartup 和 phase），以允许在应用程序上下文初始化时控制端点生命周期。它们分别默认为 true 和 0。要更改端点的状态（例如 start() 或 stop()），可以通过使用 BeanFactory（或自动装配）获取端点 bean 的引用并调用这些方法。或者，可以向 Control Bus 发送命令消息。为此，你应该使用前面段落中提到的 beanName。

important

在解析提到的注解后自动创建的通道（当没有配置特定的通道 bean 时），以及相应的消费者端点，会在上下文初始化结束时声明为 beans。这些 beans 可以 在其他服务中自动注入，但必须标记为 @Lazy 注解，因为这些定义通常在正常的自动注入处理期间还不可用。

@Autowired
@Lazy
@Qualifier("someChannel")
MessageChannel someChannel;
...

@Bean
Thing1 dependsOnSPCA(@Qualifier("someInboundAdapter") @Lazy SourcePollingChannelAdapter someInboundAdapter) {
    ...
}
java

从 6.0 版本开始，所有的消息注解现在都是 @Repeatable，因此可以在相同的服务方法上声明多个相同类型的注解，其含义是创建与这些注解重复次数一样多的端点：

@Transformer(inputChannel = "inputChannel1", outputChannel = "outputChannel1")
@Transformer(inputChannel = "inputChannel2", outputChannel = "outputChannel2")
public String transform(String input) {
    return input.toUpperCase();
}
java

使用 @Poller 注解​

在 Spring Integration 4.0 之前，消息注解要求 inputChannel 必须是 SubscribableChannel 的引用。对于 PollableChannel 实例，需要一个 <int:bridge/> 元素来配置 <int:poller/>，并使复合端点成为一个 PollingConsumer。4.0 版引入了 @Poller 注解，允许直接在消息注解上配置 poller 属性，如下例所示：

public class AnnotationService {

    @Transformer(inputChannel = "input", outputChannel = "output",
        poller = @Poller(maxMessagesPerPoll = "${poller.maxMessagesPerPoll}", fixedDelay = "${poller.fixedDelay}"))
    public String handle(String payload) {
        ...
    }
}
java

@Poller 注解仅提供简单的 PollerMetadata 选项。您可以使用属性占位符配置 @Poller 注解的属性（maxMessagesPerPoll、fixedDelay、fixedRate 和 cron）。此外，从 5.1 版开始，还提供了 PollingConsumer 的 receiveTimeout 选项。如果需要提供更多轮询选项（例如 transaction、advice-chain、error-handler 等），则应将 PollerMetadata 配置为通用 bean，并将其 bean 名称用作 @Poller 的 value 属性。在这种情况下，不允许有其他属性（它们必须在 PollerMetadata bean 上指定）。注意，如果 inputChannel 是 PollableChannel 并且没有配置 @Poller，则使用默认的 PollerMetadata（如果它存在于应用程序上下文中）。要使用 @Configuration 注解声明默认轮询器，请使用类似于以下示例的代码：

@Bean(name = PollerMetadata.DEFAULT_POLLER)
public PollerMetadata defaultPoller() {
    PollerMetadata pollerMetadata = new PollerMetadata();
    pollerMetadata.setTrigger(new PeriodicTrigger(10));
    return pollerMetadata;
}
java

以下示例展示了如何使用默认轮询器：

public class AnnotationService {

    @Transformer(inputChannel = "aPollableChannel", outputChannel = "output")
    public String handle(String payload) {
        ...
    }
}
java

以下示例展示了如何使用命名的轮询器：

@Bean
public PollerMetadata myPoller() {
    PollerMetadata pollerMetadata = new PollerMetadata();
    pollerMetadata.setTrigger(new PeriodicTrigger(1000));
    return pollerMetadata;
}
java

以下示例显示了一个使用默认轮询器的端点：

public class AnnotationService {

    @Transformer(inputChannel = "aPollableChannel", outputChannel = "output"
                           poller = @Poller("myPoller"))
    public String handle(String payload) {
         ...
    }
}
java

从 4.3.3 版本开始，@Poller 注解具有 errorChannel 属性，以便更轻松地配置底层的 MessagePublishingErrorHandler。此属性与 <poller> XML 组件中的 error-channel 发挥相同的作用。更多信息，请参见 Endpoint Namespace Support。

消息注解上的 poller() 属性与 reactive() 属性是互斥的。更多信息请参见下一节。

使用 @Reactive 注解​

ReactiveStreamsConsumer 自 5.0 版本以来就已经存在了，但它仅在端点的输入通道是 FluxMessageChannel（或任何 org.reactivestreams.Publisher 实现）时应用。从 5.3 版本开始，当目标消息处理器是 ReactiveMessageHandler 时，框架也会创建它的实例，而不论输入通道类型如何。从 5.5 版本开始，引入了 @Reactive 子注解（类似于上述的 @Poller），用于所有消息传递注解。它接受一个可选的 Function<? super Flux<Message<?>>, ? extends Publisher<Message<?>>> bean 引用，并且不论输入通道类型和消息处理器如何，都将目标端点转换为 ReactiveStreamsConsumer 实例。该函数是从 Flux.transform() 操作符中使用的，以对来自输入通道的反应式流源应用一些自定义设置（如 publishOn()、doOnNext()、log()、retry() 等）。

以下示例演示了如何独立于最终订阅者和生产者更改 DirectChannel 的发布线程，而不依赖于输入通道：

@Bean
public Function<Flux<?>, Flux<?>> publishOnCustomizer() {
    return flux -> flux.publishOn(Schedulers.parallel());
}

@ServiceActivator(inputChannel = "directChannel", reactive = @Reactive("publishOnCustomizer"))
public void handleReactive(String payload) {
    ...
}
java

消息注解上的 reactive() 属性与 poller() 属性是互斥的。更多信息请参见使用 @Poller 注解和Reactive Streams 支持。

使用 @InboundChannelAdapter 注解​

版本 4.0 引入了 @InboundChannelAdapter 方法级注解。它根据带有 MethodInvokingMessageSource 的注解方法生成一个 SourcePollingChannelAdapter 集成组件。此注解是 <int:inbound-channel-adapter> XML 组件的类似物，并具有相同的限制：方法不能有参数，且返回类型不能为 void。它有两个属性：value（必需的 MessageChannel bean 名称）和 poller（一个可选的 @Poller 注解，如前面所述）。如果您需要提供一些 MessageHeaders，请使用 Message<?> 返回类型，并使用 MessageBuilder 来构建 Message<?>。使用 MessageBuilder 可以让您配置 MessageHeaders。以下示例展示了如何使用 @InboundChannelAdapter 注解：

@InboundChannelAdapter(value = "exampleChannel", poller = @Poller(fixedDelay = "5000"))
public Message<String> generateMessage() {
    return MessageBuilder.withPayload("Hello World")
                         .setHeader("exampleHeader", "exampleValue")
                         .build();
}
java
@InboundChannelAdapter("counterChannel")
public Integer count() {
    return this.counter.incrementAndGet();
}

@InboundChannelAdapter(value = "fooChannel", poller = @Poller(fixed-rate = "5000"))
public String foo() {
    return "foo";
}
java

版本 4.3 引入了 channel 别名用于 value 注解属性，以提供更好的源代码可读性。此外，在 SourcePollingChannelAdapter 中，目标 MessageChannel bean 会在第一次 receive() 调用时通过提供的名称（由 outputChannelName 选项设置）解析，而不是在初始化阶段解析。这允许“后期绑定”逻辑：从消费者的角度来看，目标 MessageChannel bean 的创建和注册会稍微晚于 @InboundChannelAdapter 解析阶段。

第一个示例要求默认轮询器已在应用程序上下文的其他地方声明。

使用 @MessagingGateway 注解

使用 @IntegrationComponentScan 注解​

标准的 Spring Framework @ComponentScan 注解不会扫描接口上的刻板印象 @Component 注解。为了克服这一限制并允许配置 @MessagingGateway（请参阅[@MessagingGateway 注解]），我们引入了 @IntegrationComponentScan 机制。此注解必须与 @Configuration 注解一起使用，并且要自定义以定义其扫描选项，例如 basePackages 和 basePackageClasses。在这种情况下，所有带有 @MessagingGateway 注解的已发现接口都会被解析并注册为 GatewayProxyFactoryBean 实例。所有其他基于类的组件由标准的 @ComponentScan 进行解析。