利用 【Java】 集成 【Elasticsearch】：详细教程

Elasticsearch 是一个开源的分布式搜索引擎，它能够快速地存储、搜索和分析大量的文本数据。它基于 Apache Lucene 构建，广泛应用于日志分析、全文搜索、保举系统等场景。本文将详细介绍如安在 Java 项目中集成 Elasticsearch，包括如何配置、索引文档、查询数据、以及与 Elasticsearch 进行交互的常见操作。
1. 环境准备

在开始利用 Elasticsearch 之前，确保你已经安装了以下工具：

• Elasticsearch：你可以通过 官方文档 下载并安装 Elasticsearch。
  
• JDK：确保你已安装 Java 8 或更高版本。可以通过 java -version 下令检察 Java 版本。
  
• Maven：Maven 是 Java 的构建工具，你可以通过 官网 安装它。
  

1.1 启动 Elasticsearch

• 下载并解压 Elasticsearch。
  
• 在解压目录中打开终端，运行以下下令启动 Elasticsearch：
  

1. bin/elasticsearch

复制代码

默认环境下，Elasticsearch 会在 localhost:9200 上启动。如果启动成功，你应该能够通过浏览器或 curl 下令访问到它：

1. curl -X GET "localhost:9200/"

复制代码

你会看到雷同如下的响应：

1. {
2.   "name" : "your-node-name",
3.   "cluster_name" : "elasticsearch",
4.   "cluster_uuid" : "some-uuid",
5.   "version" : {
6.     "number" : "7.x.x",
7.     "build_flavor" : "default",
8.     "build_type" : "deb",
9.     "build_hash" : "somehash",
10.     "build_date" : "2020-10-01T12:34:56.789Z",
11.     "build_snapshot" : false,
12.     "lucene_version" : "8.x.x",
13.     "minimum_wire_compatibility_version" : "7.x.x",
14.     "minimum_index_compatibility_version" : "7.x.x"
15.   },
16.   "tagline" : "You Know, for Search"
17. }

复制代码

• 这样，Elasticsearch 就已启动并运行。
  

2. 添加依赖

Elasticsearch 提供了多个官方客户端，常用的客户端有 RestHighLevelClient 和 Elasticsearch Java Client。在这篇文章中，我们将利用 RestHighLevelClient 来进行操作。
起首，确保在 Maven 的 pom.xml 文件中添加以下依赖：

1. <dependencies>
2.     <!-- Elasticsearch Rest High Level Client -->
3.     <dependency>
4.         <groupId>org.elasticsearch.client</groupId>
5.         <artifactId>elasticsearch-rest-high-level-client</artifactId>
6.         <version>7.10.0</version> <!-- 根据你本地的版本选择合适的版本 -->
7.     </dependency>
9.     <!-- Elasticsearch Core -->
10.     <dependency>
11.         <groupId>org.elasticsearch</groupId>
12.         <artifactId>elasticsearch</artifactId>
13.         <version>7.10.0</version>
14.     </dependency>
16.     <!-- Jackson用于JSON处理 -->
17.     <dependency>
18.         <groupId>com.fasterxml.jackson.core</groupId>
19.         <artifactId>jackson-databind</artifactId>
20.         <version>2.10.3</version>
21.     </dependency>
23.     <!-- Log4j2 用于日志输出 -->
24.     <dependency>
25.         <groupId>org.apache.logging.log4j</groupId>
26.         <artifactId>log4j-core</artifactId>
27.         <version>2.13.3</version>
28.     </dependency>
29. </dependencies>

复制代码

3. 创建 Elasticsearch 客户端

在 Java 项目中利用 Elasticsearch，起首需要创建 RestHighLevelClient 客户端，它用于与 Elasticsearch 进行交互。
3.1 创建客户端

1. import org.apache.http.HttpHost;
2. import org.elasticsearch.client.RestClient;
3. import org.elasticsearch.client.RestHighLevelClient;
5. public class ElasticsearchClient {
6.     public static RestHighLevelClient createClient() {
7.         return new RestHighLevelClient(
8.                 RestClient.builder(
9.                         new HttpHost("localhost", 9200, "http")));
10.     }
12.     public static void main(String[] args) {
13.         RestHighLevelClient client = createClient();
14.         System.out.println("Elasticsearch client created successfully!");
16.         // 不要忘记关闭客户端
17.         try {
18.             client.close();
19.         } catch (IOException e) {
20.             e.printStackTrace();
21.         }
22.     }
23. }

复制代码

• RestClient.builder(new HttpHost("localhost", 9200, "http"))：通过 HttpHost 构建与 Elasticsearch 的毗连，指定服务器地址和端口。
  
• client.close()：关闭客户端毗连，释放资源。
  

4. 创建索引和添加文档

4.1 创建索引

在 Elasticsearch 中，数据被存储为文档，文档属于索引（雷同于数据库中的表）。我们起首创建一个索引，用于存储数据。

1. import org.elasticsearch.action.admin.indices.create.CreateIndexRequest;
2. import org.elasticsearch.client.RequestOptions;
3. import org.elasticsearch.common.xcontent.XContentType;
5. public class ElasticsearchExample {
7.     public static void createIndex(RestHighLevelClient client) throws Exception {
8.         CreateIndexRequest request = new CreateIndexRequest("my_index");
9.         String jsonString = "{\n" +
10.                 "  "settings": {\n" +
11.                 "    "number_of_shards": 3,\n" +
12.                 "    "number_of_replicas": 2\n" +
13.                 "  },\n" +
14.                 "  "mappings": {\n" +
15.                 "    "properties": {\n" +
16.                 "      "name": {"type": "text"},\n" +
17.                 "      "age": {"type": "integer"},\n" +
18.                 "      "joined": {"type": "date"}\n" +
19.                 "    }\n" +
20.                 "  }\n" +
21.                 "}";
23.         request.source(jsonString, XContentType.JSON);
25.         client.indices().create(request, RequestOptions.DEFAULT);
26.         System.out.println("Index 'my_index' created successfully.");
27.     }
29.     public static void main(String[] args) throws Exception {
30.         RestHighLevelClient client = ElasticsearchClient.createClient();
31.         createIndex(client);
33.         client.close();
34.     }
35. }

复制代码

• CreateIndexRequest 用于创建索引。
  
• request.source 方法传入索引的设置（如分片数和副本数）以及映射界说（字段类型）。
  
• 利用 client.indices().create() 创建索引。
  

4.2 添加文档

接下来，我们可以向索引中添加文档。

1. import org.elasticsearch.action.index.IndexRequest;
2. import org.elasticsearch.client.RequestOptions;
3. import org.elasticsearch.index.IndexNotFoundException;
5. import java.util.HashMap;
6. import java.util.Map;
8. public class ElasticsearchExample {
10.     public static void addDocument(RestHighLevelClient client) throws Exception {
11.         Map<String, Object> jsonMap = new HashMap<>();
12.         jsonMap.put("name", "John Doe");
13.         jsonMap.put("age", 29);
14.         jsonMap.put("joined", "2024-11-06");
16.         IndexRequest request = new IndexRequest("my_index")
17.                 .id("1") // 文档 ID（可选）
18.                 .source(jsonMap);
20.         client.index(request, RequestOptions.DEFAULT);
21.         System.out.println("Document added successfully.");
22.     }
24.     public static void main(String[] args) throws Exception {
25.         RestHighLevelClient client = ElasticsearchClient.createClient();
26.         addDocument(client);
28.         client.close();
29.     }
30. }

复制代码

• IndexRequest 用于构建要插入的文档。
  
• request.source 接收一个 Map，包含要索引的字段和值。
  
• client.index(request, RequestOptions.DEFAULT) 执行添加文档的操作。
  

5. 查询文档

5.1 基本查询

1. import org.elasticsearch.action.search.SearchRequest;
2. import org.elasticsearch.action.search.SearchResponse;
3. import org.elasticsearch.index.query.QueryBuilders;
4. import org.elasticsearch.search.builder.SearchSourceBuilder;
5. import org.elasticsearch.search.hits.SearchHit;
7. public class ElasticsearchExample {
9.     public static void searchDocument(RestHighLevelClient client) throws Exception {
10.         // 创建查询请求，指定要查询的索引
11.         SearchRequest searchRequest = new SearchRequest("my_index");
13.         // 使用 SearchSourceBuilder 构建查询条件
14.         SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
15.         sourceBuilder.query(QueryBuilders.matchQuery("name", "John")); // 查找 name 字段包含 "John" 的文档
16.         searchRequest.source(sourceBuilder);
18.         // 执行查询
19.         SearchResponse response = client.search(searchRequest, RequestOptions.DEFAULT);
21.         // 打印查询结果
22.         System.out.println("Search results: ");
23.         for (SearchHit hit : response.getHits()) {
24.             System.out.println(hit.getSourceAsString());  // 输出文档的 JSON 数据
25.         }
26.     }
28.     public static void main(String[] args) throws Exception {
29.         RestHighLevelClient client = ElasticsearchClient.createClient();
30.         searchDocument(client);
32.         client.close();
33.     }
34. }

复制代码

在上述代码中：

• SearchRequest 用于指定查询的索引，这里是 "my_index"。
  
• SearchSourceBuilder 用于构建查询体，我们利用 matchQuery 来查找 name 字段中包含 "John" 的文档。
  
• client.search() 执行查询操作，返回 SearchResponse。
  
• 通过 response.getHits() 获取查询结果，然后遍历 SearchHit 来输出每个匹配文档的内容。
  

5.2 高级查询：范围查询

Elasticsearch 支持多种类型的查询，好比范围查询。以下是一个范围查询的例子，用来查找年事大于 25 的所有文档：

1. import org.elasticsearch.index.query.QueryBuilders;
3. public class ElasticsearchExample {
5.     public static void searchRange(RestHighLevelClient client) throws Exception {
6.         SearchRequest searchRequest = new SearchRequest("my_index");
7.         SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
8.         sourceBuilder.query(QueryBuilders.rangeQuery("age").gt(25)); // 查找 age > 25 的文档
9.         searchRequest.source(sourceBuilder);
11.         SearchResponse response = client.search(searchRequest, RequestOptions.DEFAULT);
13.         System.out.println("Range search results: ");
14.         for (SearchHit hit : response.getHits()) {
15.             System.out.println(hit.getSourceAsString());
16.         }
17.     }
19.     public static void main(String[] args) throws Exception {
20.         RestHighLevelClient client = ElasticsearchClient.createClient();
21.         searchRange(client);
23.         client.close();
24.     }
25. }

复制代码

在这个例子中：

• rangeQuery("age").gt(25) 表示查找 age 字段大于 25 的所有文档。
  
• 你可以利用 lt()、gte()、lte() 等方法来设置差别的查询条件。
  

5.3 聚合查询

Elasticsearch 还支持聚合查询，用于盘算统计信息，例如盘算某个字段的平均值、总和等。下面是一个简单的聚合查询示例，盘算所有文档中年事字段的平均值。

1. import org.elasticsearch.action.search.SearchRequest;
2. import org.elasticsearch.action.search.SearchResponse;
3. import org.elasticsearch.search.aggregations.AggregationBuilders;
4. import org.elasticsearch.search.aggregations.terms.Terms;
5. import org.elasticsearch.search.builder.SearchSourceBuilder;
6. import org.elasticsearch.search.aggregations.Aggregation;
8. public class ElasticsearchExample {
10.     public static void aggregationExample(RestHighLevelClient client) throws Exception {
11.         SearchRequest searchRequest = new SearchRequest("my_index");
12.         SearchSourceBuilder sourceBuilder = new SearchSourceBuilder();
14.         // 聚合查询：计算 age 字段的平均值
15.         sourceBuilder.aggregation(AggregationBuilders.avg("avg_age").field("age"));
16.         searchRequest.source(sourceBuilder);
18.         // 执行查询并获取响应
19.         SearchResponse response = client.search(searchRequest, RequestOptions.DEFAULT);
21.         // 输出聚合结果
22.         Aggregation avgAggregation = response.getAggregations().get("avg_age");
23.         double avgAge = ((org.elasticsearch.search.aggregations.metrics.Avg) avgAggregation).getValue();
24.         System.out.println("Average age: " + avgAge);
25.     }
27.     public static void main(String[] args) throws Exception {
28.         RestHighLevelClient client = ElasticsearchClient.createClient();
29.         aggregationExample(client);
31.         client.close();
32.     }
33. }

复制代码

在这个例子中：

• AggregationBuilders.avg("avg_age").field("age") 创建了一个聚合，盘算所有文档中 age 字段的平均值。
  
• 通过 response.getAggregations() 获取聚合结果，然后提取出盘算的平均值。
  

6. 更新和删除文档

6.1 更新文档

可以利用 UpdateRequest 来更新已存在的文档。这里我们演示如何更新文档中的某个字段：

1. import org.elasticsearch.action.update.UpdateRequest;
2. import org.elasticsearch.client.RequestOptions;
3. import org.elasticsearch.common.xcontent.XContentType;
5. public class ElasticsearchExample {
7.     public static void updateDocument(RestHighLevelClient client) throws Exception {
8.         UpdateRequest updateRequest = new UpdateRequest("my_index", "1"); // 指定索引和文档ID
9.         String jsonString = "{ "doc": { "age": 30 } }"; // 更新内容：将 age 改为 30
10.         updateRequest.doc(jsonString, XContentType.JSON);
12.         client.update(updateRequest, RequestOptions.DEFAULT);
13.         System.out.println("Document updated successfully.");
14.     }
16.     public static void main(String[] args) throws Exception {
17.         RestHighLevelClient client = ElasticsearchClient.createClient();
18.         updateDocument(client);
20.         client.close();
21.     }
22. }

复制代码

• UpdateRequest 用于指定要更新的文档 ID 和索引。
  
• updateRequest.doc() 方法用于指定更新的字段和新值。
  

6.2 删除文档

你也可以利用 DeleteRequest 来删除文档：

1. import org.elasticsearch.action.delete.DeleteRequest;
3. public class ElasticsearchExample {
5.     public static void deleteDocument(RestHighLevelClient client) throws Exception {
6.         DeleteRequest deleteRequest = new DeleteRequest("my_index", "1"); // 指定要删除的文档 ID 和索引
7.         client.delete(deleteRequest, RequestOptions.DEFAULT);
8.         System.out.println("Document deleted successfully.");
9.     }
11.     public static void main(String[] args) throws Exception {
12.         RestHighLevelClient client = ElasticsearchClient.createClient();
13.         deleteDocument(client);
15.         client.close();
16.     }
17. }

复制代码

• DeleteRequest 用于删除指定 ID 的文档。
  

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