【Elasticsearch】RestAPI

2023-07-25 105

版权

本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。

本文涉及的产品

检索分析服务 Elasticsearch 版，2核4GB开发者规格 1个月

简介： 【Elasticsearch】RestAPI

4.RestAPI

ES官方提供了各种不同语言的客户端，用来操作ES。这些客户端的本质就是组装DSL语句，通过http请求发送给ES。官方文档地址：Elasticsearch Clients | Elastic

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

Java Low Level Rest Client
Java High Level Rest Client

我们学习的是Java HighLevel Rest Client客户端API

4.0.导入Demo工程

4.0.1.导入数据

首先导入课前资料提供的数据库数据：

数据结构如下：

1. CREATE TABLE `tb_hotel` (
2.   `id` bigint(20) NOT NULL COMMENT '酒店id',
3.   `name` varchar(255) NOT NULL COMMENT '酒店名称；例：7天酒店',
4.   `address` varchar(255) NOT NULL COMMENT '酒店地址；例：航头路',
5.   `price` int(10) NOT NULL COMMENT '酒店价格；例：329',
6.   `score` int(2) NOT NULL COMMENT '酒店评分；例：45，就是4.5分',
7.   `brand` varchar(32) NOT NULL COMMENT '酒店品牌；例：如家',
8.   `city` varchar(32) NOT NULL COMMENT '所在城市；例：上海',
9.   `star_name` varchar(16) DEFAULT NULL COMMENT '酒店星级，从低到高分别是：1星到5星，1钻到5钻',
10.   `business` varchar(255) DEFAULT NULL COMMENT '商圈；例：虹桥',
11.   `latitude` varchar(32) NOT NULL COMMENT '纬度；例：31.2497',
12.   `longitude` varchar(32) NOT NULL COMMENT '经度；例：120.3925',
13.   `pic` varchar(255) DEFAULT NULL COMMENT '酒店图片；例:/img/1.jpg',
14.   PRIMARY KEY (`id`)
15. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

4.0.2.导入项目

然后导入课前资料提供的项目:

项目结构如图：

4.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说明：

4.0.4.初始化RestClient

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

分为三步：

1）引入es的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>
    <elasticsearch.version>7.12.1</elasticsearch.version>
</properties>

3）初始化RestHighLevelClient：

初始化的代码如下：

1. RestHighLevelClient client = new RestHighLevelClient(RestClient.builder(
2.         HttpHost.create("http://192.168.150.101:9200")
3. ));

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

1. package cn.itcast.hotel;
2. 
3. import org.apache.http.HttpHost;
4. import org.elasticsearch.client.RestHighLevelClient;
5. import org.junit.jupiter.api.AfterEach;
6. import org.junit.jupiter.api.BeforeEach;
7. import org.junit.jupiter.api.Test;
8. 
9. import java.io.IOException;
10. 
11. public class HotelIndexTest {
12. private RestHighLevelClient client;
13. 
14. @BeforeEach
15. void setUp() {
16. this.client = new RestHighLevelClient(RestClient.builder(
17.                 HttpHost.create("http://192.168.150.101:9200")
18.         ));
19.     }
20. 
21. @AfterEach
22. void tearDown() throws IOException {
23. this.client.close();
24.     }
25. }

4.1.创建索引库

4.1.1.代码解读

创建索引库的API如下：

代码分为三步：

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

4.1.2.完整示例

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

1. package cn.itcast.hotel.constants;
2. 
3. public class HotelConstants {
4. public static final String MAPPING_TEMPLATE = "{\n" +
5. "  \"mappings\": {\n" +
6. "    \"properties\": {\n" +
7. "      \"id\": {\n" +
8. "        \"type\": \"keyword\"\n" +
9. "      },\n" +
10. "      \"name\":{\n" +
11. "        \"type\": \"text\",\n" +
12. "        \"analyzer\": \"ik_max_word\",\n" +
13. "        \"copy_to\": \"all\"\n" +
14. "      },\n" +
15. "      \"address\":{\n" +
16. "        \"type\": \"keyword\",\n" +
17. "        \"index\": false\n" +
18. "      },\n" +
19. "      \"price\":{\n" +
20. "        \"type\": \"integer\"\n" +
21. "      },\n" +
22. "      \"score\":{\n" +
23. "        \"type\": \"integer\"\n" +
24. "      },\n" +
25. "      \"brand\":{\n" +
26. "        \"type\": \"keyword\",\n" +
27. "        \"copy_to\": \"all\"\n" +
28. "      },\n" +
29. "      \"city\":{\n" +
30. "        \"type\": \"keyword\",\n" +
31. "        \"copy_to\": \"all\"\n" +
32. "      },\n" +
33. "      \"starName\":{\n" +
34. "        \"type\": \"keyword\"\n" +
35. "      },\n" +
36. "      \"business\":{\n" +
37. "        \"type\": \"keyword\"\n" +
38. "      },\n" +
39. "      \"location\":{\n" +
40. "        \"type\": \"geo_point\"\n" +
41. "      },\n" +
42. "      \"pic\":{\n" +
43. "        \"type\": \"keyword\",\n" +
44. "        \"index\": false\n" +
45. "      },\n" +
46. "      \"all\":{\n" +
47. "        \"type\": \"text\",\n" +
48. "        \"analyzer\": \"ik_max_word\"\n" +
49. "      }\n" +
50. "    }\n" +
51. "  }\n" +
52. "}";
53. }

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

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

4.2.删除索引库

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

DELETE /hotel

与创建索引库相比：

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

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

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

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

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

4.3.判断索引库是否存在

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

GET /hotel

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

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

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

4.4.总结

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

索引库操作的基本步骤：

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

【Elasticsearch】RestAPI

4.RestAPI

4.0.导入Demo工程

4.0.1.导入数据

4.0.2.导入项目

4.0.3.mapping映射分析

4.0.4.初始化RestClient

4.1.创建索引库

4.1.1.代码解读

4.1.2.完整示例

4.2.删除索引库

4.3.判断索引库是否存在

4.4.总结

热门文章

最新文章

相关课程

相关电子书

相关实验场景

热门

活动广场

任务中心

开发者评测

高校计划

乘风者计划

训练营

阿里云MVP

话题

直播

下载

镜像站

技术资料

插件

【Elasticsearch】RestAPI

4.RestAPI

4.0.导入Demo工程

4.0.1.导入数据

4.0.2.导入项目

4.0.3.mapping映射分析

4.0.4.初始化RestClient

4.1.创建索引库

4.1.1.代码解读

4.1.2.完整示例

4.2.删除索引库

4.3.判断索引库是否存在

4.4.总结

热门文章

最新文章

相关课程

相关电子书

相关实验场景