【Elasticsearch 中心件】Elasticsearch 客户端使用案例

瑞星  金牌会员 | 2024-12-12 08:58:51 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 852|帖子 852|积分 2556

完备案例代码：https://github.com/idealzouhu/java-demos/tree/main/middleware-demos/spring-boot-elasticsearch/elasticsearch-client
  一、安装 Elasticsearch

1.1 启动 Elasticsearch

运行以下命令启动 Elasticsearch ：
  1. $ docker network create elastic
  3. $ docker pull docker.elastic.co/elasticsearch/elasticsearch:7.17.26
  5. $ docker run --name es01-test ^
  6.   --net elastic ^
  7.   -p 127.0.0.1:9200:9200 ^
  8.   -p 127.0.0.1:9300:9300 ^
  9.   -e "discovery.type=single-node" ^
  10.   -e "xpack.security.enabled=true" ^
  11.   -e "ELASTIC_PASSWORD=Elastic@123456" ^
  12.   -e "KIBANA_PASSWORD=Kibana@123456" ^
  13.   docker.elastic.co/elasticsearch/elasticsearch:7.17.26
复制代码
其中，具体参数的寄义如下：


  • -e "xpack.security.enabled=true"：启用 Elasticsearch 的安全功能。具体细节检察 Set up minimal security for Elasticsearch
  • -e "ELASTIC_PASSWORD=Elastic@123456"：为 elastic 用户设置暗码。 elastic 用户拥有超等权限。
  • -e "KIBANA_PASSWORD=Kibana@123456"：为 kibana_system 用户设置暗码。kibana_system 用户是一个为 Kibana 服务账户 创建的专用用户。它有足够的权限来与 Elasticsearch 通信，但它并没有 elastic 用户的超高权限。
1.2 启动 Kibana

Kibana 重要用来可视化和管理Elasticsearch数据。
运行以下命令启动 Kibana：
  1. $ docker pull docker.elastic.co/kibana/kibana:7.17.26
  3. $ docker run --name kib01-test ^
  4.   --net elastic ^
  5.   -p 127.0.0.1:5601:5601 ^
  6.   -e "ELASTICSEARCH_HOSTS=http://es01-test:9200" ^
  7.   -e "ELASTICSEARCH_USERNAME=elastic" ^
  8.   -e "ELASTICSEARCH_PASSWORD=Elastic@123456" ^
  9.   docker.elastic.co/kibana/kibana:7.17.26
复制代码
其中，具体参数的寄义如下：


  • ELASTICSEARCH_HOSTS=http://es01-test:9200： 指定了 Kibana 应该毗连到哪个 Elasticsearch 节点。
  • ELASTICSEARCH_USERNAME=elastic： 指定 Kibana 使用的用户名是 elastic。
  • ELASTICSEARCH_PASSWORD=Elastic@123456： elastic 用户的暗码。
   留意，我们也可以直接在 HTTP 请求里面设置用户名和参数，比方 curl -u elastic:your_elastic_password http://localhost:9200
  在启动 Kibana 后，访问 Kibana 可视化界面 http://localhost:5601。
二、客户端代码

2.1 导入依赖

创建 Spring Boot 3.0.6 项目，导入相关依赖：
  1. <dependency>
  2.     <groupId>co.elastic.clients</groupId>
  3.     <artifactId>elasticsearch-java</artifactId>
  4.     <version>7.17.26</version>
  5.     <exclusions>
  6.         <exclusion>
  7.             <groupId>org.elasticsearch.client</groupId>
  8.             <artifactId>elasticsearch-rest-client</artifactId>
  9.         </exclusion>
  10.     </exclusions>
  11. </dependency>
  13. <dependency>
  14.     <groupId>org.elasticsearch.client</groupId>
  15.     <artifactId>elasticsearch-rest-client</artifactId>
  16.     <version>7.17.26</version>
  17. </dependency>
  19. <dependency>
  20.     <groupId>com.fasterxml.jackson.core</groupId>
  21.     <artifactId>jackson-databind</artifactId>
  22.     <version>2.17.0</version>
  23. </dependency>
复制代码
如果遇到相关依赖辩说，可以检察 Installation | Elasticsearch Java API Client 7.17
2.2 设置 application.yaml

  1. spring:
  2.   application:
  3.     name: elasticsearch-client
  5. # 打印 es 的 http 请求，适合在开发调试中使用，正式环境请关闭
  6. logging:
  7.   level:
  8.     tracer: TRACE
复制代码
2.3 界说实体类

  1. @Data
  2. @AllArgsConstructor
  3. @RequiredArgsConstructor
  4. public class Account {
  5.     // ES中 ducument 的 _id
  6.     private String id;
  7.     // 解决ES中字段与实体类字段不一致的问题
  8.     @JsonProperty("account_number")
  9.     private Long accountNumber;
  10.     private String address;
  11.     private Integer age;
  12.     private Long balance;
  13.     private String city;
  14.     private String email;
  15.     private String employer;
  16.     private String firstname;
  17.     private String lastname;
  18.     private String gender;
  19.     private String state;
  20. }
复制代码
2.4 毗连 Elasticserach

  1. @Configuration
  2. public class ElasticsearchConfig {
  4.     /**
  5.      * 创建并返回一个 Elasticsearch 客户端。
  6.      *
  7.      * <p>
  8.      *     使用 RestClientBuilder 构建 RestClient，并使用 BasicCredentialsProvider 设置用户名和密码。
  9.      *     <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/7.17/connecting.html">官方客户端连接教程</a>
  10.      *     <a href="https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/7.17/_basic_authentication.html">官方基本认证教程</a>
  11.      * </p>
  12.      *
  13.      * @return 初始化好的 Elasticsearch 客户端
  14.      */
  15.     @Bean
  16.     public ElasticsearchClient esClient() {
  17.         // 1. 配置认证
  18.         String userName = "elastic";
  19.         String password = "Elastic@123456";
  20.         final CredentialsProvider credentialsProvider = new BasicCredentialsProvider();
  21.         credentialsProvider.setCredentials(
  22.                 AuthScope.ANY, new UsernamePasswordCredentials(userName, password)
  23.         );
  25.         // 2. 创建 low-level 客户端（使用身份验证）
  26.         RestClient restClient = RestClient.builder(
  27.                         new HttpHost("localhost", 9200))    // 指定 Elasticsearch 服务器的主机名和端口号
  28.                 .setHttpClientConfigCallback(httpClientBuilder ->
  29.                         httpClientBuilder.setDefaultCredentialsProvider(credentialsProvider)
  30.                 )
  31.                 .build();
  33.         // 3. 创建传输对象，使用 Jackson 映射器将 Java 对象转换为 JSON 格式
  34.         ElasticsearchTransport transport = new RestClientTransport(
  35.                 restClient, new JacksonJsonpMapper());
  37.         // 4. 创建 API 客户端
  38.         return new ElasticsearchClient(transport);
  39.     }
  41. }
复制代码
2.5 界说 Service 层接口

  1. public interface AccountElasticsearchService {
  3.     /**
  4.      * 将 Account 对象索引到 Elasticsearch 中。
  5.      *
  6.      * @param account 需要索引的账户对象
  7.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  8.      */
  9.     void indexAccount(Account account) throws IOException;
  11.     /**
  12.      * 批量将多个 Account 对象索引到 Elasticsearch 中。
  13.      *
  14.      * @param accounts 需要索引的账户对象列表
  15.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  16.      */
  17.     public void indexMultipleAccounts(List<Account> accounts) throws IOException;
  19.     /**
  20.      * 根据账户编号搜索账户信息。
  21.      *
  22.      * @param accountNumber 账户编号
  23.      * @return 匹配的账户信息，以字符串形式返回
  24.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  25.      */
  26.     String searchAccountByAccountNumber(Long accountNumber) throws IOException;
  28.     /**
  29.      * 根据账户 ID 从 Elasticsearch 获取账户信息。
  30.      *
  31.      * @param id 账户 ID
  32.      * @return 对应账户的详细信息
  33.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  34.      */
  35.     String  searchAccountById(String id) throws IOException;
  37.     /**
  38.      * 根据 firstname 和 age 查询账户。
  39.      *
  40.      * @param firstName 姓名
  41.      * @param age 年龄
  42.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  43.      */
  44.     public void searchByNameAndAge(String firstName, int age) throws IOException;
  46.     /**
  47.      * 更新账户信息。
  48.      *
  49.      * @param account 修改后的账户对象
  50.      * @return 返回更新结果信息
  51.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  52.      */
  53.     String updateAccountById(Account account) throws IOException;
  55.     /**
  56.      * 根据账户 ID 从 Elasticsearch 中删除账户信息。
  57.      *
  58.      * @param accountId 要删除的账户 ID
  59.      * @return 返回删除结果信息
  60.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  61.      */
  62.      String deleteAccountById(String accountId) throws IOException;
  64. }
复制代码
2.6 实现 Service 层功能

  1. @Slf4j
  2. @Service
  3. @RequiredArgsConstructor
  4. public class AccountElasticsearchServiceImpl implements AccountElasticsearchService {
  6.     private final ElasticsearchClient esClient;
  8.     /**
  9.      * 将 Account 对象索引到 Elasticsearch 中。
  10.      *
  11.      * @param account 需要索引的账户对象
  12.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  13.      */
  14.     @Override
  15.     public void indexAccount(Account account) throws IOException {
  16.         // 创建索引请求并执行
  17.         IndexResponse createResponse = esClient.index(i -> i
  18.                 .index("accounts")  // 指定索引名称
  19.                 .id(account.getId())      // 文档 ID, 使用 account.getId() 获取文档的唯一标识
  20.                 .document(account)        // 文档内容
  21.         );
  23.         log.info("Document indexed with ID:{}", createResponse.id());
  24.     }
  26.     /**
  27.      * 批量将多个 Account 对象索引到 Elasticsearch 中。
  28.      *
  29.      * @param accounts 需要索引的账户对象列表
  30.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  31.      */
  32.     @Override
  33.     public void indexMultipleAccounts(List<Account> accounts) throws IOException {
  34.         // 创建批量请求构建器
  35.         BulkRequest.Builder bulkRequest = new BulkRequest.Builder();
  37.         // 循环添加每个账户对象的索引请求
  38.         for (Account account : accounts) {
  39.             bulkRequest.operations(op -> op
  40.                     .index(idx -> idx
  41.                             .index("accounts")
  42.                             .id(account.getId())
  43.                             .document(account)
  44.                     )
  45.             );
  46.         }
  48.         // 执行批量请求
  49.         BulkResponse bulkResponse = esClient.bulk(bulkRequest.build());
  51.         // 打印出成功的文档 ID
  52.         if (bulkResponse.errors()) {
  53.             log.error("Bulk had errors");
  54.             for (BulkResponseItem  item : bulkResponse.items()) {
  55.                 if (item.error() != null) {
  56.                     log.error(item.error().reason());
  57.                 }
  58.             }
  59.         } else {
  60.             log.info("Bulk indexing completed successfully");
  61.         }
  62.     }
  64.    
  65.     /**
  66.      * 根据账户编号搜索账户信息。
  67.      *
  68.      * @param accountNumber 账户编号
  69.      * @return 匹配的账户信息，以字符串形式返回
  70.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  71.      */
  72.     @Override
  73.     public String searchAccountByAccountNumber(Long accountNumber) throws IOException {
  74.         // 使用 Elasticsearch 客户端进行搜索
  75.         SearchResponse<Account> searchResponse = esClient.search(s -> s
  76.                         .index("accounts")  // 指定索引名称
  77.                         .query(q -> q
  78.                                 .term(t -> t
  79.                                         .field("account_number")  // 搜索字段
  80.                                         .value(v -> v.longValue(accountNumber))  // 动态传入搜索值
  81.                                 )),
  82.                 Account.class);
  84.         // 获取总命中数
  85.         TotalHits totalHits = searchResponse.hits().total();
  86.         boolean isExactResult = totalHits.relation() == TotalHitsRelation.Eq;
  87.         if (isExactResult) {
  88.             log.info("Found exactly " + totalHits.value() + " matching account(s).");
  89.         } else {
  90.             log.info("Found more than " + totalHits.value() + " matching account(s).");
  91.         }
  93.         // 构建返回结果
  94.         StringBuilder resultBuilder = new StringBuilder("Search results:\n");
  95.         for (Hit<Account> hit : searchResponse.hits().hits()) {
  96.             Account foundAccount = hit.source();  // 获取匹配到的账户信息
  97.             if (foundAccount != null) {
  98.                 resultBuilder.append(String.format(
  99.                         "Account: %s, Name: %s %s\n",
  100.                         foundAccount.getAccountNumber(),
  101.                         foundAccount.getFirstname(),
  102.                         foundAccount.getLastname()));
  103.             }
  104.         }
  106.         // 返回结果
  107.         if (resultBuilder.length() == 0) {
  108.             return "No matching accounts found for account number: " + accountNumber;
  109.         }
  110.         return resultBuilder.toString();
  111.     }
  113.     /**
  114.      * 根据账户 ID 从 Elasticsearch 获取账户信息。
  115.      *
  116.      * @param id 账户 ID, 也是文档的唯一标识
  117.      * @return 对应账户的详细信息
  118.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  119.      */
  120.     @Override
  121.     public String searchAccountById(String id) throws IOException {
  122.         // 创建查询请求
  123.         GetResponse<Account> response = esClient.get(g -> g
  124.                         .index("accounts")
  125.                         .id(id),
  126.                 Account.class
  127.         );
  129.         // 判断是否找到对应的账户
  130.         if (response.found()) {
  131.             // 获取账户信息
  132.             Account account = response.source();
  133.             // 将账户信息转换为 JSON 字符串并返回
  134.             ObjectMapper mapper = new ObjectMapper();
  135.             return mapper.writeValueAsString(account);
  136.         }else {
  137.             return "Account not found";
  138.         }
  139.     }
  141.     /**
  142.      * 根据 firstname 和 age 查询账户。
  143.      *
  144.      * @param firstName 姓名
  145.      * @param age       年龄
  146.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  147.      */
  148.     @Override
  149.     public void searchByNameAndAge(String firstName, int age) throws IOException {
  150.         // 创建查询条件
  151.         Query firstNameQuery = MatchQuery.of(m -> m.field("firstname").query(firstName))._toQuery();
  152.         Query  ageQuery = MatchQuery.of(m -> m.field("age").query(age))._toQuery();
  154.         // 使用 bool 查询将多个条件组合起来
  155.         BoolQuery boolQuery = BoolQuery.of(
  156.                 b -> b.must(firstNameQuery).must(ageQuery)
  157.         );
  159.         // 创建搜索请求
  160.         SearchRequest searchRequest = SearchRequest.of(builder -> builder
  161.                 .index("accounts")
  162.                 .query(q -> q.bool(boolQuery))
  163.         );
  165.         // 执行查询
  166.         SearchResponse<Account> searchResponse = esClient.search(searchRequest, Account.class);
  168.         // 打印结果
  169.         System.out.println("Search results:");
  170.         for (Hit<Account> hit : searchResponse.hits().hits()) {
  171.             System.out.println("Found account: " + hit.source());
  172.         }
  173.     }
  175.     /**
  176.      * 根据账户 ID 更新账户信息。
  177.      *
  178.      * @param account 要更新的账户信息
  179.      * @return 返回更新结果信息
  180.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  181.      */
  182.     @Override
  183.     public String updateAccountById(Account account) throws IOException {
  184.         // 创建更新请求
  185.         UpdateRequest<Account, Account> updateRequest = UpdateRequest.of(builder -> builder
  186.                 .index("accounts")
  187.                 .id(account.getId())
  188.                 .doc(account)
  189.         );
  191.         // 执行更新操作
  192.         UpdateResponse<Account> updateResponse = esClient.update(updateRequest, Account.class);
  194.         // 根据更新结果构建响应信息
  195.         return "Document updated with result: " + updateResponse.result();
  196.     }
  198.     /**
  199.      * 根据账户 ID 从 Elasticsearch 中删除账户信息。
  200.      *
  201.      * @param accountId 要删除的账户 ID
  202.      * @return 返回删除结果信息
  203.      * @throws IOException 当 Elasticsearch 请求失败时抛出
  204.      */
  205.     @Override
  206.     public String deleteAccountById(String accountId) throws IOException {
  207.         // 创建删除请求
  208.         DeleteRequest deleteRequest =  DeleteRequest.of(builder -> builder
  209.                 .index("accounts")  // 指定索引
  210.                 .id(accountId)            // 指定文档 ID
  211.         );
  213.         // 执行删除操作
  214.         DeleteResponse deleteResponse = esClient.delete(deleteRequest);
  216.         // 根据删除结果构建响应信息
  217.         return "Document deleted with result: " + deleteResponse.result();
  218.     }
  220. }
复制代码
三、测试项目

3.1 添加数据

具体测试代码为：
  1. @SpringBootTest
  2. class AccountElasticsearchServiceImplTest {
  4.     @Autowired
  5.     private AccountElasticsearchService accountElasticsearchService;
  7.     @Test
  8.     void indexAccount() throws IOException {
  9.         // 创建测试数据
  10.         Account account = new Account();
  11.         account.setId("12345");
  12.         account.setAccountNumber(12345L);
  13.         account.setEmail("john.doe@example.com");
  15.         // 调用 indexAccount 方法
  16.         accountElasticsearchService.indexAccount(account);
  17.     }
  18. }
复制代码
运行效果为：
  1. 2024-12-07T13:10:42.684+08:00 TRACE 3592 --- [elasticsearch-client] [           main] tracer                                   : curl -iX PUT 'http://localhost:9200/accounts/_doc/12345' -d '{"id":"12345","email":"john.doe@example.com","account_number":12345}'
  2. # HTTP/1.1 201 Created
  3. # Location: /accounts/_doc/12345
  4. # X-elastic-product: Elasticsearch
  5. # content-type: application/json; charset=UTF-8
  6. # content-length: 160
  7. #
  8. # {"_index":"accounts","_type":"_doc","_id":"12345","_version":1,"result":"created","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":4,"_primary_term":1}
  9. 2024-12-07T13:10:42.714+08:00  INFO 3592 --- [elasticsearch-client] [           main] .e.c.s.i.AccountElasticsearchServiceImpl : Document indexed with ID:12345
复制代码
3.2 搜索数据

具体测试代码为：
  1. @SpringBootTest
  2. class AccountElasticsearchServiceImplTest {
  4.     @Autowired
  5.     private AccountElasticsearchService accountElasticsearchService;
  7.   @Test
  8.     void searchAccountByAccountNumber() throws IOException {
  9.         String result = accountElasticsearchService.searchAccountByAccountNumber(12345L);
  10.         System.out.println(result);
  11.     }
  13. }
复制代码
运行效果为：
  1. 2024-12-07T13:11:14.508+08:00 TRACE 34672 --- [elasticsearch-client] [           main] tracer                                   : curl -iX POST 'http://localhost:9200/accounts/_search?typed_keys=true' -d '{"query":{"term":{"account_number":{"value":12345}}}}'
  2. # HTTP/1.1 200 OK
  3. # X-elastic-product: Elasticsearch
  4. # content-type: application/json; charset=UTF-8
  5. # content-length: 303
  6. #
  7. # {"took":711,"timed_out":false,"_shards":{"total":1,"successful":1,"skipped":0,"failed":0},"hits":{"total":{"value":1,"relation":"eq"},"max_score":1.0,"hits":[{"_index":"accounts","_type":"_doc","_id":"12345","_score":1.0,"_source":{"id":"12345","email":"john.doe@example.com","account_number":12345}}]}}
  8. 2024-12-07T13:11:14.718+08:00  INFO 34672 --- [elasticsearch-client] [           main] .e.c.s.i.AccountElasticsearchServiceImpl : Found exactly 1 matching account(s).
  9. Search results:
  10. Account: 12345, Name: null null
复制代码
3.3 更新数据

具体测试代码为：
  1. @SpringBootTest
  2. class AccountElasticsearchServiceImplTest {
  4.     @Autowired
  5.     private AccountElasticsearchService accountElasticsearchService;
  7.   @Test
  8.     void searchAccountByAccountNumber() throws IOException {
  9.         String result = accountElasticsearchService.searchAccountByAccountNumber(12345L);
  10.         System.out.println(result);
  11.     }
  13. }
复制代码
运行效果为：
  1. 2024-12-07T13:12:56.867+08:00 TRACE 11832 --- [elasticsearch-client] [           main] tracer                                   : curl -iX POST 'http://localhost:9200/accounts/_update/12345' -d '{"doc":{"id":"12345","email":"john.doe@example.com","firstname":"John","lastname":"Doe","account_number":12345}}'
  2. # HTTP/1.1 200 OK
  3. # X-elastic-product: Elasticsearch
  4. # content-type: application/json; charset=UTF-8
  5. # content-length: 160
  6. #
  7. # {"_index":"accounts","_type":"_doc","_id":"12345","_version":2,"result":"updated","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":5,"_primary_term":1}
  8. Document updated with result: Updated
复制代码
3.4 删除数据

具体测试代码为：
  1. @SpringBootTest
  2. class AccountElasticsearchServiceImplTest {
  4.     @Autowired
  5.     private AccountElasticsearchService accountElasticsearchService;
  7.     @Test
  8.     void deleteAccountById() {
  9.         try {
  10.             String result = accountElasticsearchService.deleteAccountById("12345L");
  11.             System.out.println(result);
  12.         } catch (IOException e) {
  13.             e.printStackTrace();
  14.         }
  15.     }
  17. }
复制代码
运行效果为：
  1. 2024-12-07T13:15:10.064+08:00 TRACE 13804 --- [elasticsearch-client] [           main] tracer                                   : curl -iX DELETE 'http://localhost:9200/accounts/_doc/12345'
  2. # HTTP/1.1 200 OK
  3. # X-elastic-product: Elasticsearch
  4. # content-type: application/json; charset=UTF-8
  5. # content-length: 160
  6. #
  7. # {"_index":"accounts","_type":"_doc","_id":"12345","_version":3,"result":"deleted","_shards":{"total":2,"successful":1,"failed":0},"_seq_no":6,"_primary_term":1}
  8. Document deleted with result: Deleted
复制代码
参考资料

Connecting | Elasticsearch Java API Client 7.17
ElasticSearch8 - SpringBoot整合ElasticSearch - 王谷雨 - 博客园

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

瑞星

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表