Spring Data JPA如何实现多个RequestParams参数的动态过滤？

针对Spring Data JPA场景下多查询参数组合爆炸的问题，有3种成熟的原生/生态内解决方案，无需编写大量if分支硬编码所有参数组合：

方案1：JPA Specifications（官方原生动态查询） #

Spring Data JPA自带JpaSpecificationExecutor接口，支持动态拼接查询谓词，可灵活适配任意非空参数组合：

1. 首先让你的Employee对应的Repository接口继承JpaSpecificationExecutor<Employee>：

public interface EmployeeRepository extends JpaRepository<Employee, Long>, JpaSpecificationExecutor<Employee> {
}

2. 编写通用的条件构造方法，仅需对每个参数做一次非空判断即可：

public Specification<Employee> buildEmployeeFilterSpec(
        String name, Integer age, BigDecimal salary,
        String designation, LocalDate joiningDate, String gender) {
    return (root, query, criteriaBuilder) -> {
        List<Predicate> predicates = new ArrayList<>();
        // 姓名模糊匹配
        if (Objects.nonNull(name)) {
            predicates.add(criteriaBuilder.like(root.get("name"), "%" + name + "%"));
        }
        // 年龄精确匹配
        if (Objects.nonNull(age)) {
            predicates.add(criteriaBuilder.equal(root.get("age"), age));
        }
        // 薪资大于等于指定值
        if (Objects.nonNull(salary)) {
            predicates.add(criteriaBuilder.greaterThanOrEqualTo(root.get("salary"), salary));
        }
        // 剩余职位、入职日期、性别等字段按需求添加判断规则即可
        return criteriaBuilder.and(predicates.toArray(new Predicate[0]));
    };
}

3. 调用时直接传入所有参数即可自动适配过滤条件：

List<Employee> result = employeeRepository.findAll(
    buildEmployeeFilterSpec(name, age, salary, designation, joiningDate, gender)
);

方案2：Query By Example（QBE，极简示例查询） #

如果你的过滤规则以精确匹配、模糊匹配为主，不需要范围/比较类查询，可以用更简洁的按示例查询：

// 构造示例对象，仅赋值非空的查询参数
Employee exampleEmp = new Employee();
if (Objects.nonNull(name)) exampleEmp.setName(name);
if (Objects.nonNull(age)) exampleEmp.setAge(age);
if (Objects.nonNull(gender)) exampleEmp.setGender(gender);

// 配置匹配规则：忽略null值，姓名走模糊匹配，其余字段走精确匹配
ExampleMatcher matcher = ExampleMatcher.matching()
        .withIgnoreNullValues()
        .withMatcher("name", match -> match.contains());

// 直接查询得到结果
List<Employee> result = employeeRepository.findAll(Example.of(exampleEmp, matcher));

方案3：QueryDSL（类型安全动态查询） #

如果希望避免硬编码字段名字符串、降低运行时出错概率，可以引入QueryDSL实现编译期校验的动态查询：

1. 配置QueryDSL插件自动生成查询实体类QEmployee
2. 动态拼接查询条件：

QEmployee qEmployee = QEmployee.employee;
BooleanBuilder conditionBuilder = new BooleanBuilder();

if (Objects.nonNull(name)) {
    conditionBuilder.and(qEmployee.name.contains(name));
}
if (Objects.nonNull(age)) {
    conditionBuilder.and(qEmployee.age.eq(age));
}
if (Objects.nonNull(salary)) {
    conditionBuilder.and(qEmployee.salary.goe(salary));
}

Iterable<Employee> result = employeeRepository.findAll(conditionBuilder);

选型建议 #

• 简单过滤场景优先选Query By Example，代码量最少
• 中等复杂度、需要范围/比较查询的场景选JPA Specifications，无需额外引入依赖
• 复杂查询场景、对代码健壮性要求高的场景选QueryDSL，开发体验更优

内容的提问来源于stack exchange，提问作者Umang Kamdar