Query By Example

Posted 2023-05-01

参考技术A QBE

包含三部分：

使用如下场景：

有如下限制：

示例：
创建一个domain类：

上例定义一个domain类，可以用他来创建Example 。 默认情况下，null字段将被忽略，String将使用特定数据源的默认值匹配。 可以使用工厂方法或ExampleMatcher创建。 Example是不可变对象immutable 。

Example使用repository执行。 这需要让你的repository接口继承 QueryByExampleExecutor<T> ， 如下：

Example不限制默认设置。 可以通过Example Matchers 来指定 string 匹配、 null处理、特定属性设置。

上例解释：

默认情况下， ExampleMatcher 会匹配所有字段。

可以指定单个属性的行为（如 firstname and lastname 或者 内嵌属性"address.city"） 。
可以调节匹配选项 和 大小写敏感：

可以在ExampleMatcher上设置默认匹配设置， 也可以为单个属性路径进行设置。 除非明确定义， 否则， ExampleMatcher上的设置都会被属性路径继承：

默认， Example 都是严格限制类型的 。
通过使用 UntypedExampleMatcher ， 可以不限制类型。

下例， 综合使用了排序， 分页 。
注意：

JPA Query By Example (QBE) 不支持日期查询

JPA Query By Example (QBE) 不支持日期查询

文章目录

• JPA Query By Example (QBE) 不支持日期查询
• • 一. 先说结论
  • • 1.1 在原有的repo上继承JpaSpecificationExecutor
    • 1.2 构建Specification
    • 1.3 调用repo.findAll方法时传入Specification
  • 二. 问题描述
  • 参考资料

一. 先说结论

Query By Example(下文统称QBE)

只支持字符串类型的Example查询, 如果要加另外的例如日期类型的查询, 需要通过构建额外的Specification来实现

1.1 在原有的repo上继承JpaSpecificationExecutor

public interface TranxlogRepository extends JpaRepository<Tranxlog, Long>, JpaSpecificationExecutor<Tranxlog> 

1.2 构建Specification

public Specification<TranxLog> getSpecFromDatesAndExample(
  LocalDateTime from, LocalDateTime to, Example<TranxLog> example) 
    return (root, query, builder) -> 
         final List<Predicate> predicates = new ArrayList<>();
         if (from != null) 
            predicates.add(builder.greaterThan(root.get("dateField"), from));
         
         if (to != null) 
            predicates.add(builder.lessThan(root.get("dateField"), to));
         
         predicates.add(QueryByExamplePredicateBuilder.getPredicate(root, builder, example));
         return builder.and(predicates.toArray(new Predicate[predicates.size()]));
    
;

1.3 调用repo.findAll方法时传入Specification

public Page<TranxLog> findAllByConditions(TranxReportFormModel formModel, Pageable page) 
    ExampleMatcher matcher = ExampleMatcher.matching()
            .withNullHandler(ExampleMatcher.NullHandler.IGNORE)
            .withStringMatcher(ExampleMatcher.StringMatcher.CONTAINING)
            .withIgnoreCase()
            .withIgnoreNullValues();
    Example<TranxLog> example = Example.of(formModel.getTranxLog(), matcher);
    return tranxlogRepository.findAll(getSpecFromDatesAndExample(from, to, Example.of(formModel.getTranxLog(), matcher)), page);

二. 问题描述

QBE是JPA给我们提供的一个通过样例查询的方式, 我们可以通过构建一个 entity “案例”, 然后JPA会通过这个entity存在的字段为我们构建查询.

下图为JpaRepository提供的Example查询方法定义

但是通过查看ExampleMatcher源码发现只有StringMatcher一种实现, 这意味着我们只能对一些字符类型的列进行模糊匹配或者全匹配(也支持REGEX形式的匹配).

如果要对日期类型进行比较则不支持, 需要我们手动构建一个包含Example查询的Specification(详情参照上文, 不赘述)

参考资料

• Spring JPA使用CriteriaBuilder动态构造查询方式
• stackoverflow关于此问题的解答
• 简书-JPA QBE