Formations — 1 037 leçons en français

Accueil › Spring Boot › Les requêtes dérivées du nom des méthodes

Les requêtes dérivées du nom des méthodes

Accéder aux données avec Spring Data JPAdebutant

Spring Data peut générer une requête à partir du nom d'une méthode de repository, sans écrire de SQL ni de JPQL.

public interface ProduitRepository extends JpaRepository<Produit, Long> {

    List<Produit> findByCategorie(String categorie);
    List<Produit> findByPrixLessThan(double prixMax);
    List<Produit> findByNomContainingIgnoreCase(String motCle);
    Optional<Produit> findByReference(String reference);
    boolean existsByReference(String reference);
    long countByCategorie(String categorie);
    List<Produit> findByCategorieOrderByPrixAsc(String categorie);
}

Le principe : findBy (ou existsBy, countBy, deleteBy) suivi du nom d'un attribut de l'entité, éventuellement combiné avec des mots-clés (And, Or, Between, LessThan, Containing, OrderBy…). Spring Data traduit ce nom en requête au démarrage — et échoue au démarrage, pas plus tard, si un attribut cité n'existe pas.

Le type de retour compte : une List<T> pour plusieurs résultats, un Optional<T> pour au plus un résultat, un boolean pour existsBy..., un long pour countBy....

Ces requêtes sont pratiques pour des cas simples. Au-delà de deux ou trois conditions, le nom devient illisible : mieux vaut alors écrire une requête @Query (leçon suivante).

Les termes à connaître

Requête dérivée

Une méthode de repository dont Spring Data génère la requête SQL/JPQL à partir de son nom, sans écrire de code. Exemple : findByNom(String nom).

Mots-clés de comparaison

Between, LessThan, GreaterThan, LessThanEqual, GreaterThanEqual : comparent un attribut numérique ou une date à une ou plusieurs valeurs passées en paramètre.

Like, Containing, StartingWith

Recherches partielles sur une chaîne : Like (motif SQL explicite avec %), Containing (contient), StartingWith / EndingWith (commence/finit par). IgnoreCase les rend insensibles à la casse.

And, Or

Combinent plusieurs conditions dans le nom de la méthode : findByNomAndCategorie(...), findByNomOrReference(...).

OrderBy

Ajoute un tri dans le nom de la méthode : findByCategorieOrderByPrixAsc(...). Asc (défaut) ou Desc.

Top / First

Limitent le nombre de résultats : findTop3ByCategorieOrderByPrixDesc(...), findFirstByOrderByDateCreationDesc().

existsBy, countBy, deleteBy

Préfixes alternatifs à findBy : existsByReference(...) renvoie un boolean, countByCategorie(...) renvoie un long, deleteByStatut(...) supprime et renvoie le nombre de lignes supprimées.

In, IsNull

In teste l'appartenance à une collection (findByCategorieIn(List<String> categories)), IsNull / IsNotNull teste la nullité d'un attribut, sans paramètre.

Lire l'explication détaillée et faire le quiz →

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.