如何使用JPA的Query by Example匹配时间戳范围？

当然可以用Query by Example（QBE）实现你的需求！QBE默认是做等值匹配，但通过自定义ExampleMatcher，我们可以轻松为时间戳属性添加范围匹配规则，同时保留ID的等值匹配，完全不需要写JPQL语句。

具体实现步骤 #

1. 创建查询原型对象：先实例化Sale对象，设置你需要等值匹配的商品ID，其他不需要匹配的属性保持为null（或者后面通过匹配器忽略）。
2. 自定义ExampleMatcher：为timestamp属性指定范围匹配规则，同时配置忽略无关属性或null值。
3. 构建Example并执行查询：用原型对象和匹配器创建Example，然后调用仓库的findAll()方法即可。

完整代码示例 #

// 1. 定义时间范围
Timestamp startTime = Timestamp.valueOf("2021-10-20 07:00:00");
Timestamp endTime = Timestamp.valueOf("2021-10-20 13:00:00");

// 2. 创建查询原型：只设置需要等值匹配的商品ID
Sale salePrototype = new Sale();
salePrototype.setId(7L);

// 3. 构建自定义匹配器
ExampleMatcher matcher = ExampleMatcher.matching()
    // 为timestamp属性添加时间范围匹配：大于startTime且小于endTime
    .withMatcher("timestamp", match -> match.greaterThan(startTime).and(match.lessThan(endTime)))
    // 忽略原型对象中所有为null的属性，避免不必要的等值匹配
    .withIgnoreNullValues()
    // 如果有其他不需要参与匹配的属性，可以明确忽略（比如Sale的其他字段）
    .withIgnorePaths("amount", "customerId");

// 4. 创建Example并执行查询
Example<Sale> saleExample = Example.of(salePrototype, matcher);
List<Sale> targetSales = salesRepository.findAll(saleExample);

关键说明 #

• 匹配规则组合：通过match.greaterThan().and(match.lessThan())可以轻松组合时间范围的两个条件，如果你需要包含边界值（比如>=7:00和<=13:00），可以换成greaterThanOrEqualTo()和lessThanOrEqualTo()。
• 忽略无关属性：withIgnoreNullValues()会自动忽略原型对象中为null的属性，避免这些属性被当成等值条件加入查询；如果有某些非null但不需要匹配的属性，用withIgnorePaths()明确指定忽略。
• 版本兼容性：确保你的Spring Data JPA版本在2.0及以上，这些灵活的匹配器功能是在这个版本后完善的。

这种方式既保留了QBE的简洁性，又实现了动态的范围查询，相比手写JPQL，代码更易维护，尤其是当后续需要添加更多查询条件时，只需扩展匹配器即可。

内容的提问来源于stack exchange，提问作者Bartosz Walusiak