Spring Integration 提供通道适配器和其他实用程序组件，用于与内存中数据网格 Hazelcast 进行交互。Spring中文文档

您需要将此依赖项包含在项目中：Spring中文文档

<dependency>
    <groupId>org.springframework.integration</groupId>
    <artifactId>spring-integration-hazelcast</artifactId>
    <version>6.3.1</version>
</dependency>
compile "org.springframework.integration:spring-integration-hazelcast:6.3.1"

Hazelcast 组件的 XML 命名空间和 schemaLocation 定义如下：Spring中文文档

xmlns:int-hazelcast="http://www.springframework.org/schema/integration/hazelcast"
xsi:schemaLocation="http://www.springframework.org/schema/integration/hazelcast
          https://www.springframework.org/schema/integration/hazelcast/spring-integration-hazelcast.xsd"

Hazelcast 事件驱动的入站通道适配器

Hazelcast 提供分布式数据结构，例如：Spring中文文档

它还提供事件侦听器，以便侦听对这些数据结构所做的修改。Spring中文文档

Hazelcast 事件驱动的入站通道适配器侦听相关的缓存事件，并将事件消息发送到定义的通道。 它支持 XML 和 JavaConfig 驱动的配置。Spring中文文档

XML配置：

<int-hazelcast:inbound-channel-adapter channel="mapChannel"
                      cache="map"
                      cache-events="UPDATED, REMOVED"
                      cache-listening-policy="SINGLE" />

Hazelcast 事件驱动的入站通道适配器需要以下属性：Spring中文文档

  • channel：指定消息发送到的通道;Spring中文文档

  • cache：指定侦听的分布式对象引用。 它是必需属性;Spring中文文档

  • cache-events：指定侦听的缓存事件。 它是一个可选属性，其默认值为 。 其支持的值如下：ADDEDSpring中文文档

  • 支持的 和 缓存事件类型 ： ， ， ， 和IMapMultiMapADDEDREMOVEDUPDATEDEVICTEDEVICT_ALLCLEAR_ALL;Spring中文文档

  • 支持的缓存事件类型：、、、ReplicatedMapADDEDREMOVEDUPDATEDEVICTED;Spring中文文档

  • 支持的缓存事件类型 和 ： ， . 没有 的缓存事件类型。IListISetIQueueADDEDREMOVEDITopicSpring中文文档

  • cache-listening-policy：将缓存侦听策略指定为 或 。 它是一个可选属性，其默认值为 。 每个 Hazelcast 入站通道适配器侦听具有相同 cache-events 属性的同一缓存对象，可以接收单个事件消息或所有事件消息。 如果是，则所有 Hazelcast 入站通道适配器都侦听具有相同 cache-events 属性的同一缓存对象，将接收所有事件消息。 如果是，他们将收到唯一的事件消息。SINGLEALLSINGLEALLSINGLESpring中文文档

一些配置示例：Spring中文文档

分布式地图
<int:channel id="mapChannel"/>

<int-hazelcast:inbound-channel-adapter channel="mapChannel"
                              cache="map"
                              cache-events="UPDATED, REMOVED" />

<bean id="map" factory-bean="instance" factory-method="getMap">
    <constructor-arg value="map"/>
</bean>

<bean id="instance" class="com.hazelcast.core.Hazelcast"
            factory-method="newHazelcastInstance">
    <constructor-arg>
        <bean class="com.hazelcast.config.Config" />
    </constructor-arg>
</bean>
分布式多地图
<int-hazelcast:inbound-channel-adapter channel="multiMapChannel"
                              cache="multiMap"
                              cache-events="ADDED, REMOVED, CLEAR_ALL" />

<bean id="multiMap" factory-bean="instance" factory-method="getMultiMap">
    <constructor-arg value="multiMap"/>
</bean>
分布式列表
<int-hazelcast:inbound-channel-adapter  channel="listChannel"
                               cache="list"
                               cache-events="ADDED, REMOVED"
                               cache-listening-policy="ALL" />

<bean id="list" factory-bean="instance" factory-method="getList">
    <constructor-arg value="list"/>
</bean>
分布式集
<int-hazelcast:inbound-channel-adapter channel="setChannel" cache="set" />

<bean id="set" factory-bean="instance" factory-method="getSet">
    <constructor-arg value="set"/>
</bean>
分布式队列
<int-hazelcast:inbound-channel-adapter  channel="queueChannel"
                               cache="queue"
                               cache-events="REMOVED"
                               cache-listening-policy="ALL" />

<bean id="queue" factory-bean="instance" factory-method="getQueue">
    <constructor-arg value="queue"/>
</bean>
分布式主题
<int-hazelcast:inbound-channel-adapter channel="topicChannel" cache="topic" />

<bean id="topic" factory-bean="instance" factory-method="getTopic">
    <constructor-arg value="topic"/>
</bean>
复制的地图
<int-hazelcast:inbound-channel-adapter channel="replicatedMapChannel"
                              cache="replicatedMap"
                              cache-events="ADDED, UPDATED, REMOVED"
                              cache-listening-policy="SINGLE"  />

<bean id="replicatedMap" factory-bean="instance" factory-method="getReplicatedMap">
    <constructor-arg value="replicatedMap"/>
</bean>

Java 配置示例：

以下示例显示了一个配置。 相同的配置可用于其他分布式数据结构（、、、和）：DistributedMapIMapMultiMapReplicatedMapIListISetIQueueITopicSpring中文文档

@Bean
public PollableChannel distributedMapChannel() {
    return new QueueChannel();
}

@Bean
public IMap<Integer, String> distributedMap() {
    return hazelcastInstance().getMap("Distributed_Map");
}

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
public HazelcastEventDrivenMessageProducer hazelcastEventDrivenMessageProducer() {
    final HazelcastEventDrivenMessageProducer producer = new HazelcastEventDrivenMessageProducer(distributedMap());
    producer.setOutputChannel(distributedMapChannel());
    producer.setCacheEventTypes("ADDED,REMOVED,UPDATED,CLEAR_ALL");
    producer.setCacheListeningPolicy(CacheListeningPolicyType.SINGLE);

    return producer;
}

Hazelcast 连续查询入站通道适配器

Hazelcast 连续查询支持侦听对特定地图条目执行的修改。 Hazelcast 连续查询入站通道适配器是一个事件驱动的通道适配器，它根据定义的谓词侦听相关的分布式映射事件。Spring中文文档

@Bean
public PollableChannel cqDistributedMapChannel() {
    return new QueueChannel();
}

@Bean
public IMap<Integer, String> cqDistributedMap() {
    return hazelcastInstance().getMap("CQ_Distributed_Map");
}

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
public HazelcastContinuousQueryMessageProducer hazelcastContinuousQueryMessageProducer() {
    final HazelcastContinuousQueryMessageProducer producer =
        new HazelcastContinuousQueryMessageProducer(cqDistributedMap(), "surname=TestSurname");
    producer.setOutputChannel(cqDistributedMapChannel());
    producer.setCacheEventTypes("UPDATED");
    producer.setIncludeValue(false);

    return producer;
}
<int:channel id="cqMapChannel"/>

<int-hazelcast:cq-inbound-channel-adapter
                channel="cqMapChannel"
                cache="cqMap"
                cache-events="UPDATED, REMOVED"
                predicate="name=TestName AND surname=TestSurname"
                include-value="true"
                cache-listening-policy="SINGLE"/>

<bean id="cqMap" factory-bean="instance" factory-method="getMap">
    <constructor-arg value="cqMap"/>
</bean>

<bean id="instance" class="com.hazelcast.core.Hazelcast"
            factory-method="newHazelcastInstance">
    <constructor-arg>
        <bean class="com.hazelcast.config.Config" />
    </constructor-arg>
</bean>

它支持以下六个属性：Spring中文文档

  • channel：指定消息发送到的通道;Spring中文文档

  • cache：指定侦听的分布式映射引用。 命令的;Spring中文文档

  • cache-events：指定侦听的缓存事件。 可选属性，作为其默认值。 支持的值为 、 、 、 和ADDEDADDEDREMOVEDUPDATEDEVICTEDEVICT_ALLCLEAR_ALL;Spring中文文档

  • predicate：指定一个谓词，用于侦听对特定地图条目执行的修改。 命令的;Spring中文文档

  • include-value：指定在连续查询结果中包括 value 和 oldValue。 可选，默认值为;trueSpring中文文档

  • cache-listening-policy：将缓存侦听策略指定为 或 。 可选，默认值为 。 每个 Hazelcast CQ 入站通道适配器侦听具有相同 cache-events 属性的同一缓存对象，可以接收单个事件消息或所有事件消息。 如果是，则所有 Hazelcast CQ 入站通道适配器都侦听具有相同 cache-events 属性的同一缓存对象，将接收所有事件消息。 如果是，他们将收到唯一的事件消息。SINGLEALLSINGLEALLSINGLESpring中文文档

Hazelcast 群集监视器入站通道适配器

Hazelcast 集群监控器支持侦听对集群执行的修改。 Hazelcast Cluster Monitor 入站通道适配器是一个事件驱动的通道适配器，可侦听相关的成员资格、分布式对象、迁移、生命周期和客户端事件：Spring中文文档

@Bean
public PollableChannel eventChannel() {
    return new QueueChannel();
}

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
public HazelcastClusterMonitorMessageProducer hazelcastClusterMonitorMessageProducer() {
    HazelcastClusterMonitorMessageProducer producer = new HazelcastClusterMonitorMessageProducer(hazelcastInstance());
    producer.setOutputChannel(eventChannel());
    producer.setMonitorEventTypes("DISTRIBUTED_OBJECT");

    return producer;
}
<int:channel id="monitorChannel"/>

<int-hazelcast:cm-inbound-channel-adapter
                 channel="monitorChannel"
                 hazelcast-instance="instance"
                 monitor-types="MEMBERSHIP, DISTRIBUTED_OBJECT" />

<bean id="instance" class="com.hazelcast.core.Hazelcast"
            factory-method="newHazelcastInstance">
    <constructor-arg>
        <bean class="com.hazelcast.config.Config" />
    </constructor-arg>
</bean>

它支持以下三个属性：Spring中文文档

  • channel：指定消息发送到的通道;Spring中文文档

  • hazelcast-instance：指定用于侦听群集事件的 Hazelcast 实例引用。 它是必需属性;Spring中文文档

  • monitor-types：指定侦听的监视器类型。 它是一个可选属性，是默认值。 支持的值为 、 、 、 。MEMBERSHIPMEMBERSHIPDISTRIBUTED_OBJECTMIGRATIONLIFECYCLECLIENTSpring中文文档

Hazelcast 分布式 SQL 入站通道适配器

Hazelcast 允许在分布式地图上运行分布式查询。 Hazelcast 分布式 SQL 入站通道适配器是一个轮询入站通道适配器。 它运行定义的 distributed-sql 命令，并根据迭代类型返回结果。Spring中文文档

@Bean
public PollableChannel dsDistributedMapChannel() {
    return new QueueChannel();
}

@Bean
public IMap<Integer, String> dsDistributedMap() {
    return hazelcastInstance().getMap("DS_Distributed_Map");
}

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
@InboundChannelAdapter(value = "dsDistributedMapChannel", poller = @Poller(maxMessagesPerPoll = "1"))
public HazelcastDistributedSQLMessageSource hazelcastDistributedSQLMessageSource() {
    final HazelcastDistributedSQLMessageSource messageSource =
        new HazelcastDistributedSQLMessageSource(dsDistributedMap(),
            "name='TestName' AND surname='TestSurname'");
    messageSource.setIterationType(DistributedSQLIterationType.ENTRY);

    return messageSource;
}
<int:channel id="dsMapChannel"/>

<int-hazelcast:ds-inbound-channel-adapter
            channel="dsMapChannel"
            cache="dsMap"
            iteration-type="ENTRY"
            distributed-sql="active=false OR age >= 25 OR name = 'TestName'">
    <int:poller fixed-delay="100"/>
</int-hazelcast:ds-inbound-channel-adapter>

<bean id="dsMap" factory-bean="instance" factory-method="getMap">
    <constructor-arg value="dsMap"/>
</bean>

<bean id="instance" class="com.hazelcast.core.Hazelcast"
            factory-method="newHazelcastInstance">
    <constructor-arg>
        <bean class="com.hazelcast.config.Config" />
    </constructor-arg>
</bean>

它需要一个轮询器，并支持四个属性：Spring中文文档

  • channel：指定将消息发送到的通道。 它是必需属性;Spring中文文档

  • cache：指定要查询的分布式引用。 它是必需属性;IMapSpring中文文档

  • iteration-type：指定结果类型。 分布式 SQL 可以在 、 或 上运行。 它是一个可选属性，是默认属性。 支持的值为 和EntrySetKeySetLocalKeySetValuesVALUEENTRY, `KEYLOCAL_KEYVALUE;Spring中文文档

  • distributed-sql：指定 sql 语句的 where 子句。 这是一个必需的属性。Spring中文文档

Hazelcast 出站通道适配器

Hazelcast 出站通道适配器侦听其定义的通道，并将传入消息写入相关的分布式缓存。 它需要 或 之一用于分布式对象定义。 支持的分布式对象有：、、、、和。cachecache-expressionHazelcastHeaders.CACHE_NAMEIMapMultiMapReplicatedMapIListISetIQueueITopicSpring中文文档

@Bean
public MessageChannel distributedMapChannel() {
    return new DirectChannel();
}

@Bean
public IMap<Integer, String> distributedMap() {
    return hzInstance().getMap("Distributed_Map");
}

@Bean
public HazelcastInstance hzInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
@ServiceActivator(inputChannel = "distributedMapChannel")
public HazelcastCacheWritingMessageHandler hazelcastCacheWritingMessageHandler() {
    HazelcastCacheWritingMessageHandler handler = new HazelcastCacheWritingMessageHandler();
    handler.setDistributedObject(distributedMap());
    handler.setKeyExpression(new SpelExpressionParser().parseExpression("payload.id"));
    handler.setExtractPayload(true);
    return handler;
}
<int-hazelcast:outbound-channel-adapter channel="mapChannel"
                    cache-expression="headers['CACHE_HEADER']"
                    key-expression="payload.key"
                    extract-payload="true"/>

它需要以下属性：Spring中文文档

  • channel：指定消息发送到的通道;Spring中文文档

  • cache：指定分布式对象引用。 自选;Spring中文文档

  • cache-expression：通过 Spring Expression Language （SpEL） 指定分布式对象。 自选;Spring中文文档

  • key-expression：通过 Spring 表达式语言 （SpEL） 指定键值对的键。 可选，仅对 和分布式数据结构是必需的。IMapMultiMapReplicatedMapSpring中文文档

  • extract-payload：指定是发送整条消息还是仅发送有效负载。 可选属性，为默认属性。 如果为 true，则仅将有效负载写入分布式对象。 否则，将通过转换消息标头和有效负载来写入整个消息。trueSpring中文文档

通过在标头中设置分布式对象名称，可以通过同一通道将消息写入不同的分布式对象。 如果未定义 或 属性，则必须在请求中设置标头。cachecache-expressionHazelcastHeaders.CACHE_NAMEMessageSpring中文文档

Hazelcast 领导人选举

如果需要 leader 选举（例如，对于只有一个节点应该接收消息的高可用性消息使用者），可以使用基于 Hazelcast：LeaderInitiatorSpring中文文档

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
public LeaderInitiator initiator() {
    return new LeaderInitiator(hazelcastInstance());
}

当一个节点被选为领导者时，它将向所有应用程序侦听器发送一个。OnGrantedEventSpring中文文档

Hazelcast 消息存储

对于分布式消息传递状态管理（例如，对于持久性或跟踪消息组），提供了以下实现：QueueChannelAggregatorHazelcastMessageStoreSpring中文文档

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
public MessageGroupStore messageStore() {
    return new HazelcastMessageStore(hazelcastInstance());
}

默认情况下，用于将消息和组存储为键/值。 任何自定义都可以提供给 .SPRING_INTEGRATION_MESSAGE_STOREIMapIMapHazelcastMessageStoreSpring中文文档

Hazelcast 元数据存储

可以使用支持 Hazelcast 的实现。 使用可自定义的名称创建默认地图。ListenableMetadataStoreIMapSPRING_INTEGRATION_METADATA_STORESpring中文文档

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
public MetadataStore metadataStore() {
    return new HazelcastMetadataStore(hazelcastInstance());
}

该实现允许您注册自己的侦听器类型，以通过 监听事件。HazelcastMetadataStoreListenableMetadataStoreMetadataStoreListeneraddListener(MetadataStoreListener callback)Spring中文文档

Hazelcast 锁注册表

可以使用支持 Hazelcast 分布式支持来实现：LockRegistryILockSpring中文文档

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance();
}

@Bean
public LockRegistry lockRegistry() {
    return new HazelcastLockRegistry(hazelcastInstance());
}

当与共享（例如 Store Management），可用于跨多个应用程序实例提供此功能，以便一次只能有一个实例操作该组。MessageGroupStoreAggregatorHazelcastLockRegistrySpring中文文档

对于所有分布式操作，必须在 上启用 CP 子系统。HazelcastInstance
对于所有分布式操作，必须在 上启用 CP 子系统。HazelcastInstance

带有 Hazelcast 的消息频道

Hazelcast 和分布式对象本质上是消息传递原语，可以与 Spring Integration 核心组件一起使用，而无需在此 Hazelcast 模块中进行额外的实现。IQueueITopicSpring中文文档

QueueChannel 可以由任何 提供，包括前面提到的 Hazelcast 分布式：java.util.QueueIQueueSpring中文文档

@Bean
PollableChannel hazelcastQueueChannel(HazelcastInstance hazelcastInstance) {
    return new QueueChannel(hazelcastInstance.getQueue("springIntegrationQueue"));
}

将此配置放置在应用程序的 Hazelcast 集群中的多个节点上，将使 作为分布式，并且只有一个节点能够从中轮询单个节点。 其工作方式类似于 PollableJmsChannel、PollableKafkaChannel 或 PollableAmqpChannel。QueueChannelMessageIQueueSpring中文文档

如果生产者端不是 Spring Integration 应用程序，则无法配置 ，因此使用普通的 Hazelcast API 来生成数据。 在这种情况下，使用者端的方法是错误的：必须改用入站通道适配器解决方案：QueueChannelIQueueQueueChannelSpring中文文档

@Bean
public IQueue<String> myStringHzQueue(HazelcastInstance hazelcastInstance) {
    return hazelcastInstance.getQueue("springIntegrationQueue");
}

@Bean
@InboundChannelAdapter(channel = "stringValuesFromHzQueueChannel")
Supplier<String> fromHzIQueueSource(IQueue<String> myStringHzQueue) {
    return myStringHzQueue::poll;
}

Hazelcast 中的抽象与 JMS 中的 a 具有相似的语义：所有订阅者都接收已发布的消息。 对于一对简单的 Bean，此机制作为开箱即用的功能受支持：ITopicTopicMessageChannelSpring中文文档

@Bean
public ITopic<Message<?>> springIntegrationTopic(HazelcastInstance hazelcastInstance,
        MessageChannel fromHazelcastTopicChannel) {

    ITopic<Message<?>> topic = hazelcastInstance.getTopic("springIntegrationTopic");
	topic.addMessageListener(m -> fromHazelcastTopicChannel.send(m.getMessageObject()));
	return topic;
}

@Bean
public MessageChannel publishToHazelcastTopicChannel(ITopic<Message<?>> springIntegrationTopic) {
    return new FixedSubscriberChannel(springIntegrationTopic::publish);
}

@Bean
public MessageChannel fromHazelcastTopicChannel() {
    return new DirectChannel();
}

是 的优化变体，需要 on 初始化。 由于 是一个函数接口，因此可以为该方法提供一个简单的 lambda。 当消息发送到 时，它只是发布到 Hazelcast 上。 它也是一个函数接口，因此可以提供 lambda。 因此，订阅者将消耗发送到上述 .FixedSubscriberChannelDirectChannelMessageHandlerMessageHandlerhandleMessagepublishToHazelcastTopicChannelITopiccom.hazelcast.topic.MessageListenerITopic#addMessageListenerfromHazelcastTopicChannelITopicSpring中文文档

可以提供 . 例如，通过相应的配置，可以实现集群范围的单例：ExecutorChannelIExecutorServiceSpring中文文档

@Bean
public HazelcastInstance hazelcastInstance() {
    return Hazelcast.newHazelcastInstance(
                new Config()
                    .addExecutorConfig(new ExecutorConfig()
                         .setName("singletonExecutor")
                         .setPoolSize(1)));
}

@Bean
public MessageChannel hazelcastSingletonExecutorChannel(HazelcastInstance hazelcastInstance) {
    return new ExecutorChannel(hazelcastInstance.getExecutorService("singletonExecutor"));
}