资讯动态

Erupt 对接 Elasticsearch 数据源全解析:注解驱动索引绑定、查询下推与完整 CRUD 实现

发布时间:2026/10/15 20:56:54 来源:尧图企业网站定制
后端低代码AI 应用人工智能AI Agent认证鉴权RAG【免费下载链接】erupt 通用数据管理框架VORM 对象视图模型注解驱动低代码开发项目地址https://gitcode.com/erupts/erupt点击查看免费下载erupt-data-es是 Erupt 通用数据管理框架下的 Elasticsearch 数据源实现它基于 Spring Data Elasticsearch让你可以用一套Erupt注解模型直接绑定 ES 索引让过滤、排序、分页全部下推到_search同时由框架基础引擎完成 drill钻取与条件字符串的解析。读完本文你将掌握如何在 Erupt 项目中接入 ES 集群、如何编写可被管理后台识别的 ES 模型类、CRUD 背后的 upsert 与 refresh 语义以及精确查询/排序必须遵守的字段类型约束。一、模块定位Erupt 数据源体系中的 ES 实现Erupt 的核心是注解驱动 数据源可插拔业务模型通过Erupt声明为一个可管理的实体而数据实际存储在何处则由模型上标注的数据处理器Data Processor决定。默认数据处理器是 JPA见 EruptConst.java 中的DEFAULT_DATA_PROCESSOR JPA而erupt-data-es注册了一个名为ELASTICSEARCH的处理器专门负责把模型读写映射到 ES 索引。整个接入机制分三步对应 EruptDataProcessor 注解 上的注释说明实现xyz.erupt.core.service.IEruptDataService接口此处由EruptEsDataService完成通过DataProcessorManager.register(数据源名称, 实现类)注册数据源在模型类上用EruptDataProcessor(数据源名称)引用它。数据源的注册与获取由 DataProcessorManager.java 统一管理register把名称与实现类放入一个 Map运行时getEruptDataProcessor读取模型上的注解缺省时回退到JPA再从 Spring 容器取出对应的 Service Bean。因此EruptEsDataService的静态块中public static final String DATA_PROCESSOR ELASTICSEARCH; static { DataProcessorManager.register(DATA_PROCESSOR, EruptEsDataService.class); }就是整个模块被识别的关键入口见 EruptEsDataService.java。模块本身还实现了EruptModule接口由 EruptEsAutoConfiguration.java 通过ComponentScan扫描并注册到 Erupt 模块列表从而在应用启动时随 Spring Boot 自动装配。二、快速上手引入依赖与集群配置2.1 Maven 依赖在项目中引入erupt-data-es即可它会把spring-boot-starter-data-elasticsearch作为传递依赖自动带进来见 pom.xmldependency groupIdxyz.erupt/groupId artifactIderupt-data-es/artifactId version2.3.0/version /dependency从源码结构看模块只依赖erupt-core与 Spring Data Elasticsearch Starter不引入任何额外的 ES 客户端集群访问完全交由 Spring Data 的ElasticsearchOperations完成。2.2 集群连接配置ES 集群的连接参数全部使用标准的 Spring Boot 配置项原文档即如此约定这也是 Spring Data Elasticsearch 的通用做法spring: elasticsearch: uris: http://localhost:9200 username: elastic password: changemeuris集群节点地址可配置多个逗号分隔默认http://localhost:9200username/password启用安全认证时的账号密码其余如连接超时、SSL 等均沿用 Spring Boot 对spring.elasticsearch.*的标准支持。配置完成后Spring 会自动装配ElasticsearchOperations该 Bean 被EruptEsDataService通过Resource注入见 EruptEsDataService.java所有读写操作都由它转发给集群。三、注解驱动把 Java 模型绑定到 ES 索引原文档给出了一个完整的Product示例它是 ES 数据源下模型声明的标准写法。核心是三组注解的配合注解作用Document(indexName product)Spring Data 原生注解声明模型映射到名为product的索引Erupt(name Product, primaryKeyCol id)Erupt 注解声明这是一个可管理的 Erupt 模型主键字段为idEruptDataProcessor(EruptEsDataService.DATA_PROCESSOR)指定数据源处理器为ELASTICSEARCH字段层面使用Id标注主键、Field(type ...)声明 ES 字段类型、EruptField声明该字段在管理后台的展示views与编辑edit行为Getter Setter Document(indexName product) Erupt(name Product, primaryKeyCol id) EruptDataProcessor(EruptEsDataService.DATA_PROCESSOR) public class Product { Id EruptField(views View(title ID)) private String id; Field(type FieldType.Keyword) EruptField( views View(title SKU), edit Edit(title SKU, notNull true, search Search) ) private String sku; Field(type FieldType.Text, fielddata true) EruptField( views View(title Name), edit Edit(title Name, search Search) ) private String name; Field(type FieldType.Double) EruptField(views View(title Price), edit Edit(title Price)) private Double price; Field(type FieldType.Date) EruptField(views View(title Created)) private Date createdAt; }几个容易忽略但影响运行的细节Document必不可少。EruptEsDataService.document()方法在每次操作前都会校验模型类是否标注了Document缺失时直接抛出运行时异常提示Document(indexName ...) annotation is missing见 EruptEsDataService.java。这也是文档_id与索引名映射的唯一依据。primaryKeyCol与Id必须对应。文档_id映射到模型上用Id标注或名为id的字段的属性必须显式声明否则写入与按主键查询都会失效。search Search控制可搜索性。原示例中sku与name开启了搜索二者会在后台表格的搜索栏出现并最终转换为下推的 ES 查询条件。EruptField的视图与编辑能力View/Edit由 Erupt 框架统一处理与数据源无关因此 ES 模型在管理后台的列表、表单交互体验与 JPA 模型完全一致。四、完整 CRUDsave 即 upsert写入后立即 refresh原文档明确说明该数据源支持完整 CRUDlist / find / add / edit / delete且新增与编辑都经由 Spring Data 的save方法——也就是针对文档_id的 upsert存在则更新、不存在则插入。源码实现印证了这一设计见 EruptEsDataService.java操作方法底层调用列表分页查询queryListelasticsearchOperations.search(CriteriaQuery PageRequest)按主键查询findDataByIdelasticsearchOperations.get(id, document)新增addDatasave(object)后执行索引refresh()编辑editData校验主键非空后save(object)再执行索引refresh()删除deleteData校验主键非空后delete(id, document)再执行索引refresh()其中值得注意的两点save的 upsert 语义ES 的index操作天然按_id幂等写入所以新增与编辑共用save是安全且简洁的。编辑前requireId会读取模型主键若为空则抛出es.primary_key_missing的本地化异常见 EruptEsDataService.java。写后 refreshES 默认近实时写入后 1 秒内可能不可见。由于管理后台每次写操作后都会立即重新查询表格EruptEsDataService在addData/editData/deleteData之后都会调用elasticsearchOperations.indexOps(document).refresh()强制刷新索引保证数据立即可见见 EruptEsDataService.java。原文档的 Gotchas 提示对于写入频繁的生产环境热索引频繁 refresh 会带来性能开销此时可以考虑继承EruptEsDataService重写写方法去掉 refresh 调用。五、查询下推条件如何翻译成_search这是本模块最核心的设计管理后台的过滤、排序、分页最终都会翻译成CriteriaQuery交给ElasticsearchOperations.search执行即下推到 ES 的_searchAPI而不是把全量数据拉回内存再过滤。5.1 条件表达式映射EruptEsDataService.buildCriteria()把 Erupt 通用条件Condition字段、表达式、值三元组逐一映射为 Spring Data ES 的Criteria见 EruptEsDataService.javaErupt 表达式生成的 Criteria语义EQCriteria.where(key).is(value)等值term匹配NEQwhere(key).is(value).not()不等GT/GTE/LT/LTEgreaterThan/greaterThanEqual/lessThan/lessThanEqual范围比较LIKEwhere(key).contains(value)包含匹配NOT_LIKEwhere(key).contains(value).not()不包含RANGEwhere(key).between(a, b)闭区间IN/NOT_INin(...)/notIn(...)集合匹配NULL/NOT_NULLwhere(key).exists().not()/exists()存在性判断多个条件之间通过criteria.and(sub)串联最终生成 AND 语义的组合查询无任何条件时返回空Criteria。表达式枚举定义在 QueryExpression.java。值得注意的是条件值会先经过基类EruptBeanDataService.convertTarget()按字段类型做转换如字符串 100 转为数值 100保证数值与日期比较语义正确见 EruptBeanDataService.java。5.2 条件字符串与 drill 解析Erupt 的钻取drill与静态过滤器会产生形如Entity.field value的条件字符串。基类EruptBeanDataService的mergeConditions会把EruptQuery中的结构化条件conditions与条件字符串conditionStrings合并parseConditionString负责解析Entity.field value片段为EQ条件值带单引号时自动去引号见 EruptBeanDataService.java。由于 ES 服务的data()已经在_search阶段按条件过滤过了EruptEsDataService重写了conditionsPushedDown()返回true见 EruptEsDataService.java基类因此跳过内存中的二次条件求值避免语义差异与双重过滤——这是下推能够成立的关键开关基类逻辑见 EruptBeanDataService.java。5.3 排序与分页queryList用PageRequest.of(pageIndex - 1, pageSize, buildSort(...))构造分页与排序直接作用于 ES 查询总条数取自searchHits.getTotalHits()见 EruptEsDataService.java。排序规则优先采用页面传入的page.getSort()为空时回退到Erupt(orderBy ...)声明的默认排序DESC/ASC方向被翻译为 Spring Data 的Sort.Direction见 EruptEsDataService.java。另外data()方法供图表、列查询等场景取数设置setMaxResults(10000)这是对 ES 默认from size窗口上限10,000的显式遵守见 EruptEsDataService.java 与 EruptEsDataService.java。六、使用注意事项与最佳实践原文档在 Gotchas 一节给出了三条关键约束这里结合源码进一步展开6.1 字符串字段精确过滤与排序必须用 KeywordES 中FieldType.Text字段会经过分析器分词等值查询term几乎不可能命中完整的原始值也无法按原始值稳定排序。因此需要精确过滤、去重统计或排序的字符串列必须声明为FieldType.Keyword或使用 multi-fieldsfields子字段同时保留 keyword 与 text 两种形态FieldType.Text只适合全文搜索场景本模块中LIKEcontains对 text 字段仍可工作但EQ对 text 字段通常不会命中。原示例中sku声明为Keyword、name声明为Text恰好演示了两种场景的取舍。6.2 主键必须显式声明文档_id映射到模型的Id或名为id的字段必须在模型上显式声明既包括 Spring Data 的Id也包括Erupt的primaryKeyCol。否则save时无法确定_id、findDataById与deleteData也无法按主键定位文档。6.3 写后 refresh 的性能权衡如前所述EruptEsDataService每次写操作后都执行refresh()保证管理后台立即看到最新数据。对于写入压力大的生产环境建议继承该服务并重写addData/editData/deleteData去掉 refresh 调用改由业务层按需刷新。七、延伸数据源体系中的横向对照从erupt-data目录下的各模块可以看出Erupt 已为多种后端提供同类实现且注册机制完全一致——例如AIRTABLE、FEISHU_BITABLE、JDBC、REDIS、S3、NOTION、KUBERNETES、HTTP、LDAP、FILE、DINGTALK_NOTABLE等各模块 Service 中的DATA_PROCESSOR常量。它们都遵循实现IEruptDataService 静态注册 EruptDataProcessor引用的同一套约定因此本文讲解的模型绑定方式与查询下推思路同样适用于理解其他数据源模块而EruptEsDataService与基类EruptBeanDataService的分工下推查询由子类原生执行、通用逻辑由基类兜底是其中最具代表性的模式之一。总结erupt-data-es把 Erupt 的注解驱动开发体验完整地带到了 Elasticsearch 之上模型声明、后台管理界面与 CRUD 交互和 JPA 完全一致而过滤、排序、分页全部下推到_search写操作则利用save的 upsert 语义并配合写后 refresh 保证即时可见。接入时只需记住三件事——引入依赖并配置spring.elasticsearch.*、为模型加上DocumentEruptDataProcessor(ELASTICSEARCH)、对需要精确匹配与排序的字符串字段使用FieldType.Keyword。进一步深入可阅读数据源实现主类EruptEsDataService.java模块自动装配EruptEsAutoConfiguration.java基类与条件解析EruptBeanDataService.java数据源注册中心DataProcessorManager.java数据服务接口契约IEruptDataService.java赞分享后端低代码AI 应用人工智能AI Agent认证鉴权RAG【免费下载链接】erupt 通用数据管理框架VORM 对象视图模型注解驱动低代码开发项目地址https://gitcode.com/erupts/erupt点击查看免费下载相关推荐Erupt 的 MongoDB 数据源实现erupt-data-mongodb 模块配置、模型注解与查询下推原理Erupt 的 MongoDB 数据源实现erupt data mongodb 模块配置、模型注解与查询下推原理 Erupt通用数据管理框架VORM 对象后端低代码AI 应用人工智能AI Agent认证鉴权RAGToolJet 接入 MariaDB 数据源连接配置、CRUD 查询与源码级实现解析ToolJet 接入 MariaDB 数据源连接配置、CRUD 查询与源码级实现解析 MariaDB 是 MySQL 生态中最流行的兼容分支ToolJet低代码后端前端AI 应用MCP 服务Erupt 数据源实战erupt-data-http 将任意 REST 接口绑定为 Erupt 模型Erupt 数据源实战erupt data http 将任意 REST 接口绑定为 Erupt 模型 本篇以 erupt data http 模块说明 ht后端低代码AI 应用人工智能AI Agent认证鉴权RAG上一篇还在为网页视频无法下载而烦恼这款Chrome插件让你一键搞定下一篇KubeVela CloneSet 渐进式发布实战基于 AppRollout 的分批滚动升级与回滚指南创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

读完文章,也想定制专属网站?

尧图设计师 24 小时内与您沟通定制方案

免费获取报价 →
↑