开源项目 · Java

Cave

统一的 SQL 数据访问层 —— 用一套 SQL / CQL 语法查询 Elasticsearch、MongoDB 和 MySQL。

GitHub 仓库 Maven Central
Java 8+ License Apache-2.0 Build Maven 3.6.3+ Version 0.1.0

特性

用接口签名的方式声明查询,返回类型决定结果映射。

多异构数据源

Elasticsearch、MongoDB、MySQL 三种存储,一套语法通吃。

统一 SQL 查询

同一套 CQL 在不同存储介质之间迁移,切换后端不用重写业务。

显式失败

未实现的语法抛 UnsupportedOperationException / SqlException,绝不静默忽略。

参数绑定

#{} / ${} 参数在进入存储之前完成参数化与转义,防注入。

架构

CQL 经 ANTLR 解析为 AST,再由三个方言解析器分别转换为各存储的查询。

CQL / SQL 子集
↓
CqlLexer + CqlParser (ANTLR)
↓
Statements / AST (SelectStatement · Expr · Function)
↓
ElasticSearchQDLDialectResolver→SearchRequest→ElasticSearchSession→ESRvResolver
MongoQDLDialectResolver→BSON filter→MongoSession→MongoRvResolver
JDBC→PreparedStatement(?)→JdbcPreparedSession→JdbcRvResolver
* JDBC 路径不解析 SQL,直接把参数化后的 SQL 交给 MySQL 执行。

快速开始

引入依赖,声明接口,即可像调用方法一样查询异构数据源。

<!-- pom.xml -->
<dependency>
    <groupId>fun.l-angel</groupId>
    <artifactId>cave-sql</artifactId>
    <version>0.1.0</version>
</dependency>

// 声明查询接口
@Cave
public interface CaveDemo {
    @Select(sql = "select field1, field2 from index1 where f1 = #{param1}", direct = "defaultEs")
    List<Model> queryList(@Param(name = "param1") String param1);
}
返回类型由方法签名决定:List<Model>、单实体、标量、单列列表或 List<Map>。实体映射支持 @CField 指定字段别名。

查询能力

ES 与 MongoDB 共享同一套能力校验与 conformance 测试。

能力ElasticsearchMongoDB
SELECT 字段 / * / 别名✓✓
= != > < >= <= · LIKE / NOT LIKE✓✓
IN / BETWEEN / IS NULL✓✓
AND / OR / NOT · 括号分组✓✓
ORDER BY · LIMIT✓✓
count / avg / sum / min / max · count(distinct)✓✓
GROUP BY / HAVING✗✓
c_exists / c_keyvalue✓✓
c_script(脚本查询)✓✗
JOIN / 子查询 / DISTINCT / UNION / 窗口函数✗✗
未实现的能力(JOIN、子查询、DISTINCT、窗口函数等)会显式抛异常,而不是静默返回错误结果。MySQL 走 JDBC 原生 SQL,能力由 MySQL 决定。

数据源语义差异

Elasticsearch

字符串等值 / IN / LIKE 默认走 field.keyword;未指定 LIMIT 默认 10000 条;暂不支持 scroll / search_after。

MongoDB

单集合查询;LIKE 转为锚定正则(大小写不敏感);支持聚合管道 $match→$group→$project→…。

MySQL / JDBC

支持 SELECT / INSERT / UPDATE / DELETE,参数通过 ? 绑定到 PreparedStatement,不拼接字符串。

参与项目

Apache-2.0 开源,欢迎贡献。