Spring Data JPA @Query

1. Vue d'ensemble

Spring Data fournit de nombreuses façons de définir une requête que nous pouvons exécuter. L'une d'elles est l' annotation @Query .

Dans ce didacticiel, nous montrerons comment utiliser l' annotation @Query dans Spring Data JPA pour exécuter des requêtes JPQL et SQL natives.

Nous montrerons également comment créer une requête dynamique lorsque l' annotation @Query ne suffit pas.

2. Sélectionnez Requête

Afin de définir SQL à exécuter pour une méthode de référentiel Spring Data, nous pouvons annoter la méthode avec l' annotation @Query - son attribut value contient le JPQL ou SQL à exécuter.

L' annotation @Query est prioritaire sur les requêtes nommées, qui sont annotées avec @NamedQuery ou définies dans un fichier orm.xml .

C'est une bonne approche de placer une définition de requête juste au-dessus de la méthode dans le référentiel plutôt que dans notre modèle de domaine en tant que requêtes nommées. Le référentiel est responsable de la persistance, c'est donc un meilleur endroit pour stocker ces définitions.

2.1. JPQL

Par défaut, la définition de requête utilise JPQL.

Examinons une méthode de référentiel simple qui renvoie les entités utilisateur actives de la base de données:

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

2.2. Originaire de

Nous pouvons également utiliser du SQL natif pour définir notre requête. Tout ce que nous avons à faire est de définir la valeur de l' attribut nativeQuery sur true et de définir la requête SQL native dans l' attribut value de l'annotation:

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

3. Définir l'ordre dans une requête

Nous pouvons passer un paramètre supplémentaire de type Sort à une déclaration de méthode Spring Data qui a l' annotation @Query . Il sera traduit dans la clause ORDER BY qui sera transmise à la base de données.

3.1. Tri pour les méthodes fournies et dérivées par JPA

Pour les méthodes que nous sortons de la boîte telles que findAll (Sort) ou celles qui sont générées par l'analyse des signatures de méthode, nous ne pouvons utiliser que les propriétés d'objet pour définir notre tri :

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

Imaginez maintenant que nous souhaitons trier par la longueur d'une propriété de nom:

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

Lorsque nous exécutons le code ci-dessus, nous recevrons une exception:

org.springframework.data.mapping.PropertyReferenceException: Aucune propriété lENGTH (nom) trouvée pour le type User!

3.2. JPQL

Lorsque nous utilisons JPQL pour une définition de requête, Spring Data peut gérer le tri sans aucun problème - tout ce que nous avons à faire est d'ajouter un paramètre de méthode de type Sort :

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

Nous pouvons appeler cette méthode et passer un paramètre Sort , qui ordonnera le résultat par la propriété name de l' objet User :

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

Et comme nous avons utilisé l' annotation @Query , nous pouvons utiliser la même méthode pour obtenir la liste triée des utilisateurs par la longueur de leurs noms:

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

Il est crucial que nous utilisions JpaSort.unsafe () pour créer une instance d'objet Sort .

Lorsque nous utilisons:

new Sort("LENGTH(name)"); 

alors nous recevrons exactement la même exception que celle que nous avons vue ci-dessus pour la méthode findAll () .

Lorsque Spring Data découvre l' ordre de tri non sécurisé pour une méthode qui utilise l' annotation @Query , il ajoute simplement la clause de tri à la requête - il ignore si la propriété à trier appartient au modèle de domaine.

3.3. Originaire de

Lorsque l' annotation @Query utilise SQL natif, il n'est pas possible de définir un tri .

Si nous le faisons, nous recevrons une exception:

org.springframework.data.jpa.repository.query.InvalidJpaQueryMethodException: impossible d'utiliser des requêtes natives avec un tri et / ou une pagination dynamiques

Comme le dit l'exception, le tri n'est pas pris en charge pour les requêtes natives. Le message d'erreur nous indique que la pagination provoquera également une exception.

Cependant, il existe une solution de contournement qui permet la pagination, et nous la traiterons dans la section suivante.

4. Pagination

La pagination nous permet de ne renvoyer qu'un sous-ensemble d'un résultat complet dans une page . Ceci est utile, par exemple, lors de la navigation dans plusieurs pages de données sur une page Web.

Un autre avantage de la pagination est que la quantité de données envoyées du serveur au client est minimisée. En envoyant de plus petits morceaux de données, nous pouvons généralement constater une amélioration des performances.

4.1. JPQL

L'utilisation de la pagination dans la définition de requête JPQL est simple:

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

Nous pouvons passer un paramètre PageRequest pour obtenir une page de données.

La pagination est également prise en charge pour les requêtes natives mais nécessite un peu de travail supplémentaire.

4.2. Originaire de

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

Dans cet article, nous avons couvert plusieurs façons de définir des requêtes dans les méthodes de référentiel Spring Data JPA à l'aide de l' annotation @Query .

Nous avons également appris à implémenter un référentiel personnalisé et à créer une requête dynamique.

Comme toujours, les exemples de code complets utilisés dans cet article sont disponibles à l'adresse over sur GitHub.