Elasticsearch Java客户端集成指南:正确选择与配置API依赖

针对elasticsearch java api类缺失问题,本教程详细阐述了elasticsearch java客户端生态,区分了核心库与客户端库。文章重点介绍了elasticsearch低级rest客户端和新一代java api客户端的正确maven依赖配置,并澄清了`clientconfiguration`等常见类的来源,确保开发者能够顺利集成elasticsearch服务。

引言:理解Elasticsearch Java客户端的依赖挑战

在Elasticsearch的Java开发中,开发者常会遇到一个普遍的困惑:即使在pom.xml中添加了org.elasticsearch:elasticsearch依赖,编译器仍然无法找到诸如ClientConfiguration等特定的API类。这是因为org.elasticsearch:elasticsearch依赖主要包含了Elasticsearch的核心功能模块,而非直接用于与Elasticsearch集群交互的客户端API。Elasticsearch提供了多种Java客户端,每种都有其独立的依赖和使用场景。正确识别并引入适合项目需求的客户端依赖,是解决此类问题的关键。

Elasticsearch Java客户端生态概览

Elasticsearch的Java客户端经历了数次演变,以适应不断发展的API和最佳实践。早期的Transport Client已在Elasticsearch 7.x 版本中被弃用。当前,Elasticsearch官方主要推荐以下两种Java客户端:

  1. Elasticsearch 低级REST客户端 (Low-Level REST Client):提供与Elasticsearch集群进行HTTP通信的基础能力。
  2. Elasticsearch Java API客户端 (Java API Client):新一代高级客户端,提供类型安全的、面向对象的API,构建在低级REST客户端之上。

此外,还有一些第三方框架(如Spring Data Elasticsearch)提供了更高级的抽象,它们在内部通常会使用上述官方客户端。

Elasticsearch 低级REST客户端 (Low-Level REST Client)

低级REST客户端是一个轻量级、与版本无关的客户端,它直接通过HTTP与Elasticsearch集群通信。它提供了最小的抽象层,允许开发者完全控制请求和响应的JSON结构。

特点:

  • 轻量级:依赖少,启动快。
  • 灵活:允许发送任何有效的JSON请求。
  • 版本无关性:相对较少受Elasticsearch版本更新的影响,但仍需注意兼容性。
  • 手动JSON处理:需要开发者手动构建JSON请求体和解析JSON响应体。

Maven依赖:

要使用低级REST客户端,需要添加elasticsearch-rest-client依赖。请确保选择与您的Elasticsearch集群版本兼容的客户端版本。


    org.elasticsearch.client
    elasticsearch-rest-client
    7.17.10 

基本使用示例:

以下是如何构建一个低级REST客户端的简单示例:

import org.apache.http.HttpHost;
import org.elasticsearch.client.RestClient;
import java.io.IOException;

public class LowLevelRestClientExample {
    public static void main(String[] args) {
        // 创建RestClient实例
        RestClient restClient = RestClient.builder(
                new HttpHost("localhost", 9200, "http")) // 指定Elasticsearch集群地址和端口
                .build();

        try {
            // 在这里可以使用restClient执行各种操作,例如:
            // Request request = new Request("GET", "/");
            // Response response = restClient.performRequest(request);
            // System.out.println(response.getStatusLine().getStatusCode());
            // System.out.println(EntityUtils.toString(response.getEntity()));

            System.out.println("Elasticsearch Low-Level REST Client initialized successfully.");

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 确保客户端在使用完毕后关闭,释放资源
            try {
                restClient.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

Elasticsearch Java API客户端 (Java API Client)

Java API客户端是Elasticsearch官方推荐的新一代高级客户端,它提供了一个类型安全的、面向对象的API,大大简化了与Elasticsearch的交互。它通过代码生成的方式,确保API与Elasticsearch的最新版本保持同步,并构建在低级REST客户端之上。此客户端适用于Elasticsearch 7.x 及 8.x 版本。

特点:

  • 类型安全:所有请求和响应都映射到Java对象,减少运行时错误。
  • 面向对象:提供直观的API,符合Java开发习惯。
  • 代码生成:API结构与Elasticsearch保持一致,更新及时。
  • 更少的手动JSON处理:客户端自动处理对象的序列化和反序列化。
  • 构建于低级REST客户端之上:底层仍使用HTTP通信。

Maven依赖:

要使用Java API客户端,需要添加elasticsearch-java依赖,以及作为其底层传输层的elasticsearch-rest-client和用于JSON序列化的jackson-databind。


    co.elastic.clients
    elasticsearch-java
    7.17.10 


    org.elasticsearch.client
    elasticsearch-rest-client
    7.17.10 


    com.fasterxml.jackson.core
    jackson-databind
    2.13.4 

基本使用示例

以下是如何构建一个Java API客户端的简单示例:

import co.elastic.clients.elasticsearch.ElasticsearchClient;
import co.elastic.clients.json.jackson.JacksonJsonpMapper;
import co.elastic.clients.transport.ElasticsearchTransport;
import co.elastic.clients.transport.rest_client.RestClientTransport;
import org.apache.http.HttpHost;
import org.elasticsearch.client.RestClient;
import java.io.IOException;

public class JavaApiClientExample {
    public static void main(String[] args) {
        // 1. 创建低级REST客户端
        RestClient restClient = RestClient.builder(
                new HttpHost("localhost", 9200, "http"))
                .build();

        // 2. 创建传输层,使用JacksonJsonpMapper进行JSON序列化/反序列化
        ElasticsearchTransport transport = new RestClientTransport(
                restClient, new JacksonJsonpMapper());

        // 3. 创建Java API客户端
        ElasticsearchClient esClient = new ElasticsearchClient(transport);

        try {
            // 在这里可以使用esClient执行各种类型安全的操作,例如:
            // GetResponse response = esClient.get(g -> g
            //     .index("products")
            //     .id("1"),
            //     Product.class
            // );
            // if (response.found()) {
            //     Product product = response.source();
            //     System.out.println("Product name: " + product.getName());
            // }

            System.out.println("Elasticsearch Java API Client initialized successfully.");

        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            // 确保客户端在使用完毕后关闭,释放资源
            try {
                transport.close(); // 关闭传输层,它会关闭底层的restClient
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}

ClientConfiguration 类解析

对于许多开发者而言,ClientConfiguration 类是一个常见的困惑点,尤其是在遵循一些教程时。需要明确的是,ClientConfiguration 类并非直接来自Elasticsearch官方的低级或Java API客户端库。它通常是 Spring Data Elasticsearch 框架的一部分,用于配置Spring抽象层中的Elasticsearch客户端。

如果你在项目中遇到了ClientConfiguration类缺失的问题,并且你的项目使用了Spring框架,那么很可能你需要引入Spring Data Elasticsearch的依赖:



    org.springframework.data
    spring-data-elasticsearch
    4.4.10