Изучаем Java EE 7

Именованные запросы — это статические запросы, выражаемые метаданными внутри либо аннотации @NamedQuery, либо XML-эквивалента. Для определения этих запросов, пригодных для повторного использования, снабдите сущность аннотацией @NamedQuery, которая принимает два элемента: имя запроса и его содержимое. Итак, внесем изменения для сущности Customer и статически определим три запроса с использованием аннотаций (листинг 6.22).

Листинг 6.22. Определение именованных запросов для сущности Customer

@Entity

@NamedQueries({

··@NamedQuery(name = "findAll", query="select c from Customer c"),

··@NamedQuery(name = "findVincent", 

··············query="select c from Customer c where c.firstName = 'Винсент'"),

··@NamedQuery(name = "findWithParam", 

··············query="select c from Customer c where c.firstName =:fname")

})

public class Customer {

··@Id @GeneratedValue

··private Long id;

··private String firstName;

··private String lastName;

··private Integer age;

··private String email;

··@OneToOne

··@JoinColumn(name = "address_fk")

··private Address address;

··// Конструкторы, геттеры, сеттеры

}

Поскольку для сущности Customer определяется более одного именованного запроса, здесь применяется аннотация @NamedQueries, которая принимает массив @NamedQuery. Первый запрос findAll обеспечивает выборку всех клиентов из базы данных без каких-либо ограничений (оператор WHERE отсутствует). Запрос findWithParam задействует параметр: fname для ограничения выборки клиентов согласно значению firstName. В листинге 6.22 показан массив @NamedQuery, однако если бы в случае с Customer имел место один запрос, то он выглядел бы следующим образом:

@Entity

@NamedQuery(name = "findAll", query="select c from Customer c")

public class Customer {…}

Способ выполнения таких именованных запросов схож с тем, что применяется для выполнения динамических запросов. Вызывается метод EntityManager.createNamedQuery(), которому передается имя запроса, определяемое аннотациями. Этот метод возвращает Query или TypedQuery, который может быть использован для задания параметров, максимального количества результатов, режимов выборки и т. д. Чтобы выполнить запрос findAll, напишите следующий код:

Query query = em.createNamedQuery("findAll");

Опять-таки если у вас возникнет необходимость ввести запрос для возврата списка объектов Customer, то придется воспользоваться TypedQuery, как показано далее:

TypedQuery query = em.createNamedQuery("findAll", Customer.class);

Следующий фрагмент кода вызывает именованный запрос findWithParam с передачей параметра: fname и присваиванием setMaxResults значения 3:

Query query = em.createNamedQuery("findWithParam");

query.setParameter("fname", "Винсент");

query.setMaxResults(3);

List customers = query.getResultList();

Поскольку большинство методов Query API возвращает объект Query, вы можете использовать элегантное сокращение при написании запросов. Вызывайте методы один за другим (setParameter(). setMaxResults() и т. д.):

Query query = em.createNamedQuery("findWithParam"). setParameter("fname", 

··················································"Винсент")

··················································.setMaxResults(3);

Именованные запросы пригодны для организации определений запросов и являются эффективным средством повышения производительности приложений. Это происходит благодаря тому, что именованные запросы для сущностей определяются статически и обычно располагаются в классе-сущности, который соответствует непосредственно результату запроса (здесь запрос findAll возвращает всех клиентов, поэтому он должен быть определен в сущности Customer).