Spring Data MongoDB 查询示例项目：Query-by-Example 详解

Spring Data MongoDB 查询示例项目：Query-by-Example 详解

spring-data-examples Spring Data Example Projects 项目地址: https://gitcode.com/gh_mirrors/sp/spring-data-examples

什么是 Query-by-Example (QBE)

Query-by-Example (QBE) 是 Spring Data MongoDB 提供的一种直观的查询技术，它允许开发者通过实体对象示例来构建查询条件，而无需编写复杂的 BSON 查询语句。这种查询方式特别适合快速原型开发和动态查询场景。

QBE 的核心优势

1. 简化查询构建：无需手动编写字段名称和查询语法
2. 类型安全：基于实体类进行操作，减少运行时错误
3. 动态查询：可以灵活组合各种查询条件
4. 代码可读性高：查询意图表达清晰

基本使用方式

1. 准备工作

首先确保你的 Repository 接口继承 QueryByExampleExecutor：

public interface PersonRepository extends 
    CrudRepository<Person, String>, 
    QueryByExampleExecutor<Person> {
}

2. 简单示例查询

// 创建查询示例
Person examplePerson = new Person("Jon", "Snow");
Example<Person> example = Example.of(examplePerson);

// 执行查询
List<Person> result = personRepository.findAll(example);

这个查询会查找所有 firstName 为 "Jon" 且 lastName 为 "Snow" 的 Person 文档。

高级匹配选项

Spring Data MongoDB 提供了 ExampleMatcher 来实现更灵活的匹配规则：

ExampleMatcher matcher = ExampleMatcher.matching()
    .withMatcher("firstname", endsWith())  // 匹配以指定值结尾的firstName
    .withMatcher("lastname", startsWith().ignoreCase());  // 匹配以指定值开头且不区分大小写的lastName

Example<Person> example = Example.of(new Person("Jon", "Snow"), matcher);
long count = personRepository.count(example);

常用匹配器方法

• contains(): 包含指定字符串
• startsWith(): 以指定字符串开头
• endsWith(): 以指定字符串结尾
• exact(): 精确匹配（默认）
• regex(): 正则表达式匹配
• ignoreCase(): 忽略大小写

实际应用场景

1. 动态查询表单

当需要根据用户输入动态构建查询条件时，QBE 特别有用：

public List<Person> searchPersons(Person searchCriteria) {
    ExampleMatcher matcher = ExampleMatcher.matching()
        .withStringMatcher(StringMatcher.CONTAINING)
        .withIgnoreCase();
    
    return personRepository.findAll(Example.of(searchCriteria, matcher));
}

2. 部分字段匹配

ExampleMatcher matcher = ExampleMatcher.matching()
    .withIncludeNullValues()  // 包含null值字段
    .withIgnorePaths("age");  // 忽略age字段

Example<Person> example = Example.of(person, matcher);

性能考虑

1. QBE 最终会转换为标准的 MongoDB 查询，性能与手写查询相当
2. 对于复杂查询，建议直接使用 Criteria API
3. 大量数据查询时，考虑添加适当的索引

与 MongoOperations 集成

QBE 也可以直接与 MongoOperations 一起使用：

Example<Person> example = Example.of(new Person("Jon", "Snow"));
List<Person> result = mongoOperations.find(
    Query.query(new Criteria().alike(example)), 
    Person.class
);

最佳实践

1. 为常用查询创建专门的 Repository 方法
2. 合理使用 ExampleMatcher 提高查询灵活性
3. 对于固定条件的查询，考虑使用 @Query 注解
4. 在服务层构建 Example 对象，保持 Repository 接口简洁

总结

Spring Data MongoDB 的 Query-by-Example 功能提供了一种简单直观的方式来构建查询，特别适合快速开发和原型设计。通过合理使用 ExampleMatcher，可以实现相当灵活的查询逻辑，同时保持代码的整洁和可维护性。

spring-data-examples Spring Data Example Projects 项目地址: https://gitcode.com/gh_mirrors/sp/spring-data-examples