Как получить строку JPQL / SQL из запроса CriteriaQuery в JPA?

Это полно сложных вещей, которые должны (а иногда и могут) быть простыми. Получение представления JQPL / SQL String для JPA 2.0 CriteriaQuery является одним из них.

К настоящему времени вы все знаете API критериев JPA 2.0 : безопасный для типов способ написания запроса JQPL. Этот API является умным в том смысле, что вы не используете Strings для построения вашего запроса, но довольно многословен… и иногда вы теряетесь в десятках строк Java-кода, просто чтобы написать простой запрос. Вы заблудились в своем CriteriaQuery , вы не знаете, почему ваш запрос не работает, и вы хотели бы отладить его . Но как вы отлаживаете это? Ну, одним из способов было бы просто отобразить представление JPQL и / или SQL. Просто, не правда ли? Да, но JPA 2.0 javax.persistence.Query не имеет API для этого. Затем вам нужно полагаться на реализацию … то есть код будет другим, если вы используете EclipseLink , Hibernateили OpenJPA .

CriteriaQuery, который мы хотим отладить

Допустим, у вас есть простой объект Book, и вы хотите получить все книги, отсортированные по их идентификатору. Что-то вроде SELECT b FROM Book b ORDER BY b.id DESC . Как бы вы написали это с помощью CriteriaQuery? Что-то вроде этих 5 строк кода Java:

CriteriaBuilder cb = em.getCriteriaBuilder();
CriteriaQuery<Book> q = cb.createQuery(Book.class);
Root<Book> b = q.from(Book.class);
q.select(b).orderBy(cb.desc(b.get("id")));
TypedQuery<Book> findAllBooks = em.createQuery(q);

Так что представьте, когда у вас есть более сложные. Иногда вы просто заблудились, он глючит, и вы хотели бы иметь представление JPQL и / или SQL String, чтобы узнать, что происходит. Затем вы можете даже протестировать его.

Получение строковых представлений JPQL / SQL для запроса критериев

Итак, давайте использовать API для получения представлений CriteriaQuery в формате JPQL / SQL String (точнее, TypedQuery, созданный из CriteriaQuery ). Плохая новость заключается в том, что для этого не существует стандартного API JPA 2.0. Вам нужно использовать API реализации, надеясь, что реализация позволяет это (слава богу, что это (почти) имеет место для 3 основных платформ ORM JPA). Хорошая новость заключается в том , что запрос интерфейс (и , следовательно , TypedQuery ) имеет UnWrap метод. Этот метод возвращает реализацию API запроса провайдера. Давайте посмотрим, как вы можете использовать его с EclipseLink , Hibernate и OpenJPA .

EclipseLink

EclipseLink представление запроса «s является org.eclipse.persistence.jpa.JpaQuery интерфейс и org.eclipse.persistence.internal.jpa.EJBQueryImpl реализации. Этот интерфейс предоставляет вам встроенный собственный запрос ( org.eclipse.persistence.queries.DatabaseQuery ) с двумя очень удобными методами: getJPQLString () и getSQLString (). К сожалению, метод getJPQLString () не будет переводить CriteriaQuery в JPQL, он работает только для запросов, изначально написанных на JPQL (динамический или именованный запрос). Метод getSQLString () полагается на то, что запрос «подготовлен», что означает, что вы должны выполнить запрос один раз, прежде чем получите представление SQL String.

findAllBooks.unwrap(JpaQuery.class).getDatabaseQuery().getJPQLString(); // doesn't work for CriteriaQuery
findAllBooks.unwrap(JpaQuery.class).getDatabaseQuery().getSQLString();

Hibernate

Представлением запроса Hibernate является org.hibernate.Query . Этот интерфейс имеет несколько реализаций и очень полезный метод, который возвращает строку SQL-запроса: getQueryString (). Я не смог найти метод, который возвращает представление JPQL, если я что-то пропустил, пожалуйста, дайте мне знать.

findAllBooks.unwrap(org.hibernate.Query.class).getQueryString()

findAllBooks.unwrap(org.apache.openjpa.persistence.QueryImpl.class).getQueryString()

assertEquals("SELECT b FROM Book b ORDER BY b.id DESC", 
findAllBooksCriteriaQuery.unwrap(org.apache.openjpa.persistence.QueryImpl.class).getQueryString());