dbVisitor 使用 MyBatis 方式操作 ElasticSearch

在 Java 生态中，操作 ElasticSearch 最常见的方式莫过于使用官方的 elasticsearch-java (或旧版的 RestHighLevelClient) 或者 Spring 家族的 spring-data-elasticsearch。这些工具非常强大，但对于习惯了关系型数据库（RDBMS）和 MyBatis 开发模式的开发者来说，切换到 ElasticSearch 往往意味着需要适应一套全新的 API 和思维模式（DSL 构建、Builder 模式等）。

特别是在一个混合架构的项目中，如果同时存在 MySQL 和 ElasticSearch，数据访问层的代码风格割裂感会非常强：一边是 MyBatis 的 Mapper 接口和 XML，另一边是复杂的 DSL 构建代码或 Repository 接口。这种差异不仅增加了学习成本，也让诸如“分页查询”这样的通用功能难以统一实现。

本文将介绍如何使用 dbVisitor，以一种“类 MyBatis”的方式来操作 ElasticSearch，实现架构上的统一。

在传统的混合架构中，我们可能会遇到以下问题：

• API 风格不统一：RDBMS 使用 SQL 和 JDBC，ElasticSearch 使用 REST API 和 JSON DSL。
• 分页实现差异：MyBatis 通常配合 PageHelper 或 RowBounds，而 ElasticSearch 需要手动设置 from 和 size，或者使用 Spring Data 的 Pageable。
• 维护成本高：需要维护两套完全不同的底层逻辑，增加了代码的复杂度和出错的概率。

dbVisitor 通过提供一个 JDBC 驱动层（dbvisitor-driver）和适配器（jdbc-elastic），将 ElasticSearch 的操作封装成了标准的 JDBC 接口。这意味着你可以像操作 MySQL 一样操作 ElasticSearch。

更进一步，dbVisitor 提供了类似 MyBatis 的 ORM 功能，支持 Mapper 接口、XML 映射文件、注解以及 Lambda 表达式。

2.1 对象关系映射 (ORM)

首先，我们定义一个 Java 对象，并使用注解进行映射。这与 MyBatis Plus 或 JPA 非常相似。

@Table("user_info")public class UserInfo {    // 映射 _id 字段    @Column(value = "_id", primary = true)    private String id;    @Column("name")    private String name;    @Column("age")    private Integer age;    // 省略 getter/setter}

2.2 使用 Mapper 接口 (注解方式)

你可以定义一个 Mapper 接口，使用注解来编写 ElasticSearch 的 DSL 命令。

@SimpleMapperpublic interface UserInfoMapper {    // 插入数据    @Insert("POST /user_info/_doc { "name": #{info.name}, "age": #{info.age} }")    int saveUser(@Param("info") UserInfo info);    // 根据 ID 查询    @Query("GET /user_info/_doc/#{id}")    UserInfo loadById(@Param("id") String id);    // 删除数据    @Delete("DELETE /user_info/_doc/#{id}")    int deleteUser(@Param("id") String id);}

2.3 使用通用 Mapper

如果你不想写任何命令，可以直接继承 BaseMapper，dbVisitor 会自动生成基础的 CRUD 操作。

@SimpleMapperpublic interface UserInfoBaseMapper extends BaseMapper {    // 自动拥有 insert, update, delete, selectById, listBySample 等方法}

2.4 使用 Lambda 方式

dbVisitor 也提供了类似 MyBatis Plus 的 Lambda 调用方式，完全类型安全。

LambdaTemplate lambda = new LambdaTemplate(connection);// 查询 name = "mali" 的用户UserInfo user = lambda.query(UserInfo.class)    .eq(UserInfo::getName, "mali")    .queryForObject();// 更新操作lambda.update(UserInfo.class)    .eq(UserInfo::getId, user.getId())    .updateTo(UserInfo::getAge, 27)    .doUpdate();

2.5 使用 XML 管理 Mapper (MyBatis 风格)

对于复杂的查询或需要统一管理 DSL 的场景，dbVisitor 支持使用 XML 文件来定义 Mapper，这与 MyBatis 的体验几乎一致。

Mapper 接口：

@RefMapper("mapper/user-mapper.xml")public interface UserInfoXmlMapper {    int saveUser(@Param("info") UserInfo info);    List listByUserName(@Param("userName") String userName, Page page);}

XML 文件 (user-mapper.xml)：

                                            POST /user_info/_doc {            "name": #{info.name},            "age": #{info.age}        }                    POST /user_info/_search {            "query": {                "term": { "name": #{userName} }            }        }    

在 dbVisitor 中，无论是操作 MySQL 还是 ElasticSearch，分页查询的实现方式是完全统一的。你只需要传递一个 Page 对象。

// 创建分页对象Page page = new PageObject();page.setPageSize(10);page.setPageNumber(0); // 第一页// 执行查询，dbVisitor 会自动拦截并重写为分页查询// 对于 ElasticSearch，会自动转换为 "from": 0, "size": 10List list = mapper.listByUserName("mali", page);// 获取总记录数（如果需要）long total = page.getTotalCount();// 翻页page.nextPage();list = mapper.listByUserName("mali", page);

在 Java 生态中，针对 ElasticSearch 的 ORM 封装百花齐放。以下是 dbVisitor 与几款代表性工具的对比，帮助你做出技术选型：

* 特性 * Official Client * Spring Data ES * Easy-Es * dbVisitor ** :--- * :--- * :--- * :--- * :--- ** 定位 * 官方底层客户端 * Spring 生态标准组件 * ES 界的 MyBatis-Plus * JDBC 驱动 + ORM ** 依赖程度 * 无 (基础库) * 强依赖 Spring * 依赖 Spring / MP * 极低 (仅 JDK + 官方驱动) ** API 风格 * Builder / DSL * Repository / JPA * Lambda / Wrapper * JDBC / Mapper / XML / Lambda ** 动态 SQL * 需手动拼接 JSON * 较弱 * 不支持 XML * 强 (XML 动态标签) ** JDBC 支持 * 无 * 无 * 无 * 原生支持 ** 学习曲线 * 高 (需熟记 DSL) * 中 (需懂 Spring Data) * 中 (需懂 MP) * 低 (兼容 MyBatis/JDBC 习惯) ** 统一性 * 仅限 ES * 需借助 Spring 生态 * 仅限 ES * 一套 API 统一操作 RDBMS 和 ES *

选型建议

• Official Client: 如果你需要使用 ES 的最新特性，或者对性能有极致要求，且不介意编写复杂的 DSL 代码。
• Spring Data Elasticsearch: 如果你是 Spring 全家桶用户，且习惯 JPA/Repository 开发模式。
• Easy-Es: 如果你是 MyBatis-Plus 的重度用户，希望在 ES 中也能获得类似的开发体验。
• dbVisitor: 如果你希望用 标准 JDBC 和 MyBatis XML 的方式统一管理 RDBMS 和 ES，或者你的项目不依赖 Spring (如 Solon, Hasor, 纯 Java)，dbVisitor 是最佳选择。

通过 dbVisitor，我们可以在同一个项目中，用同一套 API、同一种思维方式（Mapper/XML/Lambda）同时操作关系型数据库和 ElasticSearch。这极大地降低了混合架构项目的开发和维护成本，让数据访问层变得更加整洁和统一。

如果你正在寻找一种能够统一 RDBMS 和 NoSQL 开发体验的工具，dbVisitor 绝对值得一试。

• 项目首页：https://www.dbvisitor.net/
• 项目源码：https://gitee.com/zycgit/dbvisitor
• 原文：https://www.dbvisitor.net/blog/elasticsearch-mybatis-style