Criteria API

Goal

• Criteria API
• CriteriaBuilder
• CriteriaQuery

---

Criteria API

Java Persistence Criteria API 는 JPQL 의 문자열 기반 접근 방식을 이용하는 대신 객체 기반 쿼리 정의 개체의 구성을 통해 동적 쿼리를 정의하는데 사용된다. Critera API 에는 type-restricted mode, non-typed mode 로 나뉘며, 런타임 시 동적으로 조회 빌드를 지원해 컴파일러가 검증할 수 있도록 한다. 또한 Criteria API 는 동적 쿼리에만 사용되어 메타데이터 또는 Named Query 에서는 사용할 수 없으며 동적 쿼리에서만 사용할 수 있어 기존의 정적 Named Query 에 비해 성능이 뛰어나지 않다. 그러한 이유로 JPA Provider 를 통해 구문 분석 캐시의 이점을 얻는 JPQL 보다 성능이 떨어진다.

(JPA 2.1 부터 CriteriaUpdate, CriteraiaDelete 를 지원한다.)

---

CriteraBuilder

CriteraBuilder 는 Critera API 의 기본 인터페이스로, EntityManager 또는 EntityManagerFactory 를 통해 getCriteriaBuilder() API 를 호출하여 Builer 구현체를 가져온다. 

• createQuery()
• createQuery(Class)
• createTupleQuery()
• createCriteriaDelete(Class)
• createCriteriaUpdate(Class)

---

CriteriaQuery

CriteriaQuery 는 데이터베이스의 Select Query 를 정의한다. 따라서 JPQL Select Query 의 모든 구문을 모델링한다.
CriteriaQuery 작성 시, 해당 쿼리에서 사용된 요소는 다른 CriteriaQuery 에서 사용할 수 없으며, EntityManager 의 createQuery() 함수를 통해 JPA 쿼리가 생성된다.

• distinct(Boolean)
• from(Class)
• from(EntityType)
• select(Selection)
• multiselect(Selection...)
• where(Expression)
• orderBy(Order...)
• groupBy(Expression...)
• having(Expression)
• subQuery(Class)

---

Example

@Component
class EBootCriteria(
    @PersistenceContext
    private val entityManager: EntityManager
) {

    fun getEBook(): List<EBook> {
        val criteriaBuilder = entityManager.criteriaBuilder
        val criteriaQuery = criteriaBuilder.createQuery(EBook::class.java)
        val root = criteriaQuery.from(EBook::class.java)
        val isEquals = criteriaBuilder.equal(root.get<String>("name"), "Clean Code")

        criteriaQuery.select(root)
            .distinct(true)
            .where(isEquals)

        val query: TypedQuery<EBook> = entityManager.createQuery(criteriaQuery)

        return query.resultList
    }
}