端点角色

从 4.2 版开始,可以将端点分配给角色。角色允许将端点作为一组启动和停止。当使用领导选举时,这特别有用,其中可以在授予或撤销领导权时启动或停止一组端点。为此,框架在应用程序上下文中注册了一个 SmartLifecycleRoleController bean,名称为 IntegrationContextUtils.INTEGRATION_LIFECYCLE_ROLE_CONTROLLER。每当需要控制生命周期时,都可以注入此 bean 或 @Autowired

<bean class="com.some.project.SomeLifecycleControl">
    <property name="roleController" ref="integrationLifecycleRoleController"/>
</bean>

可以使用 XML、Java 配置或以编程方式将端点分配给角色。以下示例显示了如何使用 XML 配置端点角色

<int:inbound-channel-adapter id="ica" channel="someChannel" expression="'foo'" role="cluster"
        auto-startup="false">
    <int:poller fixed-rate="60000" />
</int:inbound-channel-adapter>

以下示例显示了如何为在 Java 中创建的 bean 配置端点角色

@Bean
@ServiceActivator(inputChannel = "sendAsyncChannel", autoStartup="false")
@Role("cluster")
public MessageHandler sendAsyncHandler() {
    return // some MessageHandler
}

以下示例显示了如何在 Java 中的方法上配置端点角色

@Payload("#args[0].toLowerCase()")
@Role("cluster")
public String handle(String payload) {
    return payload.toUpperCase();
}

以下示例显示了如何在 Java 中使用 SmartLifecycleRoleController 配置端点角色

@Autowired
private SmartLifecycleRoleController roleController;
...
    this.roleController.addSmartLifeCycleToRole("cluster", someEndpoint);
...

以下示例显示了如何在 Java 中使用 IntegrationFlow 配置端点角色

IntegrationFlow flow -> flow
        .handle(..., e -> e.role("cluster"));

每个示例都将端点添加到 cluster 角色。

调用 roleController.startLifecyclesInRole("cluster") 和相应的 stop…​ 方法启动和停止端点。

任何实现 SmartLifecycle 的对象都可以以编程方式添加,而不仅仅是端点。

SmartLifecycleRoleController 实现 ApplicationListener<AbstractLeaderEvent>,当授予或撤销领导权时,它会自动启动和停止其配置的 SmartLifecycle 对象(当某个 bean 分别发布 OnGrantedEventOnRevokedEvent 时)。

在使用领导选举来启动和停止组件时,重要的是将 auto-startup XML 属性(autoStartup bean 属性)设置为 false,以便应用程序上下文在上下文初始化期间不会启动组件。

从版本 4.3.8 开始,SmartLifecycleRoleController 提供了几种状态方法

public Collection<String> getRoles() (1)

public boolean allEndpointsRunning(String role) (2)

public boolean noEndpointsRunning(String role) (3)

public Map<String, Boolean> getEndpointsRunningStatus(String role) (4)
1 返回正在管理的角色列表。
2 如果角色中的所有端点都在运行,则返回 true
3 如果角色中的所有端点都不在运行,则返回 true
4 返回 组件名称:运行状态 的映射。组件名称通常是 bean 名称。