> 文档中心 > RestClient操作索引库

RestClient操作索引库


RestClient操作索引

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

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

  • Java Low Level Rest Client
  • Java High Level Rest Client

1、导入Demo工程

克隆地址:https://github.com/ZhongChunle/hotel-demo.git

数据表结构

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

2、mapping映射分析

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

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

其中:

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

几个特殊字段说明:

  • location:地理坐标,里面包含精度、纬度
  • all:一个组合字段,其目的是将多字段的值 利用copy_to合并,提供给用户搜索
ES中支持两种地理坐标数据类型
  1. geo_point:由维度(latitude)和经度(longitude)确定的一个点。列如:”32.45452415,120.54548545“
  2. geo_shape:有多个get_point组成的复杂几何图形。例如一条直线,“LINESTRING(-77.01515454545.545545,-77.25454545454 454542.54545)”
copy_to说明:

字段拷贝可以使用copy_to属性将当前字段拷贝到指定字段,如:

"all":{    "type": "text",    "analyzer": "ik_max_word"},"brand":{    "type": "keyword",    "copy_to": "all"}

来看下酒店数据的索引库结构:

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"      }    }  }}

3、初始化RestClient

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

分为三步:

1)引入es的RestHighLevelClient依赖:

需要在顶部声明版本信息将springboot的原来低版本的覆盖掉

<properties>    <java.version>1.8</java.version>    <elasticsearch.version>7.12.1</elasticsearch.version></properties><dependency>    <groupId>org.elasticsearch.client</groupId>    <artifactId>elasticsearch-rest-high-level-client</artifactId></dependency>

2)初始化RestHighLevelClient:

创建一个HotelIndexTest类在测试环境中

package cn.itcast.hotel;import org.apache.http.HttpHost;import org.elasticsearch.client.RestClient;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;/** * 项目名称:hotel-demo * 描述:酒店数据单元测试 * * @author zhong * @date 2022-06-02 12:58 */public class HotelIndexTest {    private RestHighLevelClient client;    /**     * 执行之前进行连接     */    @BeforeEach    void setUp(){ this.client = new RestHighLevelClient(RestClient.builder(  HttpHost.create("http://192.168.26.131:9200") ));    }    @Test    void testIndex(){ System.out.println(client);    }    /**     * 执行完之后销毁     * @throws IOException     */    @AfterEach    void tearDown() throws IOException { this.client.close();    }}

运行测试testIndex会输入如下信息:(每台电脑都不一样)

org.elasticsearch.client.RestHighLevelClient@bf1ec20

4、创建索引库

  1. 将光网上编写的DLS语句复制到代码中作为一个常量

    package constants;/** * 项目名称:hotel-demo * 描述:创建一个常量类 * * @author zhong * @date 2022-06-02 13:08 */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" +     "}";}
  2. 完成的创建

    代码分为三步:

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

    代码同样是在HotelIndexTest测试类里面

    /** * 创建索引库 */@Testvoid 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);}

    indices():其实是包含了我们所有的索引库方法的,都可以通过点的形式创建出来

  3. 运行测试在Dev Tools查看创建结果

    # 查询GET /hotel

5、删除索引库和判断索引库是否存在

  1. 删除索引库
    /** * 删除索引库 */@Testvoid DeleteHotelIndex() throws IOException {    // 1、创建request对象    DeleteIndexRequest request = new DeleteIndexRequest("hotel");    // 2、发送请求    client.indices().delete(request, RequestOptions.DEFAULT);}
  2. 判断索引库
    /** * 判断是否存在索引库 */@Testvoid testExistsHotelIndex() throws IOException {    // 1、创建request对象   GetIndexRequest request = new GetIndexRequest("hotel");    // 2、发送请求    boolean exists = client.indices().exists(request, RequestOptions.DEFAULT);    System.out.println(exists?"索引库已存在":"索引库不存在");}

总结

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

索引库操作的基本步骤:

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

VR资源云