【Elasticsearch】RestClient操作文档

快来打我* 2024-03-17 18:39 21阅读 0赞

**目录**

5.RestClient操作文档

5.1.新增文档

5.1.1.索引库实体类

5.1.2.语法说明

5.1.3.完整代码

5.2.查询文档

5.2.1.语法说明

5.2.2.完整代码

5.3.删除文档

5.4.修改文档

5.4.1.语法说明

5.4.2.完整代码

5.5.批量导入文档

5.5.1.语法说明

5.5.2.完整代码

5.6.小结

## 5.RestClient操作文档 ##

为了与索引库操作分离，我们再次参加一个测试类，做两件事情：

*  初始化RestHighLevelClient
 *  我们的酒店数据在数据库，需要利用IHotelService去查询，所以注入这个接口

@Data
    @TableName("tb_hotel")
    public class Hotel {
        @TableId(type = IdType.INPUT)
        private Long id;
        private String name;
        private String address;
        private Integer price;
        private Integer score;
        private String brand;
        private String city;
        private String starName;
        private String business;
        private String longitude;
        private String latitude;
        private String pic;
    }

### 5.1.新增文档 ###

我们要将数据库的酒店数据查询出来，写入elasticsearch中。

#### 5.1.1.索引库实体类 ####

数据库查询后的结果是一个Hotel类型的对象。结构如下：

与我们的索引库结构存在差异：

*  longitude和latitude需要合并为location

因此，我们需要定义一个新的类型，与索引库结构吻合：

package cn.itcast.hotel.pojo;
    
    import lombok.Data;
    import lombok.NoArgsConstructor;
    
    @Data
    @NoArgsConstructor
    public class HotelDoc {
        private Long id;
        private String name;
        private String address;
        private Integer price;
        private Integer score;
        private String brand;
        private String city;
        private String starName;
        private String business;
        private String location;
        private String pic;
    
        public HotelDoc(Hotel hotel) {
            this.id = hotel.getId();
            this.name = hotel.getName();
            this.address = hotel.getAddress();
            this.price = hotel.getPrice();
            this.score = hotel.getScore();
            this.brand = hotel.getBrand();
            this.city = hotel.getCity();
            this.starName = hotel.getStarName();
            this.business = hotel.getBusiness();
            this.location = hotel.getLatitude() + ", " + hotel.getLongitude();
            this.pic = hotel.getPic();
        }
    }

#### 5.1.2.语法说明 ####

新增文档的DSL语句如下：

POST /{索引库名}/_doc/1
    {
        "name": "Jack",
        "age": 21
    }

对应的java代码如图：

![6a0fdbb86400470eb4af8706f1780413.png][]

可以看到与创建索引库类似，同样是三步走：

*  1）创建Request对象
 *  2）准备请求参数，也就是DSL中的JSON文档
 *  3）发送请求

变化的地方在于，这里直接使用client.xxx()的API，不再需要client.indices()了。

#### 5.1.3.完整代码 ####

我们导入酒店数据，基本流程一致，但是需要考虑几点变化：

*  酒店数据来自于数据库，我们需要先查询出来，得到hotel对象
 *  hotel对象需要转为HotelDoc对象
 *  HotelDoc需要序列化为json格式

因此，代码整体步骤如下：

*  1）根据id查询酒店数据Hotel
 *  2）将Hotel封装为HotelDoc
 *  3）将HotelDoc序列化为JSON
 *  4）创建IndexRequest，指定索引库名和id
 *  5）准备请求参数，也就是JSON文档
 *  6）发送请求

在hotel-demo的HotelDocumentTest测试类中，编写单元测试：

@Test
    void testAddDocument() throws IOException {
        // 1.根据id查询酒店数据
        Hotel hotel = hotelService.getById(61083L);
        // 2.转换为文档类型
        HotelDoc hotelDoc = new HotelDoc(hotel);
        // 3.将HotelDoc转json
        String json = JSON.toJSONString(hotelDoc);
    
        // 1.准备Request对象
        IndexRequest request = new IndexRequest("hotel").id(hotelDoc.getId().toString());
        // 2.准备Json文档
        request.source(json, XContentType.JSON);
        // 3.发送请求
        client.index(request, RequestOptions.DEFAULT);
    }

### 5.2.查询文档 ###

#### 5.2.1.语法说明 ####

查询的DSL语句如下：

GET /hotel/_doc/{id}

非常简单，因此代码大概分两步：

*  准备Request对象
 *  发送请求

不过查询的目的是得到结果，解析为HotelDoc，因此难点是结果的解析。完整代码如下：

![c7ac1e09b6ac4ec88661b089638873ef.png][]

可以看到，结果是一个JSON，其中文档放在一个`_source`属性中，因此解析就是拿到`_source`，反序列化为Java对象即可。

与之前类似，也是三步走：

*  1）准备Request对象。这次是查询，所以是GetRequest
 *  2）发送请求，得到结果。因为是查询，这里调用client.get()方法
 *  3）解析结果，就是对JSON做反序列化

#### 5.2.2.完整代码 ####

在hotel-demo的HotelDocumentTest测试类中，编写单元测试：

@Test
    void testGetDocumentById() throws IOException {
        // 1.准备Request
        GetRequest request = new GetRequest("hotel", "61082");
        // 2.发送请求，得到响应
        GetResponse response = client.get(request, RequestOptions.DEFAULT);
        // 3.解析响应结果
        String json = response.getSourceAsString();
    
        HotelDoc hotelDoc = JSON.parseObject(json, HotelDoc.class);
        System.out.println(hotelDoc);
    }

### 5.3.删除文档 ###

删除的DSL为是这样的：

DELETE /hotel/_doc/{id}

与查询相比，仅仅是请求方式从DELETE变成GET，可以想象Java代码应该依然是三步走：

*  1）准备Request对象，因为是删除，这次是DeleteRequest对象。要指定索引库名和id
 *  2）准备参数，无参
 *  3）发送请求。因为是删除，所以是client.delete()方法

在hotel-demo的HotelDocumentTest测试类中，编写单元测试：

@Test
    void testDeleteDocument() throws IOException {
        // 1.准备Request
        DeleteRequest request = new DeleteRequest("hotel", "61083");
        // 2.发送请求
        client.delete(request, RequestOptions.DEFAULT);
    }

### 5.4.修改文档 ###

#### 5.4.1.语法说明 ####

修改我们讲过两种方式：

*  全量修改：本质是先根据id删除，再新增
 *  增量修改：修改文档中的指定字段值

在RestClient的API中，全量修改与新增的API完全一致，判断依据是ID：

*  如果新增时，ID已经存在，则修改
 *  如果新增时，ID不存在，则新增

这里不再赘述，我们主要关注增量修改。

代码示例如图：

![9c2cb5e6ec454a90a6dd42bf323209bb.png][]

与之前类似，也是三步走：

*  1）准备Request对象。这次是修改，所以是UpdateRequest
 *  2）准备参数。也就是JSON文档，里面包含要修改的字段
 *  3）更新文档。这里调用client.update()方法

#### 5.4.2.完整代码 ####

在hotel-demo的HotelDocumentTest测试类中，编写单元测试：

@Test
    void testUpdateDocument() throws IOException {
        // 1.准备Request
        UpdateRequest request = new UpdateRequest("hotel", "61083");
        // 2.准备请求参数
        request.doc(
            "price", "952",
            "starName", "四钻"
        );
        // 3.发送请求
        client.update(request, RequestOptions.DEFAULT);
    }

### 5.5.批量导入文档 ###

案例需求：利用BulkRequest批量将数据库数据导入到索引库中。

步骤如下：

*  利用mybatis-plus查询酒店数据
 *  将查询到的酒店数据（Hotel）转换为文档类型数据（HotelDoc）
 *  利用JavaRestClient中的BulkRequest批处理，实现批量新增文档

#### 5.5.1.语法说明 ####

批量处理BulkRequest，其本质就是将多个普通的CRUD请求组合在一起发送。

其中提供了一个add方法，用来添加其他请求：

![cd1d655b98c542a7ad28c8b76776eddd.png][]

可以看到，能添加的请求包括：

*  IndexRequest，也就是新增
 *  UpdateRequest，也就是修改
 *  DeleteRequest，也就是删除

因此Bulk中添加了多个IndexRequest，就是批量新增功能了。示例：

![2ded5272ee3241c6b74089c7c3f63538.png][]

其实还是三步走：

*  1）创建Request对象。这里是BulkRequest
 *  2）准备参数。批处理的参数，就是其它Request对象，这里就是多个IndexRequest
 *  3）发起请求。这里是批处理，调用的方法为client.bulk()方法

我们在导入酒店数据时，将上述代码改造成for循环处理即可。

#### 5.5.2.完整代码 ####

在hotel-demo的HotelDocumentTest测试类中，编写单元测试：

@Test
    void testBulkRequest() throws IOException {
        // 批量查询酒店数据
        List<Hotel> hotels = hotelService.list();
    
        // 1.创建Request
        BulkRequest request = new BulkRequest();
        // 2.准备参数，添加多个新增的Request
        for (Hotel hotel : hotels) {
            // 2.1.转换为文档类型HotelDoc
            HotelDoc hotelDoc = new HotelDoc(hotel);
            // 2.2.创建新增文档的Request对象
            request.add(new IndexRequest("hotel")
                        .id(hotelDoc.getId().toString())
                        .source(JSON.toJSONString(hotelDoc), XContentType.JSON));
        }
        // 3.发送请求
        client.bulk(request, RequestOptions.DEFAULT);
    }

### 5.6.小结 ###

文档操作的基本步骤：

*  初始化RestHighLevelClient
 *  创建XxxRequest。XXX是Index、Get、Update、Delete、Bulk
 *  准备参数（Index、Update、Bulk时需要）
 *  发送请求。调用RestHighLevelClient\#.xxx()方法，xxx是index、get、update、delete、bulk
 *  解析结果（Get时需要）

[6a0fdbb86400470eb4af8706f1780413.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/dc87053b6a924bb1aacfb51876044c2c.png
[c7ac1e09b6ac4ec88661b089638873ef.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/9227fef6cc024e9da925b0cec3a1584a.png
[9c2cb5e6ec454a90a6dd42bf323209bb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/f3e10f32919e43a2be95e1ca3325941e.png
[cd1d655b98c542a7ad28c8b76776eddd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/1271c2f3911f4280b526891ef80824ca.png
[2ded5272ee3241c6b74089c7c3f63538.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/15/2052b0b753a549cc985e88d29f4f4987.png