
本文详细阐述了如何在java persistence api (jpa) 中,通过criteria api构建动态且复杂的查询条件,并将其与后端分页功能无缝集成。我们将探讨如何处理多个筛选条件(包括类“或”逻辑的组合),以及如何将分页参数应用于查询结果,最终生成一个统一且支持分页的数据集,从而有效应对如按多种员工类型筛选并分页等业务场景。
理解JPA Criteria API
JPA Criteria API是Java Persistence API (JPA) 规范的一部分,它提供了一种类型安全、编程方式构建查询的机制,而非依赖于字符串拼接的JPQL或原生SQL。这种方式特别适用于构建动态查询,即查询条件在运行时根据用户输入或业务逻辑而变化的情况。相较于JPQL,Criteria API在编译时就能发现潜在的语法错误,并且在处理复杂查询逻辑时通常更易于维护和重构。
构建动态查询条件
要使用Criteria API构建查询,我们通常需要以下核心组件:CriteriaBuilder、CriteriaQuery 和 Root。
-
获取CriteriaBuilder: 它是构建所有查询表达式(如Predicate、Order等)的工厂接口。
EntityManager em = getEntityManager(); // 获取EntityManager实例 CriteriaBuilder cb = em.getCriteriaBuilder();
-
创建CriteriaQuery: 定义查询的返回类型。例如,如果我们要查询EmployeeEntity对象列表,则类型为EmployeeEntity。
CriteriaQuery
cq = cb.createQuery(EmployeeEntity.class); -
定义Root: 指定查询的起始实体,它代表了查询的FROM子句。
Root
employee = cq.from(EmployeeEntity.class); -
添加基本过滤条件: 使用Predicate对象来定义过滤规则。例如,如果我们想根据员工类型进行过滤:
-
如果EmployeeType是EmployeeEntity中的一个枚举字段:
Predicate typePredicate = cb.equal(employee.get("type"), EmployeeType.TEACHERS); cq.where(typePredicate); -
如果EmployeeType是一个独立的实体,并通过关联字段type连接:
// 假设 EmployeeEntity 中有一个 @ManyToOne private EmployeeTypeEntity type; Join
employeeTypeJoin = employee.join("type"); Predicate typePredicate = cb.equal(employeeTypeJoin.get("name"), "Teachers"); // 假设EmployeeTypeEntity有name字段 cq.where(typePredicate);
-
如果EmployeeType是EmployeeEntity中的一个枚举字段:
组合多个查询条件实现“或”逻辑
在实际业务场景中,我们经常需要实现类似“查询类型为教师或护工的员工”这样的需求,这需要将多个条件通过“或”逻辑组合起来。JPA Criteria API通过CriteriaBuilder.or()方法可以轻松实现这种组合。
假设我们需要查询类型为“教师”或“护工”的员工,并且同时支持一个精确的名字匹配。
// 假设 EmployeeEntity 包含 type (枚举类型 EmployeeType) 和 name 字段 ListtypePredicates = new ArrayList<>(); // 条件1: 员工类型为教师 typePredicates.add(cb.equal(employee.get("type"), EmployeeType.TEACHERS)); // 条件2: 员工类型为护工 typePredicates.add(cb.equal(employee.get("type"), EmployeeType.CARERS)); // 将类型条件用 OR 组合 Predicate combinedTypePredicate = cb.or(typePredicates.toArray(new Predicate[0])); // 假设我们还需要一个精确的名字匹配条件 String searchName = "张三"; // 示例搜索名字 Predicate namePredicate = cb.equal(employee.get("name"), searchName); // 最终的 WHERE 子句可以是 (type = 'TEACHERS' OR type = 'CARERS') AND name = '张三' // 使用 cb.and() 将类型组合条件与名字条件再次组合 cq.where(cb.and(combinedTypePredicate, namePredicate));通过










