【Spring Cloud】RestAPI、RestClient操作索引、文档

文章目录

• ​​十一、RestAPI、RestClient操作索引、文档​​
• ​​11.7 RestAPI​​

• ​​7.0 导入Demo工程​​

• ​​7.0.1 导入数据​​
• ​​7.0.2 导入项目​​
• ​​7.0.3 mapping映射分析​​
• ​​7.0.4 初始化RestClient​​

• ​​7.1 创建索引库​​

• ​​7.1.1 代码解读​​
• ​​7.1.2 完整示例​​

• ​​7.2 删除索引库​​
• ​​7.3 判断索引库是否存在​​
• ​​7.4 总结​​

• ​​11.8 RestClient操作文档​​

• ​​8.1 新增文档​​

• ​​8.1.1 索引库实体类​​
• ​​8.1.2 语法说明​​
• ​​8.1.3 完整代码​​

• ​​8.2 查询文档​​

• ​​8.2.1 语法说明​​
• ​​8.2.2 完整代码​​

• ​​8.3 修改文档​​

• ​​8.3.1 语法说明​​
• ​​8.3.2 完整代码​​

• ​​8.4 删除文档​​
• ​​8.5 批量导入文档​​

• ​​8.5.1 语法说明​​
• ​​8.5.2 完整代码​​

• ​​8.6 小结​​

十一、RestAPI、RestClient操作索引、文档

11.7 RestAPI

ES官方提供了各种不同语言的客户端，用来操作ES。这些客户端的本质就是组装DSL语句，通过http请求发送给ES。官方文档地址：​​https://www.elastic.co/guide/en/elasticsearch/client/java-rest/7.15/java-rest-high.html​​

其中的​​Java Rest Client​​又包括两种：

• Java Low Level Rest Client
• Java High Level Rest Client （基于Low的高级封装）

7.0 导入Demo工程

7.0.1 导入数据

首先导入数据库数据，数据结构如下：

-- ----------------------------
-- Table structure for tb_hotel
-- ----------------------------
DROP TABLE IF EXISTS `tb_hotel`;
CREATE TABLE `tb_hotel`  (
  `id` bigint(20) NOT NULL COMMENT '酒店id',
  `name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '酒店名称',
  `address` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '酒店地址',
  `price` int(10) NOT NULL COMMENT '酒店价格',
  `score` int(2) NOT NULL COMMENT '酒店评分',
  `brand` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '酒店品牌',
  `city` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '所在城市',
  `star_name` varchar(16) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '酒店星级，1星到5星，1钻到5钻',
  `business` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '商圈',
  `latitude` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '纬度',
  `longitude` varchar(32) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NOT NULL COMMENT '经度',
  `pic` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci NULL DEFAULT NULL COMMENT '酒店图片',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_general_ci ROW_FORMAT = Compact;

​​返回顶部​​

7.0.2 导入项目

然后导入项目，结构如图：

​​返回顶部​​

7.0.3 mapping映射分析

创建索引库，最关键的是mapping映射，而mapping映射要考虑的信息包括：

• 字段名
• 字段数据类型
• 是否参与搜索
• 是否需要分词
• 如果分词，分词器是什么？

其中：

• 字段名、字段数据类型，可以参考数据表结构的名称和类型
• 是否参与搜索要分析业务来判断，例如图片地址，就无需参与搜索
• 是否分词呢要看内容，内容如果是一个整体就无需分词，反之则要分词
• 分词器，我们可以统一使用 ​​ik_max_word​​

酒店数据的索引库结构:

PUT /hotel
{
  "mappings": {
    "properties": {
      "id": {
        "type": "keyword"
      },
      "name":{
        "type": "text",
        "analyzer": "ik_max_word",
        "copy_to": "all"
      },
      "address":{
        "type": "keyword",
        "index": false
      },
      "price":{
        "type": "integer"
      },
      "score":{
        "type": "integer"
      },
      "brand":{
        "type": "keyword",
        "copy_to": "all"
      },
      "city":{
        "type": "keyword",
        "copy_to": "all"
      },
      "starName":{
        "type": "keyword"
      },
      "business":{
        "type": "keyword"
      },
      // 将经纬度合并定位
      "location":{
        "type": "geo_point"
      },
      "pic":{
        "type": "keyword",
        "index": false
      },
      "all":{
        "type": "text",
        "analyzer": "ik_max_word"
      }
    }
  }
}

几个特殊字段说明：

• location：地理坐标，里面包含精度、纬度

• all：一个组合字段，其目的是将多字段的值 利用 ​​copy_to​​合并，提供给用户搜索

地理坐标说明：

copy_to说明：

​​返回顶部​​

7.0.4 初始化RestClient

在​​elasticsearch​​提供的​​API​​中，与​​elasticsearch​​一切交互都封装在一个名为​​RestHighLevelClient​​的类中，必须先完成这个对象的初始化，建立与​​elasticsearch​​的连接。

1）引入es的RestHighLevelClient依赖：

<!-- RestHighLevelClient -->
<dependency>
    <groupId>org.elasticsearch.client</groupId>
    <artifactId>elasticsearch-rest-high-level-client</artifactId>
</dependency>

2）因为SpringBoot默认的ES版本是​​7.6.2​​，所以我们需要覆盖默认的ES版本：

<properties>
    <java.version>1.8</java.version>
    <!-- 版本要和docker中的es保持一致 -->
    <elasticsearch.version>7.12.1</elasticsearch.version>
</properties>

3）初始化RestHighLevelClient：

RestHighLevelClient client = new RestHighLevelClient(RestClient.builder(
        HttpHost.create("http://192.168.64.178:9200")  // docker中部署的es地址
));

这里为了单元测试方便，我们创建一个测试类​​HotelIndexTest​​，然后将初始化的代码编写在​​@BeforeEach​​方法中，释放资源的代码放在​​@AfterEach​​中：

package cn.itcast.hotel;

import org.apache.http.HttpHost;
import org.elasticsearch.client.RestHighLevelClient;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

import java.io.IOException;

public class HotelIndexTest {
    private RestHighLevelClient client;

    @BeforeEach
    void setUp() {
        this.client = new RestHighLevelClient(RestClient.builder(
                HttpHost.create("http://192.168.150.101:9200")
        ));
    }

    @AfterEach
    void tearDown() throws IOException {
        this.client.close();
    }
}

然后编写测试程序，测试获取的client连接情况：

​​返回顶部​​

7.1 创建索引库

7.1.1 代码解读

创建索引库的API如下：

代码分为三步：

• 1）创建​​Request​​对象。因为是创建索引库的操作，因此​​Request​​是​​CreateIndexRequest​​。
• 2）添加请求参数，其实就是​​DSL​​的​​JSON​​参数部分。因为​​json​​字符串很长，这里是定义了静态字符串常量​​MAPPING_TEMPLATE​​，让代码看起来更加优雅。
• 3）发送请求，​​client.indices()​​方法的返回值是​​IndicesClient类型​​，封装了所有与索引库操作有关的方法。

​​返回顶部​​

7.1.2 完整示例

在​​hotel-demo​​的​​cn.itcast.hotel.constants​​包下，创建一个类，定义​​mapping​​映射的​​JSON​​字符串常量：

package cn.itcast.hotel.constants;

public class HotelConstants {
    public static final String MAPPING_TEMPLATE = "{\n" +
            "  \"mappings\": {\n" +
            "    \"properties\": {\n" +
            "      \"id\": {\n" +
            "        \"type\": \"keyword\"\n" +
            "      },\n" +
            "      \"name\":{\n" +
            "        \"type\": \"text\",\n" +
            "        \"analyzer\": \"ik_max_word\",\n" +
            "        \"copy_to\": \"all\"\n" +
            "      },\n" +
            "      \"address\":{\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"index\": false\n" +
            "      },\n" +
            "      \"price\":{\n" +
            "        \"type\": \"integer\"\n" +
            "      },\n" +
            "      \"score\":{\n" +
            "        \"type\": \"integer\"\n" +
            "      },\n" +
            "      \"brand\":{\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"copy_to\": \"all\"\n" +
            "      },\n" +
            "      \"city\":{\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"copy_to\": \"all\"\n" +
            "      },\n" +
            "      \"starName\":{\n" +
            "        \"type\": \"keyword\"\n" +
            "      },\n" +
            "      \"business\":{\n" +
            "        \"type\": \"keyword\"\n" +
            "      },\n" +
            "      \"location\":{\n" +
            "        \"type\": \"geo_point\"\n" +
            "      },\n" +
            "      \"pic\":{\n" +
            "        \"type\": \"keyword\",\n" +
            "        \"index\": false\n" +
            "      },\n" +
            "      \"all\":{\n" +
            "        \"type\": \"text\",\n" +
            "        \"analyzer\": \"ik_max_word\"\n" +
            "      }\n" +
            "    }\n" +
            "  }\n" +
            "}";
}

在​​hotel-demo​​中的​​HotelIndexTest​​测试类中，编写单元测试，实现创建索引：

@Test
void createHotelIndex() throws IOException {
    // 1.创建Request对象
    CreateIndexRequest request = new CreateIndexRequest("hotel");
    // 2.准备请求的参数：DSL语句
    request.source(MAPPING_TEMPLATE, XContentType.JSON);
    // 3.发送请求
    client.indices().create(request, RequestOptions.DEFAULT);
}

先删除之前的索引，运行测试案例后，再次获取索引查看：

​​返回顶部​​

7.2 删除索引库

删除索引库的DSL语句非常简单：

DELETE /hotel

与创建索引库相比：

• 请求方式从​​PUT​​变为​​DELTE​​
• 请求路径不变
• 无请求参数

所以代码的差异，注意体现在Request对象上。依然是三步走：

• 1）创建Request对象。这次是DeleteIndexRequest对象
• 2）准备参数。这里是无参
• 3）发送请求。改用delete方法

在​​hotel-demo​​中的​​HotelIndexTest​​测试类中，编写单元测试，实现删除索引：

@Test
void testDeleteHotelIndex() throws IOException {
    // 1.创建Request对象
    DeleteIndexRequest request = new DeleteIndexRequest("hotel");
    // 2.发送请求
    client.indices().delete(request, RequestOptions.DEFAULT);
}

API删除后浏览器测试：

​​返回顶部​​

7.3 判断索引库是否存在

判断索引库是否存在，本质就是查询，对应的​​DSL​​是：

GET /hotel

因此与删除的Java代码流程是类似的。依然是三步走：

• 1）创建​​Request​​对象。这次是​​GetIndexRequest​​对象
• 2）准备参数。这里是无参
• 3）发送请求。改用​​exists​​方法

@Test
void testExistsHotelIndex() throws IOException {
    // 1.创建Request对象
    GetIndexRequest request = new GetIndexRequest("hotel");
    // 2.发送请求
    boolean exists = client.indices().exists(request, RequestOptions.DEFAULT);
    // 3.输出
    System.err.println(exists ? "索引库已经存在！" : "索引库不存在！");
}

​​返回顶部​​

7.4 总结

​​JavaRestClient​​操作​​elasticsearch​​的流程基本类似。核心是​​client.indices()​​方法来获取索引库的操作对象。

索引库操作的基本步骤：

• 初始化 ​​RestHighLevelClient​​
• 创建 ​​XxxIndexRequest​​。XXX是Create、Get、Delete
• 准备 ​​DSL​​（ Create时需要，其它是无参）
• 发送请求。调用 ​​RestHighLevelClient#indices().xxx()​​方法，xxx是create、exists、delete

​​返回顶部​​

11.8 RestClient操作文档

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

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

package cn.itcast.hotel;

import cn.itcast.hotel.pojo.Hotel;
import cn.itcast.hotel.service.IHotelService;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.io.IOException;
import java.util.List;

@SpringBootTest
public class HotelDocumentTest {
    @Autowired
    private IHotelService hotelService;

    private RestHighLevelClient client;

    @BeforeEach
    void setUp() {
        this.client = new RestHighLevelClient(RestClient.builder(
                HttpHost.create("http://192.168.150.101:9200")
        ));
    }

    @AfterEach
    void tearDown() throws IOException {
        this.client.close();
    }
}

8.1 新增文档

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

8.1.1 索引库实体类

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

@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;
}

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

• ​​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();
    }
}

​​返回顶部​​

8.1.2 语法说明

新增文档的​​DSL​​语句如下：

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

对应的java代码如图：

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

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

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

​​返回顶部​​

8.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​​测试类中，编写单元测试：

@SpringBootTest
public class HotelIndexTest {

    @Autowired
    private IService<Hotel> hotelService;
   
    @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);
    }
}

运行成功后，到浏览器查看存储情况：

​​返回顶部​​

8.2 查询文档

8.2.1 语法说明

查询的DSL语句如下：

GET /hotel/_doc/{id}

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

• 准备Request对象
• 发送请求

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

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

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

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

​​返回顶部​​

8.2.2 完整代码

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

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

​​返回顶部​​

8.3 修改文档

8.3.1 语法说明

修改我们讲过两种方式：

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

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

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

代码示例如图：

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

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

​​返回顶部​​

8.3.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);
}

​​返回顶部​​

8.4 删除文档

删除的​​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);
}

​​返回顶部​​

8.5 批量导入文档

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

步骤如下：

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

8.5.1 语法说明

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

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

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

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

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

其实还是三步走：

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

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

​​返回顶部​​

8.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);
}

​​返回顶部​​

8.6 小结

文档操作的基本步骤：

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

​​返回顶部​​