Formations — 1 037 leçons en français

Accueil › Spring Boot › Filtrer et trier, sans casser l'URL de la liste

Filtrer et trier, sans casser l'URL de la liste

Exercice de la série « Un projet de bout en bout »intermediaire

Où l'on en est. L'API lit, crée, valide, remplace, modifie et supprime. Le catalogue compte maintenant six produits, et l'équipe du magasin demande deux choses qu'aucune URL ne sait exprimer : montre-moi la cuisine, et classe-les par prix. Votre route GET /produits est dans le code de départ, inchangée depuis l'exercice 2 ; c'est elle qu'on enrichit, sans changer son adresse.

Ni Spring, ni serveur, ni base de données ne tournent ici : votre code est compilé par javac seul, et c'est un routeur miniature fourni — visible sous « Code fourni, déjà en place » — qui relit par réflexion les annotations que vous avez posées, apparie le chemin, découpe la chaîne de requête après le ? et en remplit vos paramètres, et appelle votre méthode. Monter le projet, le pom.xml, le application.yml et le démarrage ne s'apprennent pas ici : ils restent dans les leçons, et c'est leur place.

L'annotation du jour, déclarée dans le code fourni avec le nom et les attributs exacts de Spring :

@RequestParam(value = "tri", defaultValue = "nom") String tri

value est le nom du paramètre dans l'URL ; defaultValue est ce que le routeur passe quand le paramètre est absent. Le nommer explicitement n'est pas une précaution de style : sans lui, Spring dépend de la présence du nom des paramètres dans le bytecode, et l'erreur, le jour où il manque, est déroutante.

Ce que le code fourni vous donne, en plus du prélude de l'exercice 5 : un service qui tient un journal. Il expose deux lectures, et note chaque appel qu'il reçoit :

List<Produit> tous()
List<Produit> parCategorie(String categorie)   // un findByCategorie derive
Optional<Produit> parId(long id)

Le banc affiche ce journal avec la réponse. Vous voyez donc quelle lecture vous avez demandée, et c'est le second objet de l'exercice.

Le catalogue : 1 clavier (bureau, 4500c, 12), 2 souris (bureau, 1900c, 30), 3 écran (bureau, 15900c, 4), 4 cafetière (cuisine, 1900c, 100), 5 mug (cuisine, 990c, 0), 6 tapis (bureau, 2500c, 7).

Ce qu'on vous demande. Donnez deux paramètres à votre route GET /produits :

Et faites-la répondre ainsi :

  1. tri inconnu — autre chose que nom, prix ou stock → 400, et le corps associe tri au message valeur inconnue : <ce qui a été reçu>. Ce refus arrive avant toute lecture : le journal doit rester vide.
  2. categorie vide → tout le catalogue, et le journal montre service.tous(). categorie renseignée → un seul appel service.parCategorie(<valeur>), et pas de filtrage en Java après un tous().
  3. Le tri est croissant dans les trois cas : nom par ordre alphabétique, prix sur prixCentimes, stock sur stock. À égalité, l'identifiant croissant tranche — la souris et la cafetière sont toutes deux à 1900 centimes, et c'est voulu.
  4. Le corps d'une réponse réussie reste ce qu'il était : 200 et la liste des résumés, dans l'ordre demandé.

Les cas limites, annoncés. Catégorie inconnue (jardin) → 200 et une liste vide : la question était légitime, la réponse est « aucun ». Paramètre inconnu dans l'URL (couleur=bleu) → ignoré, et la réponse est celle de la liste par défaut ; c'est le comportement de Spring, qui ne lit que les paramètres que vos méthodes déclarent. Et GET /produits/3 continue de répondre comme avant : ajouter des paramètres à une liste ne touche à aucune autre route.

Pourquoi des paramètres de requête et non des chemins. /produits/cuisine ferait de la catégorie une ressource, en concurrence avec /produits/{id} — et /produits/3 deviendrait ambigu. Un paramètre de requête dit ce qu'il est : un critère appliqué à la collection /produits. La règle tient en une phrase : le chemin identifie, la chaîne de requête filtre.

Le piège. Le code de départ accepte bien les deux paramètres, mais il filtre lui-même après avoir tout chargé — le journal le montre — et il ne trie jamais, donc l'ordre rendu est celui du dépôt. Pire : un tri inconnu ne provoque rien du tout, et le client reçoit un 200 et une liste qu'il croit triée comme il l'a demandé. Une option silencieusement ignorée est un mensonge de l'API.

Cas de test

Écrire le code et le faire exécuter →

Votre code est réellement compilé par javac et exécuté sur une JVM — aucun JDK à installer —, et la correction compare son résultat à celui d'une solution de référence.

La leçon qui prépare cet exercice

Les autres exercices de « Un projet de bout en bout »