使用Criteria API实现JPA动态查询与分页-java教程-PHP中文网

使用Criteria API实现JPA动态查询与分页

碧海醫心

发布： 2025-11-08 15:52:01

原创

449人浏览过

使用criteria api实现jpa动态查询与分页

本文将深入探讨如何利用Hibernate的`DetachedCriteria` API，结合JPA规范实现复杂的多条件动态查询，并有效集成后端分页功能。我们将通过具体示例，演示如何构建灵活的查询条件，包括对关联实体的过滤，以及如何精确控制结果集的页码和大小，从而在统一的响应中高效地处理大量数据。

在现代企业级应用中，数据查询往往需要高度的灵活性和可配置性。用户可能需要根据多种条件进行过滤，例如按类型、名称或其他属性进行精确或模糊匹配。同时，为了优化性能和用户体验，后端分页是不可或缺的功能。当需要结合这些动态过滤条件与分页时，直接使用JPQL或HQL可能会变得复杂且难以维护。此时，Hibernate的Criteria API（特别是DetachedCriteria）提供了一种类型安全、面向对象的方式来构建这些复杂的查询。

1. 理解DetachedCriteria

DetachedCriteria是Hibernate Criteria API的一部分，它允许我们在Session之外构建查询条件。这意味着我们可以在业务逻辑层构建好查询对象，然后将其传递给DAO层或持久化层，在那里附加到Session并执行。这种分离使得查询的构建更加灵活，并且可以轻松地复用。

假设我们有一个EmployeeEntity类，它包含员工的ID、类型和姓名：

// EmployeeEntity.java
import javax.persistence.*;

@Entity
@Table(name = "employees")
public class EmployeeEntity {
  @Id
  @GeneratedValue(strategy = GenerationType.IDENTITY)
  private Long id;

  @ManyToOne
  @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 + '\'' +
             '}';
  }
}

// EmployeeType.java
import javax.persistence.*;

@Entity
@Table(name = "employee_types")
public class EmployeeType {
    @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 + '\'' +
               '}';
    }
}

登录后复制

2. 构建动态查询条件

使用DetachedCriteria构建查询的第一步是初始化它，并指定要查询的实体类。

import org.hibernate.criterion.DetachedCriteria;
import org.hibernate.criterion.Restrictions;
import org.hibernate.criterion.MatchMode; // 用于模糊匹配

// 初始化DetachedCriteria，指定要查询的实体类和别名
DetachedCriteria detachedCriteria = DetachedCriteria.forClass(EmployeeEntity.class, "employee");

登录后复制

这里的"employee"是为EmployeeEntity实例指定的别名，方便后续引用其属性。

2.1 添加基本属性过滤

我们可以使用Restrictions类来添加各种过滤条件。例如，如果我们要根据员工姓名进行精确过滤：

蓝心千询

蓝心千询是vivo推出的一个多功能AI智能助手

查看详情

// 添加姓名精确匹配条件
detachedCriteria.add(Restrictions.eq("employee.name", "张三"));

// 也可以添加模糊匹配，例如查找名字以"李"开头的员工
// detachedCriteria.add(Restrictions.like("employee.name", "李%", MatchMode.START));

登录后复制

2.2 添加关联实体属性过滤

更常见的场景是需要根据关联实体的属性进行过滤。例如，我们要查找所有类型为“Teachers”的员工。首先，我们需要创建一个别名来引用关联实体EmployeeType：

// 创建关联实体EmployeeType的别名
// "employee.type" 指的是 EmployeeEntity 中的 type 属性
// "employeeType" 是为关联实体 EmployeeType 创建的别名
detachedCriteria.createAlias("employee.type", "employeeType");
// 添加对关联实体属性的过滤条件
detachedCriteria.add(Restrictions.eq("employeeType.name", "Teachers"));

登录后复制

通过createAlias("employee.type", "employeeType")，我们将EmployeeEntity的type属性关联到别名employeeType，然后就可以通过employeeType.name来访问EmployeeType实体的name属性。

2.3 组合多个过滤条件

DetachedCriteria允许我们组合任意数量的条件。例如，查找名为“Alice”且类型为“Carers”的员工：

detachedCriteria.add(Restrictions.eq("employee.name", "Alice"));
detachedCriteria.createAlias("employee.type", "employeeType"); // 再次创建别名，如果之前没有
detachedCriteria.add(Restrictions.eq("employeeType.name", "Carers"));

登录后复制

所有通过add()方法添加的条件默认是AND关系。如果需要OR关系，可以使用Restrictions.or()或Restrictions.disjunction()。

// 查找类型为“Teachers”或“Carers”的员工
detachedCriteria.createAlias("employee.type", "employeeType");
detachedCriteria.add(Restrictions.or(
    Restrictions.eq("employeeType.name", "Teachers"),
    Restrictions.eq("employeeType.name", "Carers")
));

登录后复制

3. 实现后端分页

在构建好查询条件后，下一步就是应用分页逻辑。分页通常需要两个参数：当前页码（pageNumber）和每页大小（pageSize）。

// 假设传入的pageNumber是从1开始的页码，pageSize是每页记录数
int pageNumber = 1; // 示例：请求第一页数据
int pageSize = 10;  // 示例：每页10条记录

// 计算查询结果的起始索引（偏移量）
// 注意：Criteria API的setFirstResult是从0开始的索引
Integer firstResult = (pageNumber - 1) * pageSize;

// 将分页参数应用到DetachedCriteria对象
// 注意：DetachedCriteria本身不直接执行，需要通过Session转换为可执行的Criteria
// 这里只是展示如何计算和应用参数，实际执行在下一步
// criteria.setFirstResult(firstResult); // DetachedCriteria 没有 setFirstResult 方法
// criteria.setMaxResults(pageSize);     // DetachedCriteria 没有 setMax

登录后复制

以上就是使用Criteria API实现JPA动态查询与分页的详细内容，更多请关注php中文网其它相关文章！