SpringBoot集成Easy-Es的实战操作指南

 更新时间:2025年08月28日 10:08:49   作者:会飞的架狗师  
Easy-ES(简称EE)是一款基于 Elasticsearch 官方 RestHighLevelClient 封装的 ORM 框架,本文将简单介绍一下Easy-ES的具体使用,需要的可以了解下

一、Easy ES 简介

Easy ES(简称EE)是一款基于 Elasticsearch 官方 RestHighLevelClient 封装的 ORM 框架,提供类似 MyBatis-Plus 的 API 设计,可以帮助开发者更简单地集成和使用 Elasticsearch,让操作 Elasticsearch 变得更加方便和高效,大大降低了 Elasticsearch 操作复杂度。

二、环境准备

1. 依赖引入

<dependency>
    <groupId>org.elasticsearch.client</groupId>
    <artifactId>elasticsearch-rest-high-level-client</artifactId>
    <version>7.17.19</version>
</dependency>

<dependency>
    <groupId>org.dromara.easy-es</groupId>
    <artifactId>easy-es-boot-starter</artifactId>
    <version>2.0.0</version>
</dependency>

2. 增加配置

# application.yml
easy-es:
  enable: true
  address: 127.0.0.1:9200
  username: admin
  password: 123456
  # 可选配置
  global-config:
    print-dsl: true # 打印DSL语句
    async-process-index-blocking: true # 自动托管索引

三、核心功能集成

1. 新增 Mapper

自定义一个 Mapper,并继承 BaseEsMapper

public interface MyEsCollectionMapper extends BaseEsMapper<MyCollection> {

}

2. 指定索引

在 Collection 中,需要指定和 ES 交互的索引 key

@Data
@IndexName(value = "my_collection")
public class MyCollection extends BaseEntity {

    /**
     * 姓名
     */
    private String name;

    // 其他字段

}

3. 在启动类上添加 ES 的 Mapper 扫描配置

@EsMapperScan("cn.feizhu.jgs.*.infrastructure.es.mapper")

4. 使用 Easy ES 进行查询

@Component
public class MyEsCollectionMapperTest {
    @Resource
    private MyEsCollectionMapper myEsCollectionMapper;

    @Test
    public void test(){
        LambdaEsQueryWrapper<MyCollection> queryWrapper = new LambdaEsQueryWrapper<>();
        queryWrapper.match(MyCollection::getName, "会飞的我")
                .and(wrapper -> wrapper
                        .match(MyCollection::getIsDeleted, true));

        EsPageInfo<MyCollection> results = myEsCollectionMapper.pageQuery(queryWrapper, 1, 10);
    }
}

四、Easy ES 的用法

1.基础 CRUD 示例

@Service
public class ArticleService {
    @Resource
    private ArticleMapper articleMapper;

    // 新增文档
    public Boolean addArticle(Article article) {
        return articleMapper.insert(article) > 0;
    }

    // 条件查询
    public List<Article> searchByKeyword(String keyword) {
        LambdaEsQueryWrapper<Article> wrapper = new LambdaEsQueryWrapper<>();
        wrapper.match(Article::getContent, keyword);
        return articleMapper.selectList(wrapper);
    }

    // 更新文档
    public Boolean updateAuthor(String id, String newAuthor) {
        Article article = new Article();
        article.setId(id);
        article.setAuthor(newAuthor);
        return articleMapper.updateById(article) > 0;
    }

    // 删除文档
    public Boolean deleteArticle(String id) {
        return articleMapper.deleteById(id) > 0;
    }
}

2.分页查询

public PageInfo<Article> searchPage(String keyword, int pageNum, int pageSize) {
    LambdaEsQueryWrapper<Article> wrapper = new LambdaEsQueryWrapper<>();
    wrapper.match(Article::getTitle, keyword)
           .orderByDesc(Article::getCreateTime);
    
    return articleMapper.pageQuery(wrapper, pageNum, pageSize);
}

3. 复杂布尔查询

public List<Article> complexQuery(String author, Date startDate) {
    LambdaEsQueryWrapper<Article> wrapper = new LambdaEsQueryWrapper<>();
    wrapper.eq(Article::getAuthor, author)
           .ge(Article::getCreateTime, startDate)
           .or()
           .match(Article::getContent, "技术");
    
    return articleMapper.selectList(wrapper);
}

4. 高亮显示

public List<Article> searchWithHighlight(String keyword) {
    LambdaEsQueryWrapper<Article> wrapper = new LambdaEsQueryWrapper<>();
    wrapper.match(Article::getContent, keyword)
           .highLight(Article::getContent, 
               "<em>", "</em>", 100);
    
    return articleMapper.selectList(wrapper);
}

5. 开启自动创建索引的两种方式

1.通过配置文件开启(推荐)

# application.yml
easy-es:
  global-config:
    async-process-index-blocking: true  # 自动托管索引(包含自动创建)

2.通过代码配置(动态启用)

@Configuration
public class EsConfig {
    @Bean
    public GlobalConfig globalConfig() {
        GlobalConfig config = new GlobalConfig();
        config.setAsyncProcessIndexBlocking(true); // 开启索引自动托管
        return config;
    }
}

五、注意事项

索引管理:开启auto-create-index后,首次插入数据时会自动创建索引

字段映射:ES 字段类型需与 Java 类型匹配,避免类型转换异常

分词器配置:中文搜索建议使用 ik 分词器,需提前安装插件

版本兼容:确保 ES 服务版本与 Easy ES 兼容(推荐ES 7.x+)

六、总结

通过 Easy ES 框架,我们可以:

  • 减少约 80% 的 ES 操作代码量
  • 使用熟悉的 MyBatis-Plus 风格 API
  • 支持自动索引托管等高级特性
  • 保留原生 API 扩展能力

到此这篇关于SpringBoot集成Easy-Es的实战操作指南的文章就介绍到这了,更多相关SpringBoot集成Easy-Es内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring AI框架结合Sentinel实现限流功能

    Spring AI框架结合Sentinel实现限流功能

    这篇文章主要为大家详细介绍了如何实现一个简单的使用Spring AI框架结合Sentinel限流的功能,场景是一个智能客服系统,感兴趣的小伙伴可以了解下
    2025-06-06
  • Java连接Redis报错:NoSuchElementException: Unable to validate object的解决办法

    Java连接Redis报错:NoSuchElementException: Unable to&nb

    这篇文章主要介绍了Java连接Redis报错:NoSuchElementException: Unable to validate object的解决办法,文中通过图文讲解的非常详细,具有一定的参考价值,需要的朋友可以参考下
    2024-12-12
  • 如何使用HttpClient发送java对象到服务器

    如何使用HttpClient发送java对象到服务器

    这篇文章主要介绍了如何使用HttpClient发送java对象到服务器,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 深入理解 Java注解及实例

    深入理解 Java注解及实例

    这篇文章主要介绍了深入理解 Java注解及实例的相关资料,希望通过本文大家能够掌握java注解的知识,需要的朋友可以参考下
    2017-09-09
  • springboot调用C#封装的DLL文件中函数的实现那

    springboot调用C#封装的DLL文件中函数的实现那

    本文主要介绍了在Spring Boot中集成C# DLL,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-07-07
  • SpringBoot使用JdbcTemplate访问操作数据库基本用法

    SpringBoot使用JdbcTemplate访问操作数据库基本用法

    这篇文章主要介绍了SpringBoot使用JdbcTemplate访问操作数据库基本用法,Spring对数据库的操作在jdbc上s面做了深层次的封装,使用spring的注入功能,可以把DataSource注册到JdbcTemplate之中。下文详细内容需要的小伙伴可以参考一下
    2022-02-02
  • Spring Boot日志SLF4J和Logback示例详解

    Spring Boot日志SLF4J和Logback示例详解

    这篇文章主要介绍了Spring Boot日志SLF4J和Logback详解,Logback相比于Log4j,性能提高了10倍以上的性能,占用的内存也变小了,并且文档十分详细,推荐使用Slf4j+Logback,需要的朋友可以参考下
    2023-07-07
  • Java Swing组件单选框JRadioButton用法示例

    Java Swing组件单选框JRadioButton用法示例

    这篇文章主要介绍了Java Swing组件单选框JRadioButton用法,结合具体实例形式分析了Swing单选框JRadioButton的使用方法及相关操作注意事项,需要的朋友可以参考下
    2017-11-11
  • Java源码解析阻塞队列ArrayBlockingQueue功能简介

    Java源码解析阻塞队列ArrayBlockingQueue功能简介

    今天小编就为大家分享一篇关于Java源码解析阻塞队列ArrayBlockingQueue功能简介,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2019-01-01
  • spring security与corsFilter冲突的解决方案

    spring security与corsFilter冲突的解决方案

    这篇文章主要介绍了spring security与corsFilter冲突的解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-11-11

最新评论