JPA Criteria API:实现复杂多条件查询与高效分页

JPA Criteria API:实现复杂多条件查询与高效分页

本文详细介绍了如何利用jpa criteria api处理复杂的多条件查询与分页场景。针对需要对不同实体类型进行独立筛选并合并结果的需求,文章阐述了如何通过criteria api构建动态查询、添加限制条件,并结合分页参数实现高效且统一的数据检索。

1. 理解复杂查询与分页的挑战

在企业级应用开发中,数据查询往往不仅仅是简单的单表查询。例如,我们可能需要从一个包含多种员工类型(如教师、护理人员)的表中,根据不同的类型或多种条件进行筛选,并最终将这些筛选结果合并为一个统一的列表进行分页展示。传统的SQL拼接字符串容易出错且存在SQL注入风险,而JPA的Specification接口虽然提供了一定的抽象,但在处理跨多个独立条件或需要“联合”效果(即满足任一条件即可)的场景时,直接使用可能显得不够灵活。此时,JPA Criteria API作为一种类型安全、动态构建查询的强大工具,成为了解决此类复杂问题的理想选择。

2. JPA Criteria API 核心概念

JPA Criteria API 允许开发者以编程方式构建查询,而不是通过字符串形式的JPQL。它提供了一套丰富的接口来表示查询的各个部分。理解以下核心组件是使用Criteria API的基础:

CriteriaBuilder: 用于创建查询表达式、谓词(Predicate)、排序(Order)等查询构建元素。它是构建所有Criteria查询的起点。CriteriaQuery: 定义了查询的整体结构,包括要查询的实体类型T、根(Root)、选择(Selection)、条件(Predicate)和排序(Order)等。Root: 表示查询的起始实体,类似于SQL中的FROM子句。通过Root可以访问实体的属性。Predicate: 表示查询条件,如相等、大于、小于、LIKE、AND、OR等。CriteriaBuilder提供了多种方法来创建Predicate。Path / Join: Path用于访问实体的属性。当需要查询关联实体(如EmployeeEntity的type属性如果是一个关联实体EmployeeType)时,可以使用join()方法创建Join对象,从而在关联实体上添加条件。EntityManager: 作为JPA的核心接口,用于管理实体生命周期和执行查询。

3. 构建动态筛选条件

假设我们有以下员工实体模型,其中EmployeeType是一个独立的实体:

闪念贝壳 闪念贝壳

闪念贝壳是一款AI 驱动的智能语音笔记,随时随地用语音记录你的每一个想法。

闪念贝壳 218 查看详情 闪念贝壳

import javax.persistence.*;import java.io.Serializable;@Entity@Table(name = "employees")public class EmployeeEntity implements Serializable {    @Id    @GeneratedValue(strategy = GenerationType.IDENTITY)    private Long id;    @ManyToOne(fetch = FetchType.LAZY)    @JoinColumn(name = "employee_type_id")    private EmployeeType type; // 关联到 EmployeeType 实体    private String name;    // 构造函数    public EmployeeEntity() {}    public EmployeeEntity(EmployeeType type, String name) {        this.type = type;        this.name = name;    }    // Getters and Setters    public Long getId() { return id; }    public void setId(Long id) { this.id = id; }    public EmployeeType getType() { return type; }    public void setType(EmployeeType type) { this.type = type; }    public String getName() { return name; }    public void setName(String name) { this.name = name; }    @Override    public String toString() {        return "EmployeeEntity{" +               "id=" + id +               ", type=" + (type != null ? type.getName() : "null") +               ", name='" + name + ''' +               '}';    }}@Entity@Table(name = "employee_types")class EmployeeType implements Serializable {    @Id    @GeneratedValue(strategy = GenerationType.IDENTITY)    private Long id;    private String name; // 例如:"Teachers", "Carers"    // 构造函数    public EmployeeType() {}    public EmployeeType(String name) {        this.name = name;    }    // Getters and Setters    public Long getId() { return id; }    public void setId(Long id) { this.id = id; }    public String getName() { return name; }    public void setName(String name) { this.name = name; }    @Override    public String toString() {        return "EmployeeType{" +               "id=" + id +               ", name='" + name + ''' +               '}';    }}

现在,我们将使用Criteria API构建一个查询,实现按员工类型和名称进行筛选,并支持“联合”逻辑(例如,查询教师或护理人员)。

import javax.persistence.EntityManager;import javax.persistence.TypedQuery;import javax.persistence.criteria.*;import java.util.ArrayList;import java.util.List;public class EmployeeRepositoryCriteria {    public List findEmployeesByCriteria(            String typeName1, String typeName2, String nameFilter,            int pageNumber, int pageSize, EntityManager entityManager) {        CriteriaBuilder cb = entityManager.getCriteriaBuilder();        CriteriaQuery cq = cb.createQuery(EmployeeEntity.class);        Root employee = cq.from(EmployeeEntity.class);        List predicates = new ArrayList();        // 1. 添加员工类型筛选条件 (模拟“联合”效果:typeName1 或 typeName2)        // 注意:这里假设type是一个关联实体,通过join来访问其属性        Join employeeTypeJoin = employee.join("type", JoinType.INNER);        Predicate typePredicate1 = cb.equal(employeeTypeJoin.get("name"), typeName1);        Predicate typePredicate2 = cb.equal(employeeTypeJoin.get("name"), typeName2);        // 使用 cb.or() 实现逻辑 OR,即员工类型是 typeName1 或 typeName2        predicates.add(cb.or(typePredicate1, typePredicate2));        // 2. 添加员工名称模糊筛选条件        if (nameFilter != null && !nameFilter.trim().isEmpty()) {            predicates.add(cb.like(employee.get("name"), "%" + nameFilter.trim() + "%"));        }        // 组合所有条件        if (!predicates.isEmpty()) {            cq.where(cb.and(predicates.toArray(new Predicate[0])));        }        // 添加排序        cq.orderBy(cb.asc(employee.get("name")));        // 创建TypedQuery        TypedQuery query = entityManager.createQuery(cq);        // 设置分页参数        query.setFirstResult(pageNumber * pageSize); // 起始索引        query.setMaxResults(pageSize);               // 每页最大记录数        return query.getResultList();    }    // 为了获取总记录数,通常需要另一个CriteriaQuery    public long countEmployeesByCriteria(            String typeName1, String typeName2, String nameFilter,            EntityManager entityManager) {        CriteriaBuilder cb = entityManager.getCriteriaBuilder();        CriteriaQuery countCq = cb.createQuery(Long.class);        Root employee = countCq.from(EmployeeEntity.class);        countCq.select(cb.count(employee)); // 选择计数        List predicates = new ArrayList();        Join employeeTypeJoin = employee.join("type", JoinType.INNER);        Predicate typePredicate1 = cb.equal(employeeTypeJoin.get("name"), typeName1);        Predicate typePredicate2 = cb.equal(employeeTypeJoin.get("name"), typeName2);        predicates.add(cb.or(typePredicate1, typePredicate2));        if (nameFilter != null && !nameFilter.trim().isEmpty()) {            predicates.add(cb.like(employee.get("name"), "%" + nameFilter.trim() + "%"));        }        if (!predicates.isEmpty()) {            countCq.where(cb.and(predicates.toArray(new Predicate[0])));        }        return entityManager.createQuery(countCq).getSingleResult();    }}

在上述代码中:

以上就是JPA Criteria API:实现复杂多条件查询与高效分页的详细内容,更多请关注创想鸟其它相关文章!

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容, 请发送邮件至 chuangxiangniao@163.com 举报,一经查实,本站将立刻删除。
发布者:程序猿,转转请注明出处:https://www.chuangxiangniao.com/p/984175.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2025年12月1日 20:50:03
下一篇 2025年12月1日 20:50:56

相关推荐

发表回复

登录后才能评论
关注微信