在 Elasticsearch7.15版本之后,Elasticsearch官方将它的高级客户端 RestHighLevelClient标记为弃用状态。推出了全新的 Java API客户端 Elasticsearch Java API Client,该客户端也将在 Elasticsearch8.0及以后版本中成为官方推荐使用的客户端。
Elasticsearch Java API Client 支持除 Vector tile search API 和 Find structure API 之外的所有 Elasticsearch API。且支持所有API数据类型,并且不再有原始JsonValue属性。它是针对Elasticsearch8.0及之后版本的客户端,所以我们需要学习新的Elasticsearch Java API Client的使用方法。
前面使用的是 ES 7.x的版本,这次使用 ES 8.1.3版本。使用Docker搭建环境还是蛮简单的。
一、Springboot整合ES8
引入依赖
co.elastic.clients
elasticsearch-java
8.1.3
.fasterxml.jackson.core
jackson-databind
2.13.3
注意
- ES8 API使用大量的Builder模式,所以我们在使用API时,也尽量使用它。
1、ES配置类
Java连接 Elasticsearch8的核心步骤
- 先创建 RestClient。
- 再基于 RestClient创建 ElasticsearchTransport。
- 基于 ElasticsearchTransport创建 ElasticsearchClient。
不论是直连,还是带安全检查的连接,都是这个不变的核心步骤。根据业务可能会会加一点参数配置等。
// 配置的前缀
@ConfigurationProperties(prefix = "elasticsearch")
@Configuration
public class ESClientConfig {
@Setter
private String hosts;
@Bean
public ElasticsearchClient elasticsearchClient() {
HttpHost[] httpHosts = toHttpHost();
// Create the RestClient
RestClient restClient = RestClient.builder(httpHosts).build();
// Create the transport ith a Jackson mapper
RestClientTransport transport = ne RestClientTransport(restClient, ne JacksonJsonpMapper());
// create the API client
return ne ElasticsearchClient(transport);
}
@Bean
public ElasticsearchAsyncClient elasticsearchAsyncClient() {
HttpHost[] httpHosts = toHttpHost();
RestClient restClient = RestClient.builder(httpHosts).build();
RestClientTransport transport = ne RestClientTransport(restClient, ne JacksonJsonpMapper());
return ne ElasticsearchAsyncClient(transport);
}
private HttpHost[] toHttpHost() {
if (!StringUtils.hasLength(hosts)) {
thro ne RuntimeException("invalid elasticsearch configuration. elasticsearch.hosts不能为空!");
}
// 多个IP逗号隔开
String[] hostArray = hosts.split(",");
HttpHost[] httpHosts = ne HttpHost[hostArray.length];
HttpHost httpHost;
for (int i = 0; i < hostArray.length; i++) {
String[] strings = hostArray[i].split(":");
httpHost = ne HttpHost(strings[0], Integer.parseInt(strings[1]), "http");
httpHosts[i] = httpHost;
}
return httpHosts;
}
}
2、配置文件
在application.yml配置文件中添加 ES的服务地址等信息。
## ES配置@ConfigurationProperties(prefix = "elasticsearch") //配置的前缀
elasticsearch:
# 多个IP逗号隔开
hosts: 192.168.xxx.xxx:9200
3、单元测试
启动类没什么变化,和以前一样。我们直接写一个测试类来操作ES。
@RunWith(SpringRunner.class)
@SpringBootTest
public class ESClientConfigTest {
@Autoired
private ElasticsearchClient client;
@Test
public void createIndex() thros IOException {
CreateIndexResponse products = client.indices().create(c -> c.index("db_idx5"));
System.out.println(products.acknoledged());
}
@Test
public void createExi() thros IOException {
BooleanResponse exists = client.indices().exists(e -> e.index("db_idx5"));
System.out.println(exists.value());
}
}
测试ok,到此Springboot整合ES8就ok了。
二、索引操作
1、业务类
1)接口
public interface IndexService {
void createIndex(String name) thros IOException;
void createIndex(String name, Function> settingFn,
Function> mappingFn) thros IOException;
void deleteIndex(String name) thros IOException;
void updateIndexProperty(String name, HashMap propertyMap) thros IOException;
GetIndexResponse getIndexList() thros IOException;
GetIndexResponse getIndexDetail(String name) thros IOException;
boolean indexExists(String name) thros IOException;
}
2)实现类
@Service
@Slf4j
public class IndexServiceImpl implements IndexService {
@Autoired
private ElasticsearchClient elasticsearchClient;
@Override
public void createIndex(String name) thros IOException {
//ApplicationContext applicationContext;
CreateIndexResponse response = elasticsearchClient.indices().create(c -> c.index(name));
log.info("createIndex方法,acknoledged={}", response.acknoledged());
}
@Override
public void createIndex(String name,
Function> settingFn,
Function> mappingFn) thros IOException {
CreateIndexResponse response = elasticsearchClient
.indices()
.create(c -> c
.index(name)
.settings(settingFn)
.mappings(mappingFn)
);
log.info("createIndex方法,acknoledged={}", response.acknoledged());
}
@Override
public void deleteIndex(String name) thros IOException {
DeleteIndexResponse response = elasticsearchClient.indices().delete(c -> c.index(name));
log.info("deleteIndex方法,acknoledged={}", response.acknoledged());
}
@Override
public void updateIndexProperty(String name, HashMap propertyMap) thros IOException {
PutMappingResponse response = elasticsearchClient.indices()
.putMapping(typeMappingBuilder ->
typeMappingBuilder
.index(name)
.properties(propertyMap)
);
log.info("updateIndexMapping方法,acknoledged={}", response.acknoledged());
}
@Override
public GetIndexResponse getIndexList() thros IOException {
//使用 或者 _all都可以
GetIndexResponse response = elasticsearchClient.indices().get(builder -> builder.index("_all"));
log.info("getIndexList方法,response.result()={}", response.result().toString());
return response;
}
@Override
public GetIndexResponse getIndexDetail(String name) thros IOException {
GetIndexResponse response = elasticsearchClient.indices().get(builder -> builder.index(name));
log.info("getIndexDetail方法,response.result()={}", response.result().toString());
return response;
}
@Override
public boolean indexExists(String name) thros IOException {
return elasticsearchClient.indices().exists(b -> b.index(name)).value();
}
2、单元测试
@Autoired
private IndexService indexService;
@Test
public void testCreateIndex() thros Exception {
String indexName = "db_api_idx1";
indexService.createIndex(indexName);
//Assertions.assertTrue(indexService.indexExists(indexName));
//indexService.createIndex(indexName);
//Assertions.assertFalse(indexService.indexExists(indexName));
}
@Test
public void testCreateIndex2() thros Exception {
// 索引名
String indexName = "db_api_idx2";
// 构建setting
Function> settingFn = sBuilder -> sBuilder
.index(iBuilder -> iBuilder
// 三个分片
.numberOfShards("3")
// 一个副本
.numberOfReplicas("1")
);
// 索引字段,每个字段都有自己的property
Property keyordProperty = Property.of(pBuilder -> pBuilder.keyord(keyordPropertyBuilder -> keyordPropertyBuilder.ignoreAbove(256)));
Property integerProperty = Property.of(pBuilder -> pBuilder.integer(integerNumberPropertyBuilder -> integerNumberPropertyBuilder));
Property textProperty = Property.of(pBuilder -> pBuilder.text(tBuilder -> tBuilder));
// 构建mapping
Function> mappingFn = mBuilder -> mBuilder
.properties("name", keyordProperty)
.properties("age", integerProperty)
.properties("description", textProperty);
// 创建索引,并指定setting和mapping
indexService.createIndex(indexName, settingFn, mappingFn);
}
@Test
public void testIndexExists() thros Exception {
String indexName = "db_api_idx1";
System.out.println(indexService.indexExists(indexName));
}
@Test
public void testUpdateIndexProperty() thros Exception {
String indexName = "db_api_idx2";
// 索引字段,每个字段都有自己的property
Property keyordProperty = Property.of(pBuilder -> pBuilder.keyord(keyordPropertyBuilder -> keyordPropertyBuilder.ignoreAbove(1024)));
Property integerProperty = Property.of(pBuilder -> pBuilder.integer(integerNumberPropertyBuilder -> integerNumberPropertyBuilder));
Property textProperty = Property.of(pBuilder -> pBuilder.text(tBuilder -> tBuilder));
HashMap propertyMap = ne HashMap<>();
propertyMap.put("name", keyordProperty);
propertyMap.put("description", textProperty);
propertyMap.put("address", textProperty);
// 构建mapping
indexService.updateIndexProperty(indexName, propertyMap);
}
@Test
public void testGetIndexList() thros Exception {
indexService.getIndexList();
}
@Test
public void testGetIndexDetail() thros Exception {
String indexName = "db_api_idx2";
indexService.getIndexDetail(indexName);
}
@Test
public void testDeleteIndex() thros Exception {
String indexName = "db_api_idx1";
indexService.deleteIndex(indexName);
}
三、文档操作
1、业务类
注意
- 接口中的 Object类,可以定义成我们的业务实体类。
- 如果写的通用点,通过泛型,我们可以自定义一个基类,所有业务实体类继承它。
1)接口
public interface DocumentDemoService {
IndexResponse createByFluentDSL(String idxName, String idxId, Object document) thros Exception;
IndexResponse createByBuilderPattern(String idxName, String idxId, Object document) thros Exception;
IndexResponse createByJson(String idxName, String idxId, String jsonContent) thros Exception;
void createAsync(String idxName, String idxId, Object document, BiConsumer action);
BulkResponse bulkCreate(String idxName, List