ElasticSearch8.x和Java API Client

Bertha 。 2024-03-17 15:34 14阅读 0赞

### 建议 ###

建议直接阅读我的[博客原文][Link 1]

#### 10.4 `Java API Client`操作-索引库/文档 ####

##### 客户端更新 #####

ES为不同语言提供了用于操作ES的客户端，截至2023年7月4日，根据[官网][Link 2]`Java REST Client`已经被弃用，取而代之的是`Java API Client`，黑马的教程里都是环境是`es7.12.1`和`RestClient`，版本太旧了，我的笔记用`es 8.8.1`和`Java API Client`，但也会提供部分旧版本代码。ES官网也提供了兼容性支持，`restclient7.17`版本仍然可以操作`es8.x`版本。

[API Client更新说明][API Client]

![image-20230704164100865][]

![image-20230704164642426][]

**为什么要抛弃High Level Rest：**

*  客户端"too heavy"，相关依赖超过 30 MB，且很多都是非必要相关的；api 暴露了很多服务器内部接口
 *  一致性差，仍需要大量的维护工作。
 *  客户端没有集成 json/object 类型映射，仍需要自己借助字节缓存区实现。

**Java API Client最明显的特征：**

*  支持lambda表达式操作ES
 *  支持Builder建造者模式操作ES，链式代码具有较强可读性.
 *  应用程序类能够自动映射为Mapping.

可以浅浅感受下两者不同：

RestHighLevelClient：

![image-20230705162855862][]

![image-20230705163335206][]

**导入本地项目**

1.服务器mysql容器导入数据

# 本地sql文件上传到服务器
    scp D:\...\tb_hotel.sql root@my_ip:/root/tmp 
    # 复制文件到容器内
    docker cp tmp/tb_hotel.sql mysql:/tmp/tb_hotel.sql
    # 进入容器
    docker exec -it mysql bash
    mysql -u root -p
    # 容器内执行sql
    use my_db;
    source /tmp/tb_hotel.sql
    # 删除临时文件
    docker exec -it mysql rm /tmp/tb_hotel.sql

2.导入hotel-demo

**数据结构分析**

*  需要分词：type=text，并设置分词器
 *  不需要索引：index=false
 *  特殊数据类型：geo\_point表示具体经纬度，geo\_shape表示经纬范围，如1所示
 *  优化搜索，如2所示⭐
    
     *  多条件索引的效率低于单条件索引
     *  "copy\_to"属性可将当前字段copy到指定字段
     *  创建条件"all"，将多条件索引的条件都"copy\_to"新条件"all"，达成单条件索引

![image-20230704162905494][]

**初始化JavaClient**

1.导入es的Client依赖，这里要注意`jackson-core`版本，原因看[这篇][Link 3]

<dependency>
        <groupId>org.elasticsearch.client</groupId>
        <artifactId>elasticsearch-rest-high-level-client</artifactId>
        
        <version>7.17.4</version>
    </dependency>
    
    
     <dependency>
         <groupId>co.elastic.clients</groupId>
         <artifactId>elasticsearch-java</artifactId>
         <version>8.8.1</version>
    </dependency>
    
    
    
    
    <dependency>
        <groupId>com.fasterxml.jackson.core</groupId>
        <artifactId>jackson-core</artifactId>
        <version>2.12.0</version>
    </dependency>
    
    <dependency>
         <groupId>jakarta.json</groupId>
         <artifactId>jakarta.json-api</artifactId>
         <version>2.0.1</version>
    </dependency>

2.覆盖ES默认版本（Spring Boot默认ES版本7.6.2）

3.初始化Client

//旧版本RestHighLevelClient
    @Bean
    public RestHighLevelClient restHighLevelClient(){
        
        return new RestHighLevelClient(RestClient.builder(
            HttpHost.create("http://xx.xx.xx.xx:9200")
        ));
    }
    //新版本Java API Client
    //新版版还支持创建安全连接，使用SSLContext
    @Bean
    public ElasticsearchClient elasticsearchClient(){
        
        //创建低级客户端，负责所有传输级问题：连接池、重试、节点发现等
        RestClient restClient = RestClient.builder(
            new HttpHost(IP,9200)).build();
        //使用Jackson映射器创建传输层，方便ES与应用程序类集成
        ElasticsearchTransport transport = new RestClientTransport(
            restClient,new JacksonJsonpMapper());
        //创建API 客户端
        //阻塞
        return new ElasticsearchClient(transport);
        //异步非阻塞
        //return new ElasticsearchAsyncClient(transport);
    }

##### 索引库 #####

创建索引测试

@SpringBootTest
    class HotelIndexTest {
        
    
        // private RestHighLevelClient client;
    
        private RestClient restClient;
        private ElasticsearchTransport transport;
        private ElasticsearchClient client;
        
        @Test
        void testCreateIndex() throws IOException {
        
            //准备Request，并指定index name和请求参数
            CreateIndexRequest request = CreateIndexRequest.of(builder ->
                builder.index("hotel")
                        .withJson(new StringReader(MAPPING_TEMPLATE))
            );
            //发送请求
            client.indices().create(request);
        }
        
        
        //官方还提供了其他方法创建mappings
        //mappings是字符串
        @Test
        void testCreateIndex1() throws IOException {
        
            JsonpMapper jsonpMapper = client._transport().jsonpMapper();
            //这里的MAPPING_TEST字符串只需要包含{"properties":{}}内容
            JsonParser parser = Json.createParser(new StringReader(MAPPING_TEST));
            client.indices().create(
                    new CreateIndexRequest.Builder()
                            .index("hotel")
                         .mappings(TypeMapping._DESERIALIZER.deserialize(parser,jsonpMapper))
                            .build()
            );
        }
        //mappings是json文件
        @Test
        public void testCreateIndex2(){
        
            String mappingPath = System.getProperty("user.dir") + "/mappings.json";
            JsonpMapper mapper = client._transport().jsonpMapper();
            String mappings_str = new String(Files.readAllBytes(Paths.get(mappingPath)));
            System.out.println("mappings are: " +  mappings_str);
            JsonParser parser = mapper.jsonProvider()
                .createParser(new StringReader( mappings_str ));
    
            client.indices()
                .create(createIndexRequest -> createIndexRequest.index("test")
                        .mappings(TypeMapping._DESERIALIZER.deserialize(parser, mapper)));
        }
        
        @BeforeEach
        void setUp() {
        
            restClient = RestClient.builder(new HttpHost(IP,9200)).build();
            transport = new RestClientTransport(restClient, new JacksonJsonpMapper());
            client = new ElasticsearchClient(transport);
        }
    
        @AfterEach
        void tearDown() throws IOException {
        
            //关闭连接
            restClient.close();
            transport.close();
        }
    }

API Client使用`client.indices()`操作索引.

![image-20230705113225206][]

判断索引是否存在

@Test
    void testExistsIndex() throws IOException {
        
        BooleanResponse isExists = client.indices().exists(
            new ExistsRequest.Builder()
            .index("hotel")
            .build()
        );
        System.out.println(isExists.value()?"exist":"not exist");
    }

其实代码是什么不重要，完全可以按提示写，例如删除index：

![image-20230705154144666][]

提供了两种方式，上面判断是否存在用的是第二种，也就是XXIndexRequest的方式，删除可以试下第一种：

![image-20230705154323920][]

改写成lambda表达式：

![image-20230705154355621][]

##### 文档 #####

API Client使用`client.xx()`操作文档.

了解规则之后，根据代码提示直接写，不需要手动转换格式，极度舒适~

![image-20230705164204097][]

![image-20230705171150250][]

![image-20230705171411436][]

bulk批量请求⭐

这个有点难猜，卡了一下

实在不行可以使用最原始的`withJson()`方法，把批量数据放在json中读取后作为请求参数传上去.但是不够优雅…

![image-20230705174157104][]

[Link 1]: https://www.leviran.com/2023/07/566/
[Link 2]: https://www.elastic.co/guide/en/elasticsearch/client/index.html
[API Client]: https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current/migrate-hlrc.html
[image-20230704164100865]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/e4043af124e74ada92deb1ae14926450.png
[image-20230704164642426]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/02baa5d9c6834ee98ad949971ef02324.png
[image-20230705162855862]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/838f522435384170852eca4ca59f4624.png
[image-20230705163335206]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f03cb7024f95451a85cb4240ec2d2fb9.png
[image-20230704162905494]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/03c669ae4ffc4debbab540bab64985e9.png
[Link 3]: https://www.leviran.com/2023/07/563/
[image-20230705113225206]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/3806e34a3ab842edb52913ca6eb3160c.png
[image-20230705154144666]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f0d5c2435ff74112a0b827ce3b959da1.png
[image-20230705154323920]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/8b45788d37fc41529b08208899ad5fc2.png
[image-20230705154355621]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/85856c5a260a4fc18a5ae08403c08673.png
[image-20230705164204097]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/e68d66c84b384b15b4bf408b735f4c32.png
[image-20230705171150250]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/6d5664a5fe8344afbe8c306c0ecb0528.png
[image-20230705171411436]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/335e47eba7f64fe4a05bdbc55eba5dba.png
[image-20230705174157104]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/be1633964b4843cf8e1d5729f47d226b.png