Redis OM Spring QBE 指南：Query by Example 让动态搜索如此简单
Redis OM Spring QBE 指南Query by Example 让动态搜索如此简单【免费下载链接】redis-om-springSpring Data Redis extensions for better search, documents models, and more项目地址: https://gitcode.com/gh_mirrors/re/redis-om-spring想要在 Spring Boot 项目中实现灵活的动态搜索却不想为每一种查询条件组合编写 SQL 或 Redis 查询语句Redis OM Spring提供的QBEQuery by Example按示例查询正是为这个场景而生。它让你用一个填好字段的实体对象就能完成搜索彻底告别拼接查询条件的噩梦。本文是一份通俗易懂的 QBE 指南带你从零掌握动态搜索的优雅写法。QBE 是什么三个核心概念一次看懂QBE 的核心思想非常朴素你给个样例我照着找。它由三个部分组成Probe探针一个填充了部分字段的实体实例字段值就是匹配条件ExampleMatcher匹配器定义匹配规则比如是否区分大小写、是否包含匹配Example示例把探针和匹配器组合成一个完整查询相比手写 Redis 查询语法QBE 的优势在于零学习成本——你只需要会创建对象就会写动态查询。官方文档对它的定位非常明确适合在运行时根据用户输入动态构建查询条件见 qbe.adoc。三步上手从零开始用 QBE 做动态搜索Redis OM Spring 的文档仓库和哈希仓库都已经内置了 QBE 能力。查看 RedisDocumentRepository.java 和 RedisEnhancedRepository.java 可以看到它们都继承了 Spring Data 的QueryByExampleExecutor接口所以开箱即用无需额外配置。第一步创建探针对象MyDoc probe new MyDoc(); probe.setTitle(hello); probe.setTag(Set.of(news));第二步定义匹配器ExampleMatcher matcher ExampleMatcher.matching() .withStringMatcher(StringMatcher.CONTAINING) .withIgnoreCase();第三步执行查询ExampleMyDoc example Example.of(probe, matcher); ListMyDoc results myDocRepository.findAll(example);就这么简单findOne、findAll、count、exists四种方法覆盖了绝大多数搜索场景。如果你想了解内部实现Redis OM Spring 通过 ExampleToNodeConverter.java 把 Example 翻译成 Redis 查询引擎能识别的查询节点。匹配器进阶5 个高频配置让搜索更精准1. 字符串匹配策略 // 精确匹配默认 ExampleMatcher.matching(); // 包含匹配标题含 llo 的记录都能命中 ExampleMatcher.matching().withStringMatcher(StringMatcher.CONTAINING); // 前缀匹配 / 后缀匹配 ExampleMatcher.matching().withStringMatcher(StringMatcher.STARTING); ExampleMatcher.matching().withStringMatcher(StringMatcher.ENDING);在测试用例 RedisDocumentQueryByExampleTest.java 中你可以看到用STARTING匹配hello会同时命中hello world和hello mundo非常直观。2. AND 与 OR控制多条件逻辑// 默认 AND所有条件都要满足 ExampleMatcher.matchingAll(); // OR 逻辑任一条件满足即可 ExampleMatcher.matchingAny();比如搜索标题包含 hello或标签是 artigo 的文章一个matchingAny()就搞定。3. 忽略指定字段ExampleMatcher.matchingAny().withIgnorePaths(aNumber);当探针里的某些字段只是顺带赋值、并不想参与匹配时用withIgnorePaths精准排除。4. 大小写敏感控制ExampleMatcher.matching().withIgnoreCase();5. 空值处理ExampleMatcher.matching().withIncludeNullValues(); 小提示探针为空对象时findAll(example)会返回全部记录——这一点非常适合做不填条件就全量展示的列表页。实战4 种常见动态搜索场景场景一标签搜索TagMyDoc probe new MyDoc(); probe.setTag(Set.of(noticias)); ListMyDoc results repository.findAll(Example.of(probe)); // 命中所有带 noticias 标签的文档场景二数值精确匹配MyDoc probe new MyDoc(); probe.setANumber(1); OptionalMyDoc doc repository.findOne(Example.of(probe));场景三嵌套字段查询QBE 同样支持嵌套对象。比如 Company 实体里包含 CompanyMeta 列表可以这样搜Company probe new Company(); CompanyMeta meta new CompanyMeta(); meta.setStringValue(RD); probe.setMetaList(Set.of(meta)); ListCompany results companyRepository.findAll(Example.of(probe));这在处理一对多的元数据搜索时尤其好用。场景四ID 直达MyDoc probe new MyDoc(); probe.setId(doc123); OptionalMyDoc result repository.findOne(Example.of(probe));进阶玩法Fluent 查询让 QBE 更强大 还在为搜完还要排序分页发愁Redis OM Spring 实现了 Spring Data 的FetchableFluentQuery见 RedisFluentQueryByExample.java让你在 QBE 基础上链式追加排序、分页、投影repository.findBy(example, query - query.sortBy(Sort.by(title).descending()) .limit(10) .all());对应的实现位于 SimpleRedisDocumentRepository.java分页走 Redis 原生的 LIMIT性能有保障。QBE EntityStream动态搜索的终极形态如果你需要比 QBE 更灵活的过滤、排序、聚合可以把 QBE 与 Redis OM Spring 的EntityStream结合使用。仓库、EntityStream、搜索索引三者协同工作复杂的查询需求都能优雅落地。相关测试可以参考 EntityStreamDocumentQueryByExampleTest.java。最佳实践与避坑指南 ✅字段必须建立索引QBE 只会匹配带Indexed、TextIndexed、TagIndexed、NumericIndexed、Searchable等注解的字段未索引字段会被忽略全文搜索用Searchable如果字段需要分词全文检索记得用Searchable而不是TextIndexed动态查询用 QBE固定查询用方法名查询条件固定不变的场景直接用仓库方法名或Query注解更高效关注匹配器性能CONTAINING这类模糊匹配比精确匹配开销更大大数据量下要留意索引设计结合 EntityStream复杂聚合统计需求优先考虑 QBE EntityStream 的组合拳结语Redis OM Spring 的 QBE 功能让动态搜索变得前所未有的简单——不需要拼接查询字符串不需要记住 Redis 查询语法一个样例对象就能解决 80% 的搜索需求。无论是标签筛选、文本模糊匹配还是嵌套元数据查询QBE 都能用最少的代码优雅实现。现在就动手把项目里那些冗长的条件判断代码替换成简洁的 Example 吧【免费下载链接】redis-om-springSpring Data Redis extensions for better search, documents models, and more项目地址: https://gitcode.com/gh_mirrors/re/redis-om-spring创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
