Spring boot使用easy-es操作elasticsearch_easy-es学习

前言

使用Easy-ES操作Elasticsearch：让数据搜索与管理更轻松

在当今信息爆炸的时代，数据的搜索、存储和管理成为了企业和个人不可或缺的需求。Elasticsearch，作为一款强大且灵活的开源搜索和分析引擎，因其高效的搜索性能、分布式存储能力和可扩展性，得到了广泛的应用。然而，Elasticsearch的复杂配置和操作对于初学者来说可能存在一定的门槛。为了降低这一门槛，让更多的人能够轻松地使用Elasticsearch，Easy-ES应运而生。

Easy-ES是一个基于Elasticsearch的封装库，旨在简化Elasticsearch的操作，让开发者能够更快速地集成和使用Elasticsearch。通过Easy-ES，用户无需深入了解Elasticsearch的底层细节和复杂配置，即可轻松实现数据的搜索、索引、更新和删除等操作。

本文将详细介绍如何使用Easy-ES来操作Elasticsearch，包括如何安装和配置Easy-ES，如何创建和管理索引，如何执行高效的搜索查询，以及如何处理数据的更新和删除等操作。通过本文的学习，读者将能够掌握Easy-ES的基本使用方法，从而更好地利用Elasticsearch来处理数据搜索和管理的需求。

无论你是Elasticsearch的新手，还是希望寻找更便捷操作Elasticsearch的开发者，本文都将为你提供有益的指导和帮助。让我们一起探索Easy-ES的世界，让数据搜索与管理变得更加轻松高效吧！

一、安装与配置Easy-ES

首先，你需要确保已经安装了Elasticsearch。随后，可以通过Maven或Gradle等构建工具将Easy-ES的依赖添加到你的项目中。

对于Maven项目，你可以在pom.xml文件中添加如下依赖：

		<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.elasticsearch.client</groupId>
                    <artifactId>elasticsearch-rest-high-level-client</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.elasticsearch</groupId>
                    <artifactId>elasticsearch</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.elasticsearch.client</groupId>
            <artifactId>elasticsearch-rest-high-level-client</artifactId>
            <version>7.14.0</version>
        </dependency>
        <dependency>
            <groupId>org.elasticsearch</groupId>
            <artifactId>elasticsearch</artifactId>
            <version>7.14.0</version>
        </dependency>
        <!-- 引入easy-es最新版本的依赖-->
        <dependency>
            <groupId>org.dromara.easy-es</groupId>
            <artifactId>easy-es-boot-starter</artifactId>
            <version>2.0.0-beta8</version>
        </dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

需要注意，easy-es使用的版本是7.14.0，所以我们引入跟easy-es同样的版本，还要过滤掉springboot内置的es版本

二、配置Easy-ES属性

在你的Spring Boot项目中，需要配置Easy-ES的相关属性。在application.yml或application.properties文件中，你可以添加Elasticsearch的集群地址、端口、认证信息等。
例如，在application.yml中：

#==============================Easy-Es配置==============================
easy-es:
  enable: true # 默认为true,若为false时,则认为不启用本框架
  address: 127.0.0.1:9200
  username: your_username  
  password: your_password
  connect-timeout: 5000
  connection-request-timeout: 5000
  request-timeout: 5000

1
2
3
4
5
6
7
8
9
10

没有用户名和密码的则可以不用填写

三、创建索引与映射

使用Easy-ES，你可以通过注解或编程方式定义索引和映射。Easy-ES提供了丰富的注解来简化索引和字段的定义。

例如，定义一个实体类并使用注解来指定索引名和字段映射：

package com.shiyi.entity;

import lombok.Data;
import org.dromara.easyes.annotation.HighLight;
import org.dromara.easyes.annotation.IndexField;
import org.dromara.easyes.annotation.IndexId;
import org.dromara.easyes.annotation.IndexName;
import org.dromara.easyes.annotation.rely.Analyzer;
import org.dromara.easyes.annotation.rely.FieldType;
import org.dromara.easyes.annotation.rely.IdType;

import java.util.Date;

@Data
@IndexName(value = "blog")
public class ArticleElastic {

    /**
     * es中的唯一id
     */
    @IndexId(type = IdType.CUSTOMIZE)
    private Long id;
    /**
     * 文档标题
     */
    @HighLight(preTag = "<em style='color:red'>", postTag = "</em>")
    @IndexField(fieldType = FieldType.TEXT,analyzer = Analyzer.IK_MAX_WORD, searchAnalyzer = Analyzer.IK_MAX_WORD)
    private String title;
    /**
     * 文档内容
     */
    @HighLight(preTag = "<em style='color:red'>", postTag = "</em>")
    @IndexField(fieldType = FieldType.TEXT,analyzer = Analyzer.IK_MAX_WORD, searchAnalyzer = Analyzer.IK_MAX_WORD)
    private String summary;

    @IndexField(fieldType = FieldType.DATE, dateFormat = "yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||epoch_millis")
    private String createTime;
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

上述代码定义了一个名为blog的索引，并指定了其中的字段类型和搜索分词配置

四、执行CRUD操作

通过Easy-ES提供的服务或Repository接口，你可以轻松地对Elasticsearch中的数据进行增删改查操作。

例如，创建一个继承自BaseEsMapper的接口：

package com.shiyi.mapper;

import com.shiyi.entity.ArticleElastic;
import org.dromara.easyes.core.kernel.BaseEsMapper;
import org.springframework.stereotype.Repository;

@Repository
public interface EasyesMapper extends BaseEsMapper<ArticleElastic> {
}

1
2
3
4
5
6
7
8
9
10

1. 新建EsTestController

首先我们新建一个EsTestController类，在该类型进行es的CRUD测试

package com.shiyi.controller;

import com.shiyi.common.ResponseResult;
import com.shiyi.entity.ArticleElastic;
import com.shiyi.mapper.EasyesMapper;
import lombok.RequiredArgsConstructor;
import org.dromara.easyes.core.conditions.select.LambdaEsQueryWrapper;
import org.springframework.web.bind.annotation.*;


/**
 * Es的测试控制器
 */
@RestController
@RequiredArgsConstructor
public class EsTestController {

    private final EasyesMapper easyesMapper;

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

2. 创建索引

在执行CRUD之前我们需要创建es的索引，在上面的测试类下添加如下代码，然后调用接口执行即可

    @GetMapping("createIndex")
    public void createIndex(){
        easyesMapper.createIndex();
    }
1
2
3
4

3. 添加数据

   /**
     * 添加es中的数据
     * @param articleElastic
     * @return
     */
    @PostMapping ("add")
    public String add(@RequestBody ArticleElastic articleElastic){
        easyesMapper.insert(articleElastic);
        return "执行完毕";
    }
1
2
3
4
5
6
7
8
9
10

通过如上代码就可实现对es的数据新增

3. 修改数据

根据id去修改es中的数据

    @PutMapping("update")
    public void update(@RequestBody ArticleElastic articleElastic){
        easyesMapper.updateById(articleElastic);
    }

1
2
3
4
5

4. 删除数据

根据id去批量删除数据

    /**
     * 根据id删除es中的数据
     * @param id
     */
    @DeleteMapping("delete/{id}")
    public void deleteData(@PathVariable Long id){
        easyesMapper.deleteById(id);
    }

1
2
3
4
5
6
7
8
9

5. 分词并分页查询

根据文章标题、描述去分词并分页查询，并通过时间倒序排序

  @GetMapping("search")
    public ResponseResult test(String keyword){
              LambdaEsQueryWrapper<ArticleElastic> wrapper = new LambdaEsQueryWrapper<>();
        wrapper.multiMatchQuery(keywords,ArticleElastic::getTitle,ArticleElastic::getSummary)
                .orderByDesc(ArticleElastic::getCreateTime);
        EsPageInfo<ArticleElastic> pageInfo = easyesMapper.pageQuery(wrapper, PageUtils.getPageNo().intValue(),PageUtils.getPageSize().intValue());

    }
1
2
3
4
5
6
7
8

四、完结

通过以上步骤，你应该能够轻松地使用Easy-ES来操作Elasticsearch，实现数据的搜索、索引、更新和删除等操作。Easy-ES的简洁和易用性将大大提高你的开发效率，让你能够更好地利用Elasticsearch的强大功能。

相信大家也看到了，这操作语法怎么跟mybatis-plus一样的呢？没错！你没看错，就是跟MP一模一样的操作语法，因为easy-es的作者就是根据借鉴了MP的写法，使得我们操作es能如此的简单明了。不在需要使用原生的es操作类去写大量的代码了。这就是easy的由来。