Elastic：像mybatis-plus一样优雅的书写es客户端代码——Easy-Es

古城微笑少年丶 2024-03-23 18:52 54阅读 0赞

## 0. 引言 ##

es的java客户端不太友好的语法一直饱受诟病，书写一个查询语句可能需要书写一大串的代码，如果能像mybatis–plus一样，支持比较灵活方便的语句生成器那就好了。

于是为elasticsearch而生的ORM框架Easy-Es诞生了，使用及其方便快捷，今天我们就一起来学习easy-es，对比看看原生java-client方便之处在哪儿。

## 1. Easy-Es简介 ##

Easy-Es是以elasticsearch官方提供的`RestHighLevelClient`为基础，而开发的一款针对es的ORM框架，类似于es版的mybatis-plus，可以让开发者无需掌握es复杂的DSL语句，只要会mysql语法即可使用es，快速实现es客户端语法

官方文档：[https://www.easy-es.cn/][https_www.easy-es.cn]  
![在这里插入图片描述][d5402c5720534e1e8228bbd63d4905c8.png]

## 2. Easy-Es使用 ##

1、引入依赖

<dependency>
                <groupId>org.dromara.easy-es</groupId>
                <artifactId>easy-es-boot-starter</artifactId>
                <version>2.0.0-beta3</version>
            </dependency>
    
            
            <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>

2、添加配置项，这里只配置了几个基本的配置项，更多配置可参考官网文档：[easy-es 配置介绍][easy-es]

easy-es: 
      # es地址、账号密码
      address: 192.168.244.11:9200
      username: elastic
      password: elastic

3、在启动类中添加es mapper文件的扫描路径

@EsMapperScan("com.example.easyesdemo.mapper")

![在这里插入图片描述][deb75c21ba174b91abf0c6884dba18b9.png]

4、创建实体类，通过`@IndexName`注解申明索引名称及分片数，`@IndexField`注解申明字段名、数据类型、分词器等，更多介绍参考官方文档：[essy-es 注解介绍][essy-es]

@IndexName(value = "user_easy_es")
    @Data
    public class UserEasyEs {
        
    
        @IndexId(type = IdType.CUSTOMIZE)
        private Long id;
    
        private String name;
    
        private Integer age;
    
        private Integer sex;
    
        @IndexField(fieldType = FieldType.TEXT, analyzer = Analyzer.IK_SMART, searchAnalyzer = Analyzer.IK_SMART)
        private String address;
    
        @IndexField(fieldType = FieldType.DATE, dateFormat = "yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||epoch_millis")
        private Date createTime;
    
        private String createUser;
    
    }

5、创建mapper类，继承`BaseEsMapper`类，注意这里的mapper一定要创建到第3步中设置的mapper扫描路径下`com.example.easyesdemo.mapper`

public interface UserEsMapper extends BaseEsMapper<UserEasyEs> {
        
    }

6、创建controller，书写创建索引、新增、修改、查询的接口

@RestController
    @RequestMapping("es")
    @AllArgsConstructor
    public class UserEsController {
        
    
        private final UserEsMapper userEsMapper;
    
        /**
         * 创建索引
         * @return
         */
        @GetMapping("create")
        public Boolean createIndex(){
        
            return userEsMapper.createIndex();
        }
    
        @GetMapping("save")
        public Integer save(Long id){
        
            UserEasyEs user = new UserEasyEs();
            user.setId(id);
            user.setName("用户"+id);
            user.setAddress("江苏省无锡市滨湖区");
            user.setAge(30);
            user.setSex(1);
            user.setCreateUser("admin");
            user.setCreateTime(new Date());
            Long count = userEsMapper.selectCount(EsWrappers.lambdaQuery(UserEasyEs.class).eq(UserEasyEs::getId, id));
            if(count > 0){
        
                return userEsMapper.updateById(user);
            }else{
        
                return userEsMapper.insert(user);
            }
        }
    
        @GetMapping("search")
        public List<UserEasyEs> search(String name, String address){
        
            List<UserEasyEs> userEasyEs = userEsMapper.selectList(
                    EsWrappers.lambdaQuery(UserEasyEs.class)
                            .eq(UserEasyEs::getName, name)
                            .match(UserEasyEs::getAddress, address)
                    );
            return userEasyEs;
        }
    
    }

7、分别调用几个接口

*  创建索引  
    ![在这里插入图片描述][4a1660bab85b4147a0e4e8b1dfa6ec72.png]  
    kibana中查询索引，发现创建成功  
    ![在这里插入图片描述][c071372d70f34c3eaf6a4597ca4e48f0.png]
 *  新增接口  
    这里新增了4笔  
    ![在这里插入图片描述][aa6aa43974b64f8791c9b9b1c6210797.png]  
    数据新增成功  
    ![在这里插入图片描述][71d0d58a0b8746ceb71f9133277eed41.png]
 *  数据查询

![在这里插入图片描述][81e54a5f36ad44cb88e5a462c873fffb.png]  
如上便是针对easy-es的简单使用，这里的用法都与mp类似，上手相当简单，不用再写那些复杂的DSL语句了

## 3. 拓展介绍 ##

*  条件构造器

> 上述演示，我们构造查询条件时，使用了`EsWrappers`来构造条件，用法与mp及其类型，大家根据提示就可以推导出方法如何书写，更详细的使用说明可以查看官方文档：[easy-es 条件构造器介绍][easy-es 1]

*  索引托管

> 如果想要自动根据创建的es实体类来创建对应的索引，那么只需要调整索引的托管模式为非手动模式即可，因为这里我不需要自动同步数据，所以选择`非平滑模式`

easy-es:
      global-config:
        process_index_mode: not_smoothly

> 其中三种模式的区别为：  
> 平滑模式：smoothly，索引的创建、数据更新迁移等都由easy-es自动完成  
> 非平滑模式：not\_smoothly，索引自动创建，但不会自动迁移数据  
> 手动模式：manual，全部操作由用户手动完成，默认模式

*  数据同步

> 如果数据源是来自mysql, 那么建议使用canal来进行同步，canal的使用可在我主页搜索。  
> 其次还有DataX, Logstash等同步工具，当然你也可以使用easy-es提供的CRUD接口，来手动同步数据

*  日志打印

> 通过开启日志，可以在控制台打印执行的DSL语句，更加方便我们在开发阶段进行问题排查

logging:
      level:
       tracer: trace # 开启trace级别日志,在开发时可以开启此配置,则控制台可以打印es全部请求信息及DSL语句,为了避免重复,开启此项配置后,可以将EE的print-dsl设置为false.

*  聚合查询  
    easy-es实现的聚合查询，只要是针对group by这类聚合，也就是es中的`Terms aggregation`，以及最大值、最小值、平均值、求和，而对于其他类型的聚合，还在不断更新中，但这里大家也需要了解，es的聚合和mysql的聚合完全是不一样的维度和复杂度，es支持非常多的聚合查询，所以其他类型的实现还需要借助`RestHighLevelClient`来实现

我们利用easy-es来实现下之前书写的[聚合案例][Link 1]  
![在这里插入图片描述][7cfaa9ba16624a5ba92430aef6b29d44.png]

@RestController
    @AllArgsConstructor
    @RequestMapping("order")
    public class OrderEsController {
        
    
        private final OrderTestEsMapper orderEsMapper;
    
        @GetMapping("search")
        public String search(){
        
            SearchResponse search = orderEsMapper.search(EsWrappers.lambdaQuery(OrderTest.class).groupBy(OrderTest::getStatus));
    
            // 包装查询结果
            Aggregations aggregations = search.getAggregations();
            Terms terms = (Terms)aggregations.asList().get(0);
            List<? extends Terms.Bucket> buckets = terms.getBuckets();
            HashMap<String,Long> statusRes = new HashMap<>();
            buckets.forEach(bucket -> {
        
                statusRes.put(bucket.getKeyAsString(),bucket.getDocCount());
            });
            System.out.println("---聚合结果---");
            System.out.println(statusRes);
            return statusRes.toString();
        }
    }

可以看到实际上的查询语句就一行，而其他的都是对返回结果的封装，因为es本身返回的数据是封装到嵌套的对象中的，所以我们需要对其进行包装

对比原始的查询语句，其易用性上的提升还是很明显的  
![在这里插入图片描述][e931fc3ebc1944c796dbbdd6cfa22ba9.png]

## 4. 总结 ##

至此对easy-es的介绍就结束了，可以看到如果是针对es实现CRUD上，easy-es表现出非常好的便捷性，而在复杂的聚合查询中，仍然还有进步空间，目前还需要借助`RestHighLevelClient`，但easy-es的出现，为未来提供更好用的ES ORM框架，提供了希望和方向

文中演示代码见：[https://gitee.com/wuhanxue/wu\_study/tree/master/demo/easy-es-demo][https_gitee.com_wuhanxue_wu_study_tree_master_demo_easy-es-demo]

[https_www.easy-es.cn]: https://www.easy-es.cn/
[d5402c5720534e1e8228bbd63d4905c8.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/8d004c15890b4b7d9155fc8bad0a0f9d.png
[easy-es]: https://www.easy-es.cn/pages/eddebb/
[deb75c21ba174b91abf0c6884dba18b9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/8860d2f41cd64b08a5d3c6c636f6ed74.png
[essy-es]: https://www.easy-es.cn/pages/ac41f0/#esmapperscan
[4a1660bab85b4147a0e4e8b1dfa6ec72.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/ccf91b339aa944a4b17a2c272a23e787.png
[c071372d70f34c3eaf6a4597ca4e48f0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/78e0b3ed0453417981c63fb78999bb28.png
[aa6aa43974b64f8791c9b9b1c6210797.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/7f64382a97b9428185d69af191113e40.png
[71d0d58a0b8746ceb71f9133277eed41.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/743a4f67f973478ebb051e91b5384aa3.png
[81e54a5f36ad44cb88e5a462c873fffb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/c627f9ead619439d9226fd0826bb94f7.png
[easy-es 1]: https://www.easy-es.cn/pages/a10c18/
[Link 1]: https://wu55555.blog.csdn.net/article/details/125013357
[7cfaa9ba16624a5ba92430aef6b29d44.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/0301297f321148de8bd94bedb99464e3.png
[e931fc3ebc1944c796dbbdd6cfa22ba9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/fefef235018a4011bd16d1e50cd5efcf.png
[https_gitee.com_wuhanxue_wu_study_tree_master_demo_easy-es-demo]: https://gitee.com/wuhanxue/wu_study/tree/master/demo/easy-es-demo