深入理解JPA Criteria API的where子句

深入理解JPA Criteria API的where子句

在之前的教程中，我们学习了Criteria API中的where子句的使用。本教程将快速介绍涉及where语句的可用API。

CriteriaQuery.where() 方法

CriteriaQuery接口的where()方法用于应用查询限制条件，如下所示：

CriteriaQuery<T> where(Expression<Boolean> restriction);
CriteriaQuery<T> where(Predicate... restrictions);

where()方法的参数可以是Expression<Boolean>实例或Predicate实例。下面我们将看到如何创建它们。

CriteriaBuilder 方法返回 Predicate

我们可以使用以下方法之一创建Predicate实例：

Predicate exists(Subquery<?> subquery);
Predicate and(Expression<Boolean> x, Expression<Boolean> y);
Predicate and(Predicate... restrictions);
Predicate or(Expression<Boolean> x, Expression<Boolean> y);
Predicate or(Predicate... restrictions);
Predicate not(Expression<Boolean> restriction);
Predicate conjunction();
Predicate disjunction();
Predicate isTrue(Expression<Boolean> x);
Predicate isFalse(Expression<Boolean> x);
Predicate isNull(Expression<?> x);
Predicate isNotNull(Expression<?> x);
Predicate equal(Expression<?> x, Expression<?> y);
Predicate equal(Expression<?> x, Object y);
// ... 其他比较和逻辑操作符

Predicate继承自Expression<Boolean>，因此可以传递给接受Expression<Boolean>参数的上述方法。

快速示例

以下是使用CriteriaBuilder的一个方法（例如equal()）的示例：

CriteriaBuilder criteriaBuilder = entityManager.getCriteriaBuilder();
CriteriaQuery<Customer> query = criteriaBuilder.createQuery(Customer.class);
Root<Customer> customer = query.from(Customer.class);
Predicate predicate = criteriaBuilder.equal(customer.get(Customer_.name), "Lindsey");
query.select(customer).where(predicate);
TypedQuery<Customer> typedQuery = entityManager.createQuery(query);
Customer c = typedQuery.getSingleResult();

Expression 方法返回 Predicate

Expression接口的isNull()和isNotNull()方法可以用来创建Predicate：

Predicate isNull();
Predicate isNotNull();
// ... 其他方法

快速示例

以下是使用isNull()方法的示例：

CriteriaBuilder criteriaBuilder = entityManager.getCriteriaBuilder();
CriteriaQuery<Person> query = criteriaBuilder.createQuery(Person.class);
Root<Person> person = query.from(Person.class);
Expression<Byte> ageExpression = person.get(Person_.age);
Predicate nullAgePredicate = ageExpression.isNull();
query.select(person).where(nullAgePredicate);
TypedQuery<Person> typedQuery = entityManager.createQuery(query);
Person p = typedQuery.getSingleResult();

否定 Predicate

可以使用not()方法来否定Predicate：

Predicate not();

快速示例

以下是使用not()方法的示例：

CriteriaQuery<Person> query = criteriaBuilder.createQuery(Person.class);
Root<Person> person = query.from(Person.class);
Predicate predicate = criteriaBuilder.equal(person.get(Person_.name), "Lindsey");
query.select(person).where(predicate.not());
TypedQuery<Person> typedQuery = entityManager.createQuery(query);
List<Person> p = typedQuery.getResultList();

使用 Expression

Path接口是Expression的一个子接口，意味着Path<Boolean>可以在CriteriaBuilder.where(Expression<Boolean>)中使用。

快速示例

以下是使用Path<Boolean>的示例，假设Person#registeredVoter是一个布尔字段：

CriteriaQuery<Person> query = criteriaBuilder.createQuery(Person.class);
Root<Person> person = query.from(Person.class);
Expression<Boolean> voterExpression = person.get(Person_.registeredVoter);
query.select(person).where(voterExpression);
TypedQuery<Person> typedQuery = entityManager.createQuery(query);
List<Person> p = typedQuery.getResultList(); // 返回所有registeredVoter = true的人

CriteriaBuilder.literal() 的使用

如本教程所述，CriteriaBuilder.literal()可以用来将字面值转换为表达式。这可能对于需要Expression参数的CriteriaBuilder方法非常有用。

Expression<T> literal(T value);
Expression<T> nullLiteral(Class<T> resultClass);

完整示例

以下是使用上述方法的完整示例，包括实体类定义和应用where限制条件的示例代码。

实体类定义

public class Person {
    private int id;
    private String name;
    private Byte age;
    private boolean registeredVoter;
    // 省略getter和setter方法
}

应用 where 限制条件

以下是应用where限制条件的示例代码：

public class ExampleMain {
    // 省略EntityManagerFactory创建和关闭代码
    private static void useBooleanExpression() {
        // 省略代码
    }
    // 其他方法省略
}

在接下来的教程中，我们将探索更多CriteriaBuilder和Expression返回Predicate的方法。

示例项目

使用的依赖和技术：

• h2 1.4.197: H2数据库引擎。
• hibernate-core 5.3.6.Final: Hibernate的核心ORM功能。
• hibernate-jpamodelgen 5.3.6.Final: 注解处理器，用于生成JPA 2静态元模型类。
• JDK 1.8
• Maven 3.5.4