Java后端开发：使用JPA Criteria API进行动态查询

在java后端开发中，查询数据是一个非常常见的操作，而使用jpa（java persistence api）是一个非常流行的方法。jpa提供了一种灵活、可重用的方式来检索和操作数据库中的数据。然而，对于动态查询（即查询需要根据不同的参数进行调整）来说，使用传统的静态查询语句或者jpql（java persistence query language）可能不太方便。在这种情况下，使用jpa criteria api可以更加便捷和灵活。

JPA Criteria API是一种面向对象的查询方式，通过代码组装查询条件和返回结果来实现。与传统的静态查询语句或JPQL相比，它的一个主要优势是可以在查询过程中动态拼接不同的查询条件，并且能够更好地应对数据模型的变化。本文将介绍如何使用JPA Criteria API来进行动态查询。

1. 实体类

首先，我们需要有一个实体类，假设我们有一个User实体类，它拥有id、name、age、gender等字段。在使用JPA Criteria API之前，我们需要先定义这个实体类。

@Entity
@Table(name = "user")
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private String name;

    private Integer age;

    private Boolean gender;

    // 省略getter和setter方法
}

2. CriteriaBuilder

在使用JPA Criteria API之前，我们需要先获取CriteriaBuilder。CriteriaBuilder是一个工厂类，用于创建各种CriteriaQuery、Predicate和Expression。通常，我们可以通过EntityManager来获取CriteriaBuilder。

@PersistenceContext
private EntityManager entityManager;

public List<User> getUsers() {
    CriteriaBuilder cb = entityManager.getCriteriaBuilder();
    // ... 继续后续操作
}

3. CriteriaQuery

CriteriaQuery用于查询操作，我们可以使用它来设置查询的条件和返回结果的类型。在设置查询条件时，我们可以通过Predicate来设置多个限制条件，Predicate是Criteria API中用于构建查询条件的小工具。

立即学习“Java免费学习笔记（深入）”；

public List<User> getUsers(String name, Integer age, Boolean gender) {
    CriteriaBuilder cb = entityManager.getCriteriaBuilder();
    CriteriaQuery<User> cq = cb.createQuery(User.class);
    Root<User> root = cq.from(User.class);

    List<pre class="brush:php;toolbar:false;"dicate> predicates = new ArrayList<>();

    if (name != null) {
        Predicate namePredicate = cb.equal(root.get("name"), name);
        predicates.add(namePredicate);
    }

    if (age != null) {
        Predicate agePredicate = cb.greaterThanOrEqualTo(root.get("age"), age);
        predicates.add(agePredicate);
    }

    if (gender != null) {
        Predicate genderPredicate = cb.equal(root.get("gender"), gender);
        predicates.add(genderPredicate);
    }

    cq.where(predicates.toArray(new Predicate[0]));
    return entityManager.createQuery(cq).getResultList();
}

上面的代码演示了如何使用CriteriaBuilder来创建CriteriaQuery。首先，我们使用EntityManager获得CriteriaBuilder。然后，我们创建一个查询对象CriteriaQuery cq，指定查询的结果类型为User。使用Root root构造查询条件，这里的root表示User对象。接下来，我们可以使用CriteriaBuilder来创建Predicate对象，将它们添加到列表中。最后，将条件设置到CriteriaQuery中并执行查询返回结果。

4. Expression

Expression是Criteria API中另一个很有用的概念，它表示一个运算表达式，可以被用于计算和比较一些复杂的数据类型。在使用Expression时，我们可以在原来的查询条件下进行更加精细的筛选。例如，我们可以使用between方法来查询age在某个区间内的用户。

拍我AI

AI视频生成平台PixVerse的国内版本

下载

public List<User> getUsersInRange(Integer minAge, Integer maxAge) {
    CriteriaBuilder cb = entityManager.getCriteriaBuilder();
    CriteriaQuery<User> cq = cb.createQuery(User.class);
    Root<User> root = cq.from(User.class);

    Expression<Integer> ageExpression = root.get("age");

    Predicate agePredicate = cb.between(ageExpression, minAge, maxAge);
    cq.where(agePredicate);

    return entityManager.createQuery(cq).getResultList();
}

上述代码查询了年龄在minAge和maxAge之间的用户。需要注意的是，这里我们使用了Expression ageExpression，为了让JPA Criteria API理解我们要查询的age字段是整数类型。

5. 多表查询

在一些场景下，我们需要对多个表进行查询。此时我们需要使用Join，Join是用于多表查询的核心概念。假设我们有一个Task实体类，它拥有id和userId两个字段，userId与User实体类中的id字段关联。

@Entity
@Table(name = "task")
public class Task {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    private Long userId;

    // 省略getter和setter方法
}

我们可以通过Join将两个实体类关联起来，查询指定User下的所有Task。

public List<Task> getUserTasks(Long userId) {
    CriteriaBuilder cb = entityManager.getCriteriaBuilder();
    CriteriaQuery<Task> cq = cb.createQuery(Task.class);
    Root<Task> taskRoot = cq.from(Task.class);
    Join<Task, User> userJoin = taskRoot.join("user");

    Predicate predicate = cb.equal(userJoin.get("id"), userId);
    cq.where(predicate);

    return entityManager.createQuery(cq).getResultList();
}

6. 分页查询

最后，我们介绍一下如何在JPA Criteria API中实现分页查询。和静态查询相比，分页查询也非常常见，对于数据量比较大的场景尤为重要。在JPA Criteria API中，我们可以使用setFirstResult和setMaxResults方法来指定查询的起始位置和返回结果的最大数量。

public List<User> getUsers(Integer pageNum, Integer pageSize) {
    CriteriaBuilder cb = entityManager.getCriteriaBuilder();
    CriteriaQuery<User> cq = cb.createQuery(User.class);
    Root<User> root = cq.from(User.class);

    int offset = (pageNum - 1) * pageSize;
    entityManager.createQuery(cq).setFirstResult(offset).setMaxResults(pageSize);

    return entityManager.createQuery(cq).getResultList();
}

上面的代码演示了如何设置分页查询条件，首先我们通过pageNum和pageSize计算出offset，设置起始位置，然后通过setMaxResults设置返回结果的最大数量。当然，在实际应用中，我们也可以通过其他方式来进行分页查询。

结语

JPA Criteria API是一个非常灵活和强大的工具，它可以在动态查询方面提供很好的支持。当然，在实际应用中，我们还需要考虑性能等问题，但是它可以让我们的代码更具可读性、可维护性和可扩展性。希望这篇文章对正在使用JPA或者考虑使用JPA的读者有所帮助。