这段文档是关于 Apache Ignite 与 Spring Boot 集成 的官方指南。它的核心目标是:让开发者能像使用普通 Spring Boot 组件一样,轻松地在项目中集成 Ignite(无论是服务端节点、客户端节点,还是 Thin Client)。
下面我们来逐层拆解、通俗易懂地理解这份文档的内容。
🌟 一、背景:为什么需要这个集成?
在传统的 Java + Spring 应用中,要使用 Ignite,你需要:
java
Ignite ignite = Ignition.start("ignite-config.xml");
然后手动管理它的生命周期,还要处理配置、依赖注入等问题。
而现代开发都用 Spring Boot,它讲究:
- 自动装配(Auto-configuration)
- 配置集中化(
application.yml
) - Bean 自动管理
- 开箱即用
所以 Apache Ignite 提供了两个 Spring Boot Starter 扩展,让你可以:
✅ 像使用 spring-boot-starter-data-jpa
一样,轻松集成 Ignite!
🔧 二、两种集成方式(对应两种客户端模型)
Ignite 支持两种连接模式:
类型 | 中文名 | 特点 | 适用场景 |
---|---|---|---|
Thick Client / Server Node | 厚客户端 / 服务端节点 | 功能完整、直连集群、性能高 | 需要高性能、复杂计算、数据本地化 |
Thin Client | 轻客户端 | 协议简单、跨语言、低开销 | Web 应用、微服务、跨语言访问 |
⚠️ 注意:Thick Client 实际上是一个完整的 Ignite 节点(只是不存数据),而 Thin Client 是一个轻量级协议客户端。
📦 三、方式一:自动配置 Thick Client 或 Server 节点
1. 添加依赖
xml
<dependency>
<groupId>org.apache.ignite</groupId>
<artifactId>ignite-spring-boot-autoconfigure-ext</artifactId>
<version>1.0.0</version>
</dependency>
✅ 引入后,Spring Boot 启动时会自动创建一个 Ignite 实例(可以是服务端或客户端节点)。
2. 配置方式一:通过 application.yml
(推荐)
使用 ignite:
前缀写配置,就像配置数据库一样:
yaml
ignite:
igniteInstanceName: properties-instance-name
communicationSpi:
localPort: 5555
dataStorageConfiguration:
defaultDataRegionConfiguration:
initialSize: 10485760 # 10MB
dataRegionConfigurations:
- name: my-dataregion
initialSize: 104857600 # 100MB
cacheConfiguration:
- name: accounts
queryEntities:
- tableName: ACCOUNTS
keyFieldName: ID
keyType: java.lang.Long
valueType: java.lang.Object
fields:
ID: java.lang.Long
amount: java.lang.Double
updateDate: java.util.Date
- name: my-cache2
📌 说明:
- 这些配置项几乎和
IgniteConfiguration
类的 setter 方法一一对应。 - Spring Boot 会自动把这些 YAML 配置转成
IgniteConfiguration
对象。 - 自动调用
Ignition.start(config)
启动节点。
3. 配置方式二:通过 Java 代码(更灵活)
✅ 方法 A:完全自定义 IgniteConfiguration
java
@Bean
public IgniteConfiguration igniteConfiguration() {
IgniteConfiguration cfg = new IgniteConfiguration();
cfg.setIgniteInstanceName("my-ignite");
// 其他配置...
return cfg;
}
🔔 注意 :一旦你提供了这个 Bean,YAML 中的
ignite:
配置将被忽略!
✅ 方法 B:增强 YAML 配置(推荐组合使用)
java
@Bean
public IgniteConfigurer nodeConfigurer() {
return cfg -> {
// 在 YAML 基础上追加配置
cfg.setIgniteInstanceName("my-ignite");
cfg.setMetricsExpireTime(3600_000); // 比如加个指标过期时间
};
}
🎯 这种方式最灵活:YAML 写基础配置 + Java 写动态/复杂逻辑
📦 四、方式二:自动配置 Thin Client(轻客户端)
1. 添加依赖
xml
<dependency>
<groupId>org.apache.ignite</groupId>
<artifactId>ignite-spring-boot-thin-client-autoconfigure-ext</artifactId>
<version>1.0.0</version>
</dependency>
✅ 引入后,Spring Boot 启动时会自动建立一个到 Ignite 集群的 Thin Client 连接。
2. 配置方式一:通过 application.yml
使用 ignite-client:
前缀:
yaml
ignite-client:
addresses: 127.0.0.1:10800 # 必填!集群地址
timeout: 10000 # 超时时间(毫秒)
tcpNoDelay: false # 是否禁用 Nagle 算法
✅ 自动创建
IgniteClient
实例,并注册为 Spring Bean。
3. 配置方式二:通过 Java 代码
✅ 方法 A:完全自定义 ClientConfiguration
java
@Bean
public ClientConfiguration clientConfiguration() {
ClientConfiguration cfg = new ClientConfiguration();
cfg.setAddresses("127.0.0.1:10800");
return cfg;
}
🔔 同样,提供这个 Bean 后,YAML 配置会被忽略。
✅ 方法 B:增强 YAML 配置
java
@Bean
public IgniteClientConfigurer configurer() {
return cfg -> cfg.setSendBufferSize(64 * 1024); // 修改发送缓冲区大小
}
🎯 先读 YAML,再用 Java 补充配置,非常实用。
🧰 五、如何在业务代码中使用?
无论哪种方式,最终都会生成一个 Spring Bean:
如果是 Thick Client / Server Node:
java
@Autowired
private Ignite ignite;
// 使用示例
IgniteCache<Long, Account> cache = ignite.cache("accounts");
Account acc = cache.get(1L);
如果是 Thin Client:
java
@Autowired
private IgniteClient igniteClient;
// 使用示例
ClientCache<Long, Account> cache = igniteClient.cache("accounts");
Account acc = cache.get(1L);
✅ 完全符合 Spring 编程习惯,无需手动管理连接。
🧠 六、关键理解要点总结
问题 | 理解 |
---|---|
这是什么? | 这是 Ignite 官方提供的 Spring Boot Starter 扩展,用于简化 Ignite 集成。 |
有什么好处? | 无需手动 start() ,配置写在 application.yml ,自动注入 Ignite 或 IgniteClient 。 |
两种扩展区别? | * autoconfigure-ext :用于启动完整节点(服务端或厚客户端) * thin-client-autoconfigure-ext :用于连接已有集群的轻客户端 |
配置优先级? | Java Bean > YAML 配置(如果你提供了 IgniteConfiguration Bean,YAML 就无效了) |
能不能混合用? | ❌ 不建议同时引入两个扩展,容易冲突。根据需求选其一。 |
🎯 七、怎么选?Thick 还是 Thin?
场景 | 推荐方式 |
---|---|
需要部署 Ignite 服务端节点 | ✅ ignite-spring-boot-autoconfigure-ext |
需要高性能、复杂计算任务 | ✅ ignite-spring-boot-autoconfigure-ext (厚客户端) |
是一个 Web 微服务,只想读写缓存 | ✅ ignite-spring-boot-thin-client-autoconfigure-ext |
跨语言环境(Python/Node.js)调用 Java 集群 | ✅ Thin Client |
想用 SQL 查询缓存数据 | 两者都支持,Thin Client 更简单 |
🛠️ 八、完整项目结构建议
src/
├── main/
│ ├── resources/
│ │ └── application.yml <-- 写 ignite: 或 ignite-client:
│ └── java/
│ └── com/example/demo/
│ ├── DemoApplication.java
│ ├── config/ <-- 放 Java 配置类
│ │ └── IgniteConfig.java
│ └── service/ <-- 业务代码
│ └── CacheService.java <-- @Autowired Ignite/IgniteClient
✅ 九、最佳实践建议
- 优先使用 YAML 配置,清晰、可维护。
- 复杂逻辑用
Configurer
增强,比如动态设置 IP、加密密码等。 - 不要同时引入两个扩展,避免冲突。
- Thin Client 更适合微服务架构,Thick Client 更适合独立部署。
- 记得关闭资源 :在
@PreDestroy
中调用ignite.close()
或client.close()
。
🧩 十、一句话总结
Apache Ignite 的 Spring Boot 集成扩展,让你可以用"Spring 的方式"来配置和使用 Ignite------无论是作为服务端节点、厚客户端,还是轻客户端,都能实现自动装配、配置集中化、Bean 注入,极大提升开发效率和可维护性。
如果你想,我可以为你生成:
- 一个完整的 Spring Boot + Ignite Thick Client 示例项目(含
pom.xml
+application.yml
+ 代码) - 或者一个 Web 服务 + Thin Client 的 REST API 示例
需要吗?😊