CriteriaBuilder详解

一、CriteriaBuilder介绍

CriteriaBuilder是JPA（Java Persistence API）2.0的一部分，用于动态构建类型安全的查询语句。与静态查询语句相比，CriteriaBuilder的好处在于可以根据实际需要构建查询语句，而不是在编写代码时就定义好所有查询细节。

CriteriaBuilder可以帮助我们动态构建选择、过滤、排序等查询条件。它的作用是将查询条件表示为一个对象，而不是一个字符串，因此可以在编译时检查语法错误和类型错误，避免运行时的错误。

CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaQuery<T> cq = cb.createQuery(T.class);
Root<T> root = cq.from(T.class);

二、选择（SELECT）查询

在CriteriaBuilder中，选择（SELECT）查询使用Selection对象表示。Selection对象代表查询结果中的单个属性。可以使用以下方法构建Selection对象：

• CriteriaBuilder.tuple(Selection…)
• Root.get(String)
• Path.get(String)
• CriteriaBuilder.construct(Class, Selection…)

下面是一个例子，查询Person实体的firstName和lastName属性：

CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaQuery<Object[]> cq = cb.createQuery(Object[].class);
Root<Person> root = cq.from(Person.class);
Selection<Object>[] selections = new Selection[] {
    root.get(Person_.firstName),
    root.get(Person_.lastName)
};
cq.select(cb.array(selections));

三、过滤（WHERE）查询

在CriteriaBuilder中，过滤（WHERE）查询使用Predicate对象表示。Predicate对象代表WHERE子句中的单个条件。可以使用以下方法构建Predicate对象：

• Predicate alwaysTrue = cb.isTrue(cb.literal(true));
• Predicate alwaysFalse = cb.isFalse(cb.literal(false));
• Predicate isNull = cb.isNull(expression);
• Predicate isNotNull = cb.isNotNull(expression);
• Predicate like = cb.like(expression, pattern);
• Predicate notLike = cb.notLike(expression, pattern);
• Predicate equal = cb.equal(expression1, expression2);
• Predicate notEqual = cb.notEqual(expression1, expression2);
• Predicate greaterThan = cb.greaterThan(expression1, expression2);
• Predicate greaterThanOrEqualTo = cb.greaterThanOrEqualTo(expression1, expression2);
• Predicate lessThan = cb.lessThan(expression1, expression2);
• Predicate lessThanOrEqualTo = cb.lessThanOrEqualTo(expression1, expression2);
• Predicate and = cb.and(predicate1, predicate2);
• Predicate or = cb.or(predicate1, predicate2);
• Predicate not = cb.not(predicate);

下面是一个例子，过滤出age大于等于18岁并且firstName为“John”的Person实体：

CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaQuery<T> cq = cb.createQuery(T.class);
Root<Person> root = cq.from(Person.class);
Predicate agePredicate = cb.greaterThanOrEqualTo(root.get(Person_.age), 18);
Predicate firstNamePredicate = cb.equal(root.get(Person_.firstName), "John");
cq.where(cb.and(agePredicate, firstNamePredicate));

四、排序（ORDER BY）查询

在CriteriaBuilder中，排序（ORDER BY）查询使用Order对象表示。Order对象代表查询结果中的单个属性的排序方向。可以使用以下方法构建Order对象：

• Order asc = cb.asc(expression);
• Order desc = cb.desc(expression);

下面是一个例子，查询Person实体并根据lastName属性升序排序：

CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaQuery<T> cq = cb.createQuery(T.class);
Root<Person> root = cq.from(Person.class);
cq.orderBy(cb.asc(root.get(Person_.lastName)));

五、分组（GROUP BY）查询

在CriteriaBuilder中，分组（GROUP BY）查询使用Group对象表示。Group对象代表查询结果中的单个属性的分组条件。可以使用以下方法构建Group对象：

• Group group = cb.groupBy(expression);

下面是一个例子，查询Person实体并根据firstName属性进行分组：

CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaQuery<Object[]> cq = cb.createQuery(Object[].class);
Root<Person> root = cq.from(Person.class);
cq.multiselect(root.get(Person_.firstName), cb.count(root));
cq.groupBy(root.get(Person_.firstName));