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));