devbox
IT小白
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

ES客户端RestHighLevelClient的使用_resthighlevelclient使用

作者：IT小白 | 2024-02-08 10:54:03

赞

踩

resthighlevelclient使用

1 RestHighLevelClient介绍

默认情况下，ElasticSearch使用两个端口来监听外部TCP流量。

  • 9200端口：用于所有通过HTTP协议进行的API调用。包括搜索、聚合、监控、以及其他任何使用HTTP协议的请求。所有的客户端库都会使用该端口与ElasticSearch进行交互。
  • 9300端口：是一个自定义的二进制协议，用于集群中各节点之间的通信。用于诸如集群变更、主节点选举、节点加入/离开、分片分配等事项。

RestHighLevelClient是ES的Java客户端，它是通过HTTP与ES集群进行通信。

2 引入ES依赖

  1. <!--引入es-high-level-client相关依赖  start-->
  2. <dependency>
  3.     <groupId>org.elasticsearch</groupId>
  4.     <artifactId>elasticsearch</artifactId>
  5.     <version>7.10.0</version>
  6. </dependency>
  7.  
  8. <dependency>
  9.     <groupId>org.elasticsearch.client</groupId>
  10.     <artifactId>elasticsearch-rest-client</artifactId>
  11.     <version>7.10.0</version>
  12. </dependency>
  13.  
  14. <dependency>
  15.     <groupId>org.elasticsearch.client</groupId>
  16.     <artifactId>elasticsearch-rest-high-level-client</artifactId>
  17.     <version>7.10.0</version>
  18. </dependency>
  19. <!--引入es-high-level-client相关依赖  end-->

3 使用

3.1 es的配置

  1. # es配置
  2. # es用户名
  3. elasticsearch.userName=elastic
  4. # es密码
  5. elasticsearch.password=elastic
  6. # es host ip 地址(集群)，多个以","间隔
  7. elasticsearch.hosts=127.0.0.1:9200
  8. # es 请求方式
  9. elasticsearch.scheme=http
  10. # es 连接超时时间（ms）
  11. elasticsearch.connectTimeOut=1000
  12. # es socket 连接超时时间（ms）
  13. elasticsearch.socketTimeOut=30000
  14. # es 请求超时时间（ms）
  15. elasticsearch.connectionRequestTimeOut=500
  16. # es 最大连接数
  17. elasticsearch.maxConnectNum=100
  18. # es 每个路由的最大连接数
  19. elasticsearch.maxConnectNumPerRoute=100

3.2 es客户端配置类

  1. /**
  2.  * restHighLevelClient 客户端配置类
  3.  *
  4.  */
  5. @Slf4j
  6. @Data
  7. @Configuration
  8. @ConfigurationProperties(prefix = "elasticsearch")
  9. public class ElasticsearchConfig {
  10.  
  11.     /**
  12.      * es host ip 地址（集群）
  13.      */
  14.     private String hosts;
  15.     /**
  16.      * es用户名
  17.      */
  18.     private String userName;
  19.     /**
  20.      * es密码
  21.      */
  22.     private String password;
  23.     /**
  24.      * es 请求方式
  25.      */
  26.     private String scheme;
  27.     /**
  28.      * es 连接超时时间
  29.      */
  30.     private int connectTimeOut;
  31.     /**
  32.      * es socket 连接超时时间
  33.      */
  34.     private int socketTimeOut;
  35.     /**
  36.      * es 请求超时时间
  37.      */
  38.     private int connectionRequestTimeOut;
  39.     /**
  40.      * es 最大连接数
  41.      */
  42.     private int maxConnectNum;
  43.     /**
  44.      * es 每个路由的最大连接数
  45.      */
  46.     private int maxConnectNumPerRoute;
  47.  
  48.  
  49.     /**
  50.      * 如果@Bean没有指定bean的名称，那么方法名就是bean的名称
  51.      */
  52.     @Bean(name = "restHighLevelClient")
  53.     public RestHighLevelClient restHighLevelClient() {
  54.         // 构建连接对象
  55.         RestClientBuilder builder = RestClient.builder(getEsHost());
  56.  
  57.         // 连接延时配置
  58.         builder.setRequestConfigCallback(requestConfigBuilder -> {
  59.             requestConfigBuilder.setConnectTimeout(connectTimeOut);
  60.             requestConfigBuilder.setSocketTimeout(socketTimeOut);
  61.             requestConfigBuilder.setConnectionRequestTimeout(connectionRequestTimeOut);
  62.             return requestConfigBuilder;
  63.         });
  64.  
  65.         // 连接数配置
  66.         builder.setHttpClientConfigCallback(httpClientBuilder -> {
  67.             httpClientBuilder.setMaxConnTotal(maxConnectNum);
  68.             httpClientBuilder.setMaxConnPerRoute(maxConnectNumPerRoute);
  69.             httpClientBuilder.setDefaultCredentialsProvider(getCredentialsProvider());
  70.             return httpClientBuilder;
  71.         });
  72.  
  73.         return new RestHighLevelClient(builder);
  74.     }
  75.  
  76.     private HttpHost[] getEsHost() {
  77.         // 拆分地址（es为多节点时，不同host以逗号间隔）
  78.         List<HttpHost> hostLists = new ArrayList<>();
  79.         String[] hostList = hosts.split(",");
  80.         for (String addr : hostList) {
  81.             String host = addr.split(":")[0];
  82.             String port = addr.split(":")[1];
  83.             hostLists.add(new HttpHost(host, Integer.parseInt(port), scheme));
  84.         }
  85.         // 转换成 HttpHost 数组
  86.         return hostLists.toArray(new HttpHost[]{});
  87.     }
  88.  
  89.     private CredentialsProvider getCredentialsProvider() {
  90.         // 设置用户名、密码
  91.         CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
  92.         credentialsProvider.setCredentials(AuthScope.ANY, new UsernamePasswordCredentials(userName, password));
  93.         return credentialsProvider;
  94.     }
  95. }

3.3 es的使用

3.3.1 创建es索引

3.3.1.1 创建es索引的工具类

创建es索引的工具类如下所示。

  1. /**
  2.  * 操作ES索引
  3.  *
  4.  */
  5. @Slf4j
  6. @Service
  7. public class EsIndexOperation {
  8.  
  9.     @Resource
  10.     private RestHighLevelClient restHighLevelClient;
  11.     private final RequestOptions options = RequestOptions.DEFAULT;
  12.  
  13.     /**
  14.      * 判断索引是否存在
  15.      */
  16.     public boolean checkIndex(String index) {
  17.         try {
  18.             return restHighLevelClient.indices().exists(new GetIndexRequest(index), options);
  19.         } catch (Exception e) {
  20.             log.error("EsIndexOperation checkIndex error.", e);
  21.         }
  22.         return Boolean.FALSE;
  23.     }
  24.  
  25.     /**
  26.      * 创建索引
  27.      *
  28.      * @param indexName         es索引名
  29.      * @param esSettingFilePath es索引的alias、settings和mapping的配置文件
  30.      */
  31.     public boolean createIndex(String indexName, String esSettingFilePath) {
  32.         String aliases = null;
  33.         String mappings = null;
  34.         String settings = null;
  35.         if (StringUtils.isNotBlank(esSettingFilePath)) {
  36.             try {
  37.                 String fileContent = FileUtils.readFileContent(esSettingFilePath);
  38.                 if (StringUtils.isNotBlank(fileContent)) {
  39.                     JSONObject jsonObject = JSON.parseObject(fileContent);
  40.                     aliases = jsonObject.getString("aliases");
  41.                     mappings = jsonObject.getString("mappings");
  42.                     settings = jsonObject.getString("settings");
  43.                 }
  44.             } catch (Exception e) {
  45.                 log.error("createIndex error.", e);
  46.                 return false;
  47.             }
  48.         }
  49.  
  50.         if (checkIndex(indexName)) {
  51.             log.error("createIndex indexName:[{}]已存在", indexName);
  52.             return false;
  53.         }
  54.  
  55.         CreateIndexRequest request = new CreateIndexRequest(indexName);
  56.         if ((StringUtils.isNotBlank(aliases))) {
  57.             request.aliases(aliases, XContentType.JSON);
  58.         }
  59.  
  60.         if (StringUtils.isNotBlank(mappings)) {
  61.             request.mapping(mappings, XContentType.JSON);
  62.         }
  63.  
  64.         if (StringUtils.isNotBlank(settings)) {
  65.             request.settings(settings, XContentType.JSON);
  66.         }
  67.  
  68.         try {
  69.             this.restHighLevelClient.indices().create(request, options);
  70.             return true;
  71.         } catch (IOException e) {
  72.             log.error("EsIndexOperation createIndex error.", e);
  73.             return false;
  74.         }
  75.     }
  76.  
  77.     /**
  78.      * 删除索引
  79.      */
  80.     public boolean deleteIndex(String indexName) {
  81.         try {
  82.             if (checkIndex(indexName)) {
  83.                 DeleteIndexRequest request = new DeleteIndexRequest(indexName);
  84.                 AcknowledgedResponse response = restHighLevelClient.indices().delete(request, options);
  85.                 return response.isAcknowledged();
  86.             }
  87.         } catch (Exception e) {
  88.             log.error("EsIndexOperation deleteIndex error.", e);
  89.         }
  90.         return Boolean.FALSE;
  91.     }
  92. }
3.3.1.2 读取文件的工具类
  1. /**
  2.  * 文件操作类
  3.  */
  4. @Slf4j
  5. public class FileUtils {
  6.  
  7.     /**
  8.      * 读取项目resources文件夹下的文件
  9.      *
  10.      * @param filePath 文件路径
  11.      * @return 文件内容
  12.      */
  13.     public static String readFileContent(String filePath) {
  14.         try {
  15.             BufferedReader reader = new BufferedReader(new FileReader(filePath));
  16.             String line;
  17.             StringBuilder stringBuilder = new StringBuilder();
  18.             while ((line = reader.readLine()) != null) {
  19.                 stringBuilder.append(line);
  20.             }
  21.  
  22.             reader.close();
  23.             return stringBuilder.toString();
  24.         } catch (IOException e) {
  25.             log.error("readFileContent error.", e);
  26.         }
  27.  
  28.         return null;
  29.     }
  30.     
  31.  
  32.     public static void main(String[] args) {
  33.         String filePath = "src/main/resources/es/mappings_test20231216.txt";
  34.         String fileContent = readFileContent(filePath);
  35.     }
  36.  
  37. }
3.3.1.3 测试创建es索引

（1）在“resources”文件夹下创建es索引的配置文件

配置文件内容如下所示。

  1. {
  2. 	"aliases": {
  3. 		"test": {}
  4. 	},
  5. 	"mappings": {
  6. 		"properties": {
  7.             "name": {
  8.                 "type": "text",
  9.                 "fields": {
  10.                     "keyword": {
  11.                         "type": "keyword",
  12.                         "ignore_above": 256
  13.                     }
  14.                 }
  15.             },
  16. 			"address": {
  17. 				"type": "text",
  18. 				"fields": {
  19. 					"keyword": {
  20. 						"type": "keyword",
  21. 						"ignore_above": 256
  22. 					}
  23. 				}
  24. 			}
  25. 		}
  26. 	},
  27. 	"settings": {
  28. 		"index": {
  29. 			"number_of_shards": "1",
  30. 			"number_of_replicas": "1"
  31. 		}
  32. 	}
  33. }

（2）读取es索引的配置文件，创建es索引

  1.     @Test
  2.     public void createIndex() {
  3.         String indexName = "test_1216";
  4.         String filePath = "src/main/resources/es/mappings_test20231216.txt";
  5.         boolean b = esIndexOperation.createIndex(indexName, filePath);
  6.         Assert.assertTrue(b);
  7.     }

（3）查看创建结果

通过命令 GET /test 查看es索引创建结果，结果如下所示。

  1. {
  2.   "test_1216" : {
  3.     "aliases" : {
  4.       "test" : { }
  5.     },
  6.     "mappings" : {
  7.       "properties" : {
  8.         "address" : {
  9.           "type" : "text",
  10.           "fields" : {
  11.             "keyword" : {
  12.               "type" : "keyword",
  13.               "ignore_above" : 256
  14.             }
  15.           }
  16.         },
  17.         "name" : {
  18.           "type" : "text",
  19.           "fields" : {
  20.             "keyword" : {
  21.               "type" : "keyword",
  22.               "ignore_above" : 256
  23.             }
  24.           }
  25.         }
  26.       }
  27.     },
  28.     "settings" : {
  29.       "index" : {
  30.         "routing" : {
  31.           "allocation" : {
  32.             "include" : {
  33.               "_tier_preference" : "data_content"
  34.             }
  35.           }
  36.         },
  37.         "number_of_shards" : "1",
  38.         "provided_name" : "test_1216",
  39.         "creation_date" : "1702723364945",
  40.         "number_of_replicas" : "1",
  41.         "uuid" : "RCAhqjPZSG-n4fse3cot4A",
  42.         "version" : {
  43.           "created" : "7100099"
  44.         }
  45.       }
  46.     }
  47.   }
  48. }

3.3.2 查询操作

3.3.2.1 常用查询
  1. /**
  2.  * 查询操作
  3.  *
  4.  */
  5. @Slf4j
  6. @Service
  7. public class EsQueryOperation {
  8.  
  9.     @Resource
  10.     private RestHighLevelClient client;
  11.     private final RequestOptions options = RequestOptions.DEFAULT;
  12.  
  13.     /**
  14.      * 查询总数
  15.      */
  16.     public Long count(String indexName) {
  17.         CountRequest countRequest = new CountRequest(indexName);
  18.         try {
  19.             CountResponse countResponse = client.count(countRequest, options);
  20.             return countResponse.getCount();
  21.         } catch (Exception e) {
  22.             log.error("EsQueryOperation count error.", e);
  23.         }
  24.         return 0L;
  25.     }
  26.  
  27.     /**
  28.      * 查询数据集
  29.      */
  30.     public List<Map<String, Object>> list(String indexName, SearchSourceBuilder sourceBuilder) {
  31.         SearchRequest searchRequest = new SearchRequest(indexName);
  32.         searchRequest.source(sourceBuilder);
  33.         try {
  34.             SearchResponse searchResp = client.search(searchRequest, options);
  35.             List<Map<String, Object>> data = new ArrayList<>();
  36.             SearchHit[] searchHitArr = searchResp.getHits().getHits();
  37.             for (SearchHit searchHit : searchHitArr) {
  38.                 Map<String, Object> temp = searchHit.getSourceAsMap();
  39.                 temp.put("id", searchHit.getId());
  40.                 data.add(temp);
  41.             }
  42.             return data;
  43.         } catch (Exception e) {
  44.             log.error("EsQueryOperation list error.", e);
  45.         }
  46.         return null;
  47.     }
  48.  
  49.  
  50. }

3.3.2.2 测试
  1.     @Test
  2.     public void list() {
  3.         String indexName = "test";
  4.         // 查询条件
  5.         SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
  6.         BoolQueryBuilder queryBuilder = QueryBuilders.boolQuery();
  7.         queryBuilder.must(QueryBuilders.termQuery("address", "hunan"));
  8.         queryBuilder.mustNot(QueryBuilders.matchQuery("name", "Jack"));
  9.         sourceBuilder.query(queryBuilder);
  10.         // 分页查询
  11.         sourceBuilder.from(0);
  12.         sourceBuilder.size(1);
  13.         List<Map<String, Object>> list = esQueryOperation.list(indexName, sourceBuilder);
  14.         Assert.assertTrue(true);
  15.     }

3.3.3 增删改操作

3.3.3.1 常用增删改操作
  1. /**
  2.  * 增删改数据
  3.  *
  4.  */
  5. @Slf4j
  6. @Service
  7. public class EsDataOperation {
  8.  
  9.     @Resource
  10.     private RestHighLevelClient client;
  11.     private final RequestOptions options = RequestOptions.DEFAULT;
  12.  
  13.     /**
  14.      * 写入数据
  15.      */
  16.     public boolean insert(String indexName, Map<String, Object> dataMap) {
  17.         try {
  18.             BulkRequest request = new BulkRequest();
  19.             request.add(new IndexRequest(indexName).opType("create")
  20.                     .id(dataMap.get("id").toString())
  21.                     .source(dataMap, XContentType.JSON));
  22.             this.client.bulk(request, options);
  23.             return Boolean.TRUE;
  24.         } catch (Exception e) {
  25.             log.error("EsDataOperation insert error.", e);
  26.         }
  27.         return Boolean.FALSE;
  28.     }
  29.  
  30.     /**
  31.      * 批量写入数据
  32.      */
  33.     public boolean batchInsert(String indexName, List<Map<String, Object>> userIndexList) {
  34.         try {
  35.             BulkRequest request = new BulkRequest();
  36.             for (Map<String, Object> dataMap : userIndexList) {
  37.                 request.add(new IndexRequest(indexName).opType("create")
  38.                         .id(dataMap.get("id").toString())
  39.                         .source(dataMap, XContentType.JSON));
  40.             }
  41.             this.client.bulk(request, options);
  42.             return Boolean.TRUE;
  43.         } catch (Exception e) {
  44.             log.error("EsDataOperation batchInsert error.", e);
  45.         }
  46.         return Boolean.FALSE;
  47.     }
  48.  
  49.     /**
  50.      * 根据id更新数据，可以直接修改索引结构
  51.      *
  52.      * @param refreshPolicy 数据刷新策略
  53.      */
  54.     public boolean update(String indexName, Map<String, Object> dataMap, WriteRequest.RefreshPolicy refreshPolicy) {
  55.         try {
  56.             UpdateRequest updateRequest = new UpdateRequest(indexName, dataMap.get("id").toString());
  57.             updateRequest.setRefreshPolicy(refreshPolicy);
  58.             updateRequest.doc(dataMap);
  59.             this.client.update(updateRequest, options);
  60.             return Boolean.TRUE;
  61.         } catch (Exception e) {
  62.             log.error("EsDataOperation update error.", e);
  63.         }
  64.         return Boolean.FALSE;
  65.     }
  66.  
  67.     /**
  68.      * 删除数据
  69.      */
  70.     public boolean delete(String indexName, String id) {
  71.         try {
  72.             DeleteRequest deleteRequest = new DeleteRequest(indexName, id);
  73.             this.client.delete(deleteRequest, options);
  74.             return Boolean.TRUE;
  75.         } catch (Exception e) {
  76.             log.error("EsDataOperation delete error.", e);
  77.         }
  78.         return Boolean.FALSE;
  79.     }
  80. }
3.3.3.2 测试
  1.     @Test
  2.     public void insert(){
  3.         String indexName = "test";
  4.         HashMap<String, Object> hashMap = new HashMap<>();
  5.         hashMap.put("id",4);
  6.         hashMap.put("name","tom");
  7.         hashMap.put("address","Jiangsu");
  8.         boolean flag = esDataOperation.insert(indexName, hashMap);
  9.         Assert.assertTrue(true);
  10.     }
  11.  
  12.     @Test
  13.     public void update(){
  14.         String indexName = "test";
  15.         HashMap<String, Object> hashMap = new HashMap<>();
  16.         hashMap.put("id", 5);
  17.         hashMap.put("name", "jack7");
  18.         boolean update = esDataOperation.update(indexName, hashMap, WriteRequest.RefreshPolicy.WAIT_UNTIL);
  19.         Assert.assertTrue(true);
  20.     }

4 参考文献

（1）elasticsearch学习（七）：es客户端RestHighLevelClient_炎升的博客

（2）中间件：ElasticSearch组件RestHighLevelClient用法详解

（3）java api 实现es中的索引管理_createindexrequest

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/IT小白/article/detail/68633
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号