Spring Data JPA @Query

1. Общ преглед

Spring Data предоставя много начини за дефиниране на заявка, която можем да изпълним. Един от тях е анотацията @Query .

В този урок ще демонстрираме как да използваме анотацията @Query в Spring Data JPA за изпълнение на JPQL и на собствени SQL заявки.

Ще покажем и как да изградим динамична заявка, когато анотацията @Query не е достатъчна.

2. Изберете Заявка

За да дефинираме SQL за изпълнение за метод на Spring Data repository, можем да анотираме метода с анотация @Query - неговият атрибут стойност съдържа JPQL или SQL за изпълнение.

В @Query анотацията има предимство пред име заявки, които са обозначени с @NamedQuery или определени в orm.xml файл.

Добър подход е да поставите дефиниция на заявка точно над метода вътре в хранилището, а не вътре в нашия модел на домейн като именувани заявки. Хранилището е отговорно за постоянството, така че е по-добро място за съхранение на тези дефиниции.

2.1. JPQL

По подразбиране дефиницията на заявката използва JPQL.

Нека разгледаме прост метод на хранилище, който връща активни потребителски обекти от базата данни:

@Query("SELECT u FROM User u WHERE u.status = 1") Collection findAllActiveUsers(); 

2.2. Местен

Можем да използваме и собствен SQL, за да дефинираме нашата заявка. Всичко, което трябва да направим, е да зададем стойността на атрибута nativeQuery на true и да дефинираме собствената SQL заявка в атрибута value на анотацията:

@Query( value = "SELECT * FROM USERS u WHERE u.status = 1", nativeQuery = true) Collection findAllActiveUsersNative(); 

3. Определете реда в заявка

Можем да предадем допълнителен параметър от тип Sort към декларация за метод Spring Data, която има анотацията @Query . Той ще бъде преведен в клаузата ORDER BY , която се предава в базата данни.

3.1. Сортиране за предоставени JPA и извлечени методи

За методите, които изваждаме от полето, като например findAll (Сортиране) или тези, които се генерират чрез анализиране на подписи на метода, можем да използваме свойствата на обекта само за дефиниране на нашето сортиране :

userRepository.findAll(new Sort(Sort.Direction.ASC, "name")); 

Сега си представете, че искаме да сортираме по дължината на свойство на име:

userRepository.findAll(new Sort("LENGTH(name)")); 

Когато изпълним горния код, ще получим изключение:

org.springframework.data.mapping.PropertyReferenceException: Не е намерено свойство lENGTH (име) за тип Потребител!

3.2. JPQL

Когато използваме JPQL за дефиниция на заявка, тогава Spring Data може да се справи със сортирането без никакъв проблем - всичко, което трябва да направим, е да добавим параметър на метод от тип Sort :

@Query(value = "SELECT u FROM User u") List findAllUsers(Sort sort); 

Можем да извикаме този метод и да предадем параметър Sort , който ще подреди резултата по свойството name на обекта User :

userRepository.findAllUsers(new Sort("name"));

И тъй като използвахме анотацията @Query , можем да използваме същия метод, за да получим сортирания списък с потребители по дължината на техните имена:

userRepository.findAllUsers(JpaSort.unsafe("LENGTH(name)")); 

От решаващо значение е да използваме JpaSort.unsafe (), за да създадем екземпляр на обект Sort .

Когато използваме:

new Sort("LENGTH(name)"); 

тогава ще получим точно същото изключение, както видяхме по-горе за метода findAll () .

Когато Spring Data открие опасния ред за сортиране за метод, който използва анотацията @Query , той просто добавя клаузата за сортиране към заявката - пропуска проверката дали свойството, по което да се сортира, принадлежи на модела на домейна.

3.3. Местен

Когато анотацията @Query използва собствен SQL, тогава не е възможно да се дефинира Сортиране .

Ако го направим, ще получим изключение:

org.springframework.data.jpa.repository.query.InvalidJpaQueryMethodException: Не може да се използват собствени заявки с динамично сортиране и / или разбиване на страници

Както казва изключението, сортирането не се поддържа за естествени заявки. Съобщението за грешка ни дава намек, че разбирането на страницата също ще доведе до изключение.

Има обаче заобиколно решение, което дава възможност за разбиване на страници и ще го разгледаме в следващия раздел.

4. Пагинация

Пагинацията ни позволява да върнем само подмножество от цял ​​резултат в Страница . Това е полезно, например, когато навигирате през няколко страници с данни на уеб страница.

Друго предимство на разбиването на страници е, че количеството данни, изпратени от сървъра до клиента, е сведено до минимум. Изпращайки по-малки парчета данни, обикновено можем да видим подобрение в производителността.

4.1. JPQL

Използването на пагинация в дефиницията на заявка JPQL е лесно:

@Query(value = "SELECT u FROM User u ORDER BY id") Page findAllUsersWithPagination(Pageable pageable); 

Можем да предадем параметър PageRequest , за да получим страница с данни.

Пагинацията също се поддържа за собствени заявки, но изисква малко допълнителна работа.

4.2. Местен

We can enable pagination for native queries by declaring an additional attribute countQuery.

This defines the SQL to execute to count the number of rows in the whole result:

@Query( value = "SELECT * FROM Users ORDER BY id", countQuery = "SELECT count(*) FROM Users", nativeQuery = true) Page findAllUsersWithPagination(Pageable pageable);

4.3. Spring Data JPA Versions Prior to 2.0.4

The above solution for native queries works fine for Spring Data JPA versions 2.0.4 and later.

Prior to that version, when we try to execute such a query, we'll receive the same exception we described in the previous section on sorting.

We can overcome this by adding an additional parameter for pagination inside our query:

@Query( value = "SELECT * FROM Users ORDER BY id \n-- #pageable\n", countQuery = "SELECT count(*) FROM Users", nativeQuery = true) Page findAllUsersWithPagination(Pageable pageable);

In the above example, we add “\n– #pageable\n” as the placeholder for the pagination parameter. This tells Spring Data JPA how to parse the query and inject the pageable parameter. This solution works for the H2 database.

We've covered how to create simple select queries via JPQL and native SQL. Next, we'll show how to define additional parameters.

5. Indexed Query Parameters

There are two possible ways that we can pass method parameters to our query: indexed and named parameters.

In this section, we'll cover indexed parameters.

5.1. JPQL

For indexed parameters in JPQL, Spring Data will pass method parameters to the query in the same order they appear in the method declaration:

@Query("SELECT u FROM User u WHERE u.status = ?1") User findUserByStatus(Integer status); @Query("SELECT u FROM User u WHERE u.status = ?1 and u.name = ?2") User findUserByStatusAndName(Integer status, String name); 

For the above queries, the status method parameter will be assigned to the query parameter with index 1, and the name method parameter will be assigned to the query parameter with index 2.

5.2. Native

Indexed parameters for the native queries work exactly in the same way as for JPQL:

@Query( value = "SELECT * FROM Users u WHERE u.status = ?1", nativeQuery = true) User findUserByStatusNative(Integer status);

In the next section, we'll show a different approach: passing parameters via name.

6. Named Parameters

We can also pass method parameters to the query using named parameters. We define these using the @Param annotation inside our repository method declaration.

Each parameter annotated with @Param must have a value string matching the corresponding JPQL or SQL query parameter name. A query with named parameters is easier to read and is less error-prone in case the query needs to be refactored.

6.1. JPQL

As mentioned above, we use the @Param annotation in the method declaration to match parameters defined by name in JPQL with parameters from the method declaration:

@Query("SELECT u FROM User u WHERE u.status = :status and u.name = :name") User findUserByStatusAndNameNamedParams( @Param("status") Integer status, @Param("name") String name); 

Note that in the above example, we defined our SQL query and method parameters to have the same names, but it's not required as long as the value strings are the same:

@Query("SELECT u FROM User u WHERE u.status = :status and u.name = :name") User findUserByUserStatusAndUserName(@Param("status") Integer userStatus, @Param("name") String userName); 

6.2. Native

For the native query definition, there is no difference in how we pass a parameter via the name to the query in comparison to JPQL — we use the @Param annotation:

@Query(value = "SELECT * FROM Users u WHERE u.status = :status and u.name = :name", nativeQuery = true) User findUserByStatusAndNameNamedParamsNative( @Param("status") Integer status, @Param("name") String name);

7. Collection Parameter

Let's consider the case when the where clause of our JPQL or SQL query contains the IN (or NOT IN) keyword:

SELECT u FROM User u WHERE u.name IN :names

In this case, we can define a query method that takes Collection as a parameter:

@Query(value = "SELECT u FROM User u WHERE u.name IN :names") List findUserByNameList(@Param("names") Collection names);

As the parameter is a Collection, it can be used with List, HashSet, etc.

Next, we'll show how to modify data with the @Modifying annotation.

8. Update Queries With @Modifying

We can use the @Query annotation to modify the state of the database by also adding the @Modifying annotation to the repository method.

8.1. JPQL

The repository method that modifies the data has two differences in comparison to the select query — it has the @Modifying annotation and, of course, the JPQL query uses update instead of select:

@Modifying @Query("update User u set u.status = :status where u.name = :name") int updateUserSetStatusForName(@Param("status") Integer status, @Param("name") String name); 

The return value defines how many rows the execution of the query updated. Both indexed and named parameters can be used inside update queries.

8.2. Native

We can modify the state of the database also with a native query. We just need to add the @Modifying annotation:

@Modifying @Query(value = "update Users u set u.status = ? where u.name = ?", nativeQuery = true) int updateUserSetStatusForNameNative(Integer status, String name);

8.3. Inserts

To perform an insert operation, we have to both apply @Modifying and use a native query since INSERT is not a part of the JPA interface:

@Modifying @Query( value = "insert into Users (name, age, email, status) values (:name, :age, :email, :status)", nativeQuery = true) void insertUser(@Param("name") String name, @Param("age") Integer age, @Param("status") Integer status, @Param("email") String email);

9. Dynamic Query

Often, we'll encounter the need for building SQL statements based on conditions or data sets whose values are only known at runtime. And in those cases, we can't just use a static query.

9.1. Example of a Dynamic Query

For example, let's imagine a situation where we need to select all the users whose email is LIKE one from a set defined at runtime — email1, email2, …, emailn:

SELECT u FROM User u WHERE u.email LIKE '%email1%' or u.email LIKE '%email2%' ... or u.email LIKE '%emailn%'

Since the set is dynamically constructed, we can't know at compile-time how many LIKE clauses to add.

In this case, we can't just use the @Query annotation since we can't provide a static SQL statement.

Instead, by implementing a custom composite repository, we can extend the base JpaRepository functionality and provide our own logic for building a dynamic query. Let's take a look at how to do this.

9.2. Custom Repositories and the JPA Criteria API

Luckily for us, Spring provides a way for extending the base repository through the use of custom fragment interfaces. We can then link them together to create a composite repository.

We'll start by creating a custom fragment interface:

public interface UserRepositoryCustom { List findUserByEmails(Set emails); }

And then we'll implement it:

public class UserRepositoryCustomImpl implements UserRepositoryCustom { @PersistenceContext private EntityManager entityManager; @Override public List findUserByEmails(Set emails) { CriteriaBuilder cb = entityManager.getCriteriaBuilder(); CriteriaQuery query = cb.createQuery(User.class); Root user = query.from(User.class); Path emailPath = user.get("email"); List predicates = new ArrayList(); for (String email : emails) { predicates.add(cb.like(emailPath, email)); } query.select(user) .where(cb.or(predicates.toArray(new Predicate[predicates.size()]))); return entityManager.createQuery(query) .getResultList(); } }

As shown above, we leveraged the JPA Criteria API to build our dynamic query.

Also, we need to make sure to include the Impl postfix in the class name. Spring will search the UserRepositoryCustom implementation as UserRepositoryCustomImpl. Since fragments are not repositories by themselves, Spring relies on this mechanism to find the fragment implementation.

9.3. Extending the Existing Repository

Notice that all the query methods from section 2 through section 7 are in the UserRepository.

So, now we'll integrate our fragment by extending the new interface in the UserRepository:

public interface UserRepository extends JpaRepository, UserRepositoryCustom { // query methods from section 2 - section 7 }

9.4. Using the Repository

And finally, we can call our dynamic query method:

Set emails = new HashSet(); // filling the set with any number of items userRepository.findUserByEmails(emails); 

We've successfully created a composite repository and called our custom method.

10. Conclusion

В тази статия разгледахме няколко начина за дефиниране на заявки в методите на JPA хранилище Spring Data, използвайки анотацията @Query .

Също така научихме как да внедрим персонализирано хранилище и да създадем динамична заявка.

Както винаги, пълните примери за кодове, използвани в тази статия, са достъпни в GitHub.