Accueil › Spring Boot › Requêtes personnalisées avec @Query
Requêtes personnalisées avec @Query
Accéder aux données avec Spring Data JPAdebutant
Quand une requête dérivée du nom de méthode devient trop complexe ou impossible à exprimer, @Query permet d'écrire soi-même la requête, en JPQL par défaut :
public interface ProduitRepository extends JpaRepository<Produit, Long> {
@Query("SELECT p FROM Produit p WHERE p.categorie = :categorie AND p.prix <= :prixMax")
List<Produit> rechercher(@Param("categorie") String categorie, @Param("prixMax") double prixMax);
@Modifying
@Query("UPDATE Produit p SET p.disponible = false WHERE p.quantiteStock = 0")
int marquerIndisponibles();
}
Points clés :
- JPQL interroge les entités et leurs attributs Java (
Produit,p.prix), pas les tables et colonnes SQL.nativeQuery = truepermet d'écrire du vrai SQL quand JPQL ne suffit pas. - Paramètres nommés (
:categorie, avec@Param("categorie")) ou positionnels (?1,?2, dans l'ordre des arguments). @Modifyingest obligatoire pour unUPDATE/DELETE, et la méthode doit s'exécuter dans une transaction.- Une méthode
@Querypeut aussi recevoir unPageablepour renvoyer une page de résultats.
Les termes à connaître
- @Query
Annotation posée sur une méthode de repository pour écrire soi-même la requête, en JPQL par défaut, ou en SQL natif avec
nativeQuery = true.- JPQL
Jakarta Persistence Query Language : un langage de requête proche du SQL, mais qui porte sur les entités et leurs attributs Java, pas sur les tables et colonnes de la base.
SELECT p FROM Produit p WHERE p.prix > :prixMininterroge l'entitéProduit, pas une tableproduit.- SQL natif (nativeQuery = true)
Requête SQL classique, écrite contre les vraies tables et colonnes de la base. Utile pour des fonctionnalités spécifiques à un SGBD ou des requêtes que JPQL ne sait pas exprimer, au prix d'une portabilité réduite.
- @Param
Associe un paramètre de méthode à un paramètre nommé de la requête (
:nom). Alternative : les paramètres positionnels?1,?2, dans l'ordre des arguments de la méthode.- @Modifying
Annotation obligatoire sur une méthode
@Queryqui exécute unUPDATEou unDELETE(au lieu d'unSELECT). La méthode doit être appelée dans une transaction active.- Projection DTO
Le fait de faire renvoyer à une requête un objet différent de l'entité (souvent un DTO léger), avec la syntaxe JPQL
SELECT new com.boutique.ProduitResume(p.nom, p.prix) FROM Produit p.- Pageable
Paramètre spécial de Spring Data qui porte le numéro de page, la taille de page et le tri demandés. Une méthode
@Querypeut le recevoir en dernier paramètre pour renvoyer unePage<T>.
Cette page présente la partie essentielle de la leçon. Les exemples commentés, les pièges courants et les trois questions de quiz sont dans l'application.