1 RestHighLevelClient介紹
默認(rèn)情況下，ElasticSearch使用兩個(gè)端口來(lái)監(jiān)聽(tīng)外部TCP流量。
- 9200端口：用于所有通過(guò)HTTP協(xié)議進(jìn)行的API調(diào)用。包括搜索、聚合、監(jiān)控、以及其他任何使用HTTP協(xié)議的請(qǐng)求。所有的客戶端庫(kù)都會(huì)使用該端口與ElasticSearch進(jìn)行交互。
- 9300端口：是一個(gè)自定義的二進(jìn)制協(xié)議，用于集群中各節(jié)點(diǎn)之間的通信。用于諸如集群變更、主節(jié)點(diǎn)選舉、節(jié)點(diǎn)加入/離開(kāi)、分片分配等事項(xiàng)。
RestHighLevelClient是ES的Java客戶端，它是通過(guò)HTTP與ES集群進(jìn)行通信。
2 引入ES依賴(lài)
<!--引入es-high-level-client相關(guān)依賴(lài) start-->
<dependency>
<groupId>org.elasticsearch</groupId>
<artifactId>elasticsearch</artifactId>
<version>7.10.0</version>
</dependency>
<dependency>
<groupId>org.elasticsearch.client</groupId>
<artifactId>elasticsearch-rest-client</artifactId>
<version>7.10.0</version>
</dependency>
<dependency>
<groupId>org.elasticsearch.client</groupId>
<artifactId>elasticsearch-rest-high-level-client</artifactId>
<version>7.10.0</version>
</dependency>
<!--引入es-high-level-client相關(guān)依賴(lài) end-->
3 使用
3.1 es的配置
# es配置
# es用戶名
elasticsearch.userName=elastic
# es密碼
elasticsearch.password=elastic
# es host ip 地址(集群)，多個(gè)以","間隔
elasticsearch.hosts=127.0.0.1:9200
# es 請(qǐng)求方式
elasticsearch.scheme=http
# es 連接超時(shí)時(shí)間（ms）
elasticsearch.connectTimeOut=1000
# es socket 連接超時(shí)時(shí)間（ms）
elasticsearch.socketTimeOut=30000
# es 請(qǐng)求超時(shí)時(shí)間（ms）
elasticsearch.connectionRequestTimeOut=500
# es 最大連接數(shù)
elasticsearch.maxConnectNum=100
# es 每個(gè)路由的最大連接數(shù)
elasticsearch.maxConnectNumPerRoute=1003.2 es客戶端配置類(lèi)
/**
* restHighLevelClient 客戶端配置類(lèi)
*
*/
@Slf4j
@Data
@Configuration
@ConfigurationProperties(prefix = "elasticsearch")
public class ElasticsearchConfig {
/**
* es host ip 地址（集群）
*/
private String hosts;
/**
* es用戶名
*/
private String userName;
/**
* es密碼
*/
private String password;
/**
* es 請(qǐng)求方式
*/
private String scheme;
/**
* es 連接超時(shí)時(shí)間
*/
private int connectTimeOut;
/**
* es socket 連接超時(shí)時(shí)間
*/
private int socketTimeOut;
/**
* es 請(qǐng)求超時(shí)時(shí)間
*/
private int connectionRequestTimeOut;
/**
* es 最大連接數(shù)
*/
private int maxConnectNum;
/**
* es 每個(gè)路由的最大連接數(shù)
*/
private int maxConnectNumPerRoute;
/**
* 如果@Bean沒(méi)有指定bean的名稱(chēng)，那么方法名就是bean的名稱(chēng)
*/
@Bean(name = "restHighLevelClient")
public RestHighLevelClient restHighLevelClient() {
// 構(gòu)建連接對(duì)象
RestClientBuilder builder = RestClient.builder(getEsHost());
// 連接延時(shí)配置
builder.setRequestConfigCallback(requestConfigBuilder -> {
requestConfigBuilder.setConnectTimeout(connectTimeOut);
requestConfigBuilder.setSocketTimeout(socketTimeOut);
requestConfigBuilder.setConnectionRequestTimeout(connectionRequestTimeOut);
return requestConfigBuilder;
});
// 連接數(shù)配置
builder.setHttpClientConfigCallback(httpClientBuilder -> {
httpClientBuilder.setMaxConnTotal(maxConnectNum);
httpClientBuilder.setMaxConnPerRoute(maxConnectNumPerRoute);
httpClientBuilder.setDefaultCredentialsProvider(getCredentialsProvider());
return httpClientBuilder;
});
return new RestHighLevelClient(builder);
}
private HttpHost[] getEsHost() {
// 拆分地址（es為多節(jié)點(diǎn)時(shí)，不同host以逗號(hào)間隔）
List<HttpHost> hostLists = new ArrayList<>();
String[] hostList = hosts.split(",");
for (String addr : hostList) {
String host = addr.split(":")[0];
String port = addr.split(":")[1];
hostLists.add(new HttpHost(host, Integer.parseInt(port), scheme));
}
// 轉(zhuǎn)換成 HttpHost 數(shù)組
return hostLists.toArray(new HttpHost[]{});
}
private CredentialsProvider getCredentialsProvider() {
// 設(shè)置用戶名、密碼
CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password));
return credentialsProvider;
}
}3.3 es的使用
3.3.1 創(chuàng)建es索引
3.3.1.1 創(chuàng)建es索引的工具類(lèi)
創(chuàng)建es索引的工具類(lèi)如下所示。
/**
* 操作ES索引
*
*/
@Slf4j
@Service
public class EsIndexOperation {
@Resource
private RestHighLevelClient restHighLevelClient;
private final RequestOptions options = RequestOptions.DEFAULT;
/**
* 判斷索引是否存在
*/
public boolean checkIndex(String index) {
try {
return restHighLevelClient.indices().exists(new GetIndexRequest(index), options);
} catch (Exception e) {
log.error("EsIndexOperation checkIndex error.", e);
}
return Boolean.FALSE;
}
/**
* 創(chuàng)建索引
*
* @param indexName es索引名
* @param esSettingFilePath es索引的alias、settings和mapping的配置文件
*/
public boolean createIndex(String indexName, String esSettingFilePath) {
String aliases = null;
String mappings = null;
String settings = null;
if (StringUtils.isNotBlank(esSettingFilePath)) {
try {
String fileContent = FileUtils.readFileContent(esSettingFilePath);
if (StringUtils.isNotBlank(fileContent)) {
JSONObject jsonObject = JSON.parseObject(fileContent);
aliases = jsonObject.getString("aliases");
mappings = jsonObject.getString("mappings");
settings = jsonObject.getString("settings");
}
} catch (Exception e) {
log.error("createIndex error.", e);
return false;
}
}
if (checkIndex(indexName)) {
log.error("createIndex indexName:[{}]已存在", indexName);
return false;
}
CreateIndexRequest request = new CreateIndexRequest(indexName);
if ((StringUtils.isNotBlank(aliases))) {
request.aliases(aliases, XContentType.JSON);
}
if (StringUtils.isNotBlank(mappings)) {
request.mapping(mappings, XContentType.JSON);
}
if (StringUtils.isNotBlank(settings)) {
request.settings(settings, XContentType.JSON);
}
try {
this.restHighLevelClient.indices().create(request, options);
return true;
} catch (IOException e) {
log.error("EsIndexOperation createIndex error.", e);
return false;
}
}
/**
* 刪除索引
*/
public boolean deleteIndex(String indexName) {
try {
if (checkIndex(indexName)) {
DeleteIndexRequest request = new DeleteIndexRequest(indexName);
AcknowledgedResponse response = restHighLevelClient.indices().delete(request, options);
return response.isAcknowledged();
}
} catch (Exception e) {
log.error("EsIndexOperation deleteIndex error.", e);
}
return Boolean.FALSE;
}
}
3.3.1.2 讀取文件的工具類(lèi)
/**
* 文件操作類(lèi)
*/
@Slf4j
public class FileUtils {
/**
* 讀取項(xiàng)目resources文件夾下的文件
*
* @param filePath 文件路徑
* @return 文件內(nèi)容
*/
public static String readFileContent(String filePath) {
try {
BufferedReader reader = new BufferedReader(new FileReader(filePath));
String line;
StringBuilder stringBuilder = new StringBuilder();
while ((line = reader.readLine()) != null) {
stringBuilder.append(line);
}
reader.close();
return stringBuilder.toString();
} catch (IOException e) {
log.error("readFileContent error.", e);
}
return null;
}
public static void main(String[] args) {
String filePath = "src/main/resources/es/mappings_test20231216.txt";
String fileContent = readFileContent(filePath);
}
}
3.3.1.3 測(cè)試創(chuàng)建es索引
（1）在“resources”文件夾下創(chuàng)建es索引的配置文件
配置文件內(nèi)容如下所示。
{
"aliases": {
"test": {}
},
"mappings": {
"properties": {
"name": {
"type": "text",
"fields": {
"keyword": {
"type": "keyword",
"ignore_above": 256
}
}
},
"address": {
"type": "text",
"fields": {
"keyword": {
"type": "keyword",
"ignore_above": 256
}
}
}
}
},
"settings": {
"index": {
"number_of_shards": "1",
"number_of_replicas": "1"
}
}
}（2）讀取es索引的配置文件，創(chuàng)建es索引
@Test
public void createIndex() {
String indexName = "test_1216";
String filePath = "src/main/resources/es/mappings_test20231216.txt";
boolean b = esIndexOperation.createIndex(indexName, filePath);
Assert.assertTrue(b);
}（3）查看創(chuàng)建結(jié)果
通過(guò)命令?GET /test 查看es索引創(chuàng)建結(jié)果，結(jié)果如下所示。
{
"test_1216" : {
"aliases" : {
"test" : { }
},
"mappings" : {
"properties" : {
"address" : {
"type" : "text",
"fields" : {
"keyword" : {
"type" : "keyword",
"ignore_above" : 256
}
}
},
"name" : {
"type" : "text",
"fields" : {
"keyword" : {
"type" : "keyword",
"ignore_above" : 256
}
}
}
}
},
"settings" : {
"index" : {
"routing" : {
"allocation" : {
"include" : {
"_tier_preference" : "data_content"
}
}
},
"number_of_shards" : "1",
"provided_name" : "test_1216",
"creation_date" : "1702723364945",
"number_of_replicas" : "1",
"uuid" : "RCAhqjPZSG-n4fse3cot4A",
"version" : {
"created" : "7100099"
}
}
}
}
}
3.3.2?查詢操作
3.3.2.1 常用查詢
/**
* 查詢操作
*
*/
@Slf4j
@Service
public class EsQueryOperation {
@Resource
private RestHighLevelClient client;
private final RequestOptions options = RequestOptions.DEFAULT;
/**
* 查詢總數(shù)
*/
public Long count(String indexName) {
CountRequest countRequest = new CountRequest(indexName);
try {
CountResponse countResponse = client.count(countRequest, options);
return countResponse.getCount();
} catch (Exception e) {
log.error("EsQueryOperation count error.", e);
}
return 0L;
}
/**
* 查詢數(shù)據(jù)集
*/
public List<Map<String, Object>> list(String indexName, SearchSourceBuilder sourceBuilder) {
SearchRequest searchRequest = new SearchRequest(indexName);
searchRequest.source(sourceBuilder);
try {
SearchResponse searchResp = client.search(searchRequest, options);
List<Map<String, Object>> data = new ArrayList<>();
SearchHit[] searchHitArr = searchResp.getHits().getHits();
for (SearchHit searchHit : searchHitArr) {
Map<String, Object> temp = searchHit.getSourceAsMap();
temp.put("id", searchHit.getId());
data.add(temp);
}
return data;
} catch (Exception e) {
log.error("EsQueryOperation list error.", e);
}
return null;
}
}3.3.2.2 測(cè)試
@Test
public void list() {
String indexName = "test";
// 查詢條件
SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
BoolQueryBuilder queryBuilder = QueryBuilders.boolQuery();
queryBuilder.must(QueryBuilders.termQuery("address", "hunan"));
queryBuilder.mustNot(QueryBuilders.matchQuery("name", "Jack"));
sourceBuilder.query(queryBuilder);
// 分頁(yè)查詢
sourceBuilder.from(0);
sourceBuilder.size(1);
List<Map<String, Object>> list = esQueryOperation.list(indexName, sourceBuilder);
Assert.assertTrue(true);
}3.3.3?增刪改操作
3.3.3.1 常用增刪改操作
/**
* 增刪改數(shù)據(jù)
*
*/
@Slf4j
@Service
public class EsDataOperation {
@Resource
private RestHighLevelClient client;
private final RequestOptions options = RequestOptions.DEFAULT;
/**
* 寫(xiě)入數(shù)據(jù)
*/
public boolean insert(String indexName, Map<String, Object> dataMap) {
try {
BulkRequest request = new BulkRequest();
request.add(new IndexRequest(indexName).opType("create")
.id(dataMap.get("id").toString())
.source(dataMap, XContentType.JSON));
this.client.bulk(request, options);
return Boolean.TRUE;
} catch (Exception e) {
log.error("EsDataOperation insert error.", e);
}
return Boolean.FALSE;
}
/**
* 批量寫(xiě)入數(shù)據(jù)
*/
public boolean batchInsert(String indexName, List<Map<String, Object>> userIndexList) {
try {
BulkRequest request = new BulkRequest();
for (Map<String, Object> dataMap : userIndexList) {
request.add(new IndexRequest(indexName).opType("create")
.id(dataMap.get("id").toString())
.source(dataMap, XContentType.JSON));
}
this.client.bulk(request, options);
return Boolean.TRUE;
} catch (Exception e) {
log.error("EsDataOperation batchInsert error.", e);
}
return Boolean.FALSE;
}
/**
* 根據(jù)id更新數(shù)據(jù)，可以直接修改索引結(jié)構(gòu)
*
* @param refreshPolicy 數(shù)據(jù)刷新策略
*/
public boolean update(String indexName, Map<String, Object> dataMap, WriteRequest.RefreshPolicy refreshPolicy) {
try {
UpdateRequest updateRequest = new UpdateRequest(indexName, dataMap.get("id").toString());
updateRequest.setRefreshPolicy(refreshPolicy);
updateRequest.doc(dataMap);
this.client.update(updateRequest, options);
return Boolean.TRUE;
} catch (Exception e) {
log.error("EsDataOperation update error.", e);
}
return Boolean.FALSE;
}
/**
* 刪除數(shù)據(jù)
*/
public boolean delete(String indexName, String id) {
try {
DeleteRequest deleteRequest = new DeleteRequest(indexName, id);
this.client.delete(deleteRequest, options);
return Boolean.TRUE;
} catch (Exception e) {
log.error("EsDataOperation delete error.", e);
}
return Boolean.FALSE;
}
}3.3.3.2 測(cè)試
@Test
public void insert(){
String indexName = "test";
HashMap<String, Object> hashMap = new HashMap<>();
hashMap.put("id",4);
hashMap.put("name","tom");
hashMap.put("address","Jiangsu");
boolean flag = esDataOperation.insert(indexName, hashMap);
Assert.assertTrue(true);
}
@Test
public void update(){
String indexName = "test";
HashMap<String, Object> hashMap = new HashMap<>();
hashMap.put("id", 5);
hashMap.put("name", "jack7");
boolean update = esDataOperation.update(indexName, hashMap, WriteRequest.RefreshPolicy.WAIT_UNTIL);
Assert.assertTrue(true);
}4 參考文獻(xiàn)
（1）elasticsearch學(xué)習(xí)（七）：es客戶端RestHighLevelClient_炎升的博客
（2）中間件：ElasticSearch組件RestHighLevelClient用法詳解文章來(lái)源：http://www.zghlxwxcb.cn/news/detail-774427.html
（3）java api 實(shí)現(xiàn)es中的索引管理_createindexrequest文章來(lái)源地址http://www.zghlxwxcb.cn/news/detail-774427.html
到了這里，關(guān)于ES客戶端RestHighLevelClient的使用的文章就介紹完了。如果您還想了解更多內(nèi)容，請(qǐng)?jiān)谟疑辖撬阉鱐OY模板網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章，希望大家以后多多支持TOY模板網(wǎng)！
