注解支持

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

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

@MessageEndpoint
public class FooService {

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

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

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

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

public class ThingService {

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

}

当方法参数应从 MessageHeaders 中的值映射时，另一种选择是使用参数级别的 @Header 注解。通常，使用 Spring Integration 注解标注的方法可以接受 Message 本身、消息载荷或消息头值（使用 @Header）作为参数。实际上，方法可以接受组合，如下例所示

public class ThingService {

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

}

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

public class ThingService {

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

}
注解的值也可以是 SpEL 表达式（例如 someHeader.toUpperCase()），这在您希望在注入消息头值之前对其进行操作时很有用。它还提供了一个可选的 required 属性，该属性指定属性值是否必须在消息头中可用。required 属性的默认值为 true。

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

端点上的输出通道和回复通道消息头的组合实现了流水线（pipeline）方法，其中多个组件具有输出通道，而最终组件允许将回复消息转发到回复通道（如原始请求消息中指定）。换句话说，最终组件依赖于原始发送者提供的信息，因此可以动态支持任意数量的客户端。这是 回复地址 模式的一个示例。

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

@Service
public class ThingService {

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

}

这些注解的处理会创建与相应的 XML 组件相同的 Bean —— AbstractEndpoint 实例和 MessageHandler 实例（或入站通道适配器的 MessageSource 实例）。参见 @Bean 方法上的注解。Bean 名称按照以下模式生成：[组件名称].[方法名称].[注解类短名称小写首字母]. 在前面的示例中，AbstractEndpoint 的 Bean 名称是 thingService.otherThing.serviceActivator，而 MessageHandler (MessageSource) Bean 的名称相同，并额外带有 .handler (.source) 后缀。可以使用 @EndpointId 注解以及这些消息注解来自定义此类名称。MessageHandler 实例 (MessageSource 实例) 也符合被消息历史记录跟踪的条件。

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

在解析上述注解后自动创建的通道（当未配置特定通道 Bean 时）以及相应的消费者端点，在上下文初始化接近结束时被声明为 Bean。这些 Bean 可以 在其他服务中自动装配，但必须使用 @Lazy 注解标记，因为通常在正常的自动装配处理期间，这些定义尚未可用。

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

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

从 6.0 版本开始，所有消息注解都变为 @Repeatable，因此可以在同一个服务方法上声明多个相同类型的注解，这意味着将根据重复的注解数量创建相应数量的端点。

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

使用 @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) {
        ...
    }
}

@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;
}

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

public class AnnotationService {

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

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

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

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

public class AnnotationService {

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

从 4.3.3 版本开始，@Poller 注解包含 errorChannel 属性，以便更轻松地配置底层的 MessagePublishingErrorHandler。此属性与 <poller> XML 组件中的 error-channel 作用相同。有关更多信息，请参见 端点命名空间支持。

消息注解上的 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) {
    ...
}

消息注解上的 reactive() 属性与 poller() 属性互斥。有关更多信息，请参见 使用 @Poller 注解 和 响应式流支持。

使用 @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("counterChannel")
public Integer count() {
    return this.counter.incrementAndGet();
}

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

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

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

使用 @MessagingGateway 注解

参见 @MessagingGateway 注解。

使用 @IntegrationComponentScan 注解

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

© . This site is unofficial and not affiliated with VMware.