Un template d'Application en Ligne de Commande (CLI) avec Java 25 et les JEP 458, 511 et 512

Le template basic-java-25-quickstart permet de démarrer une nouvelle application en commande ligne avec Java sans utiliser aucun système de build (autre que make).

Ce template nécessite d'utiliser Java 25 ou une version supérieure car il utilise les JEPs suivantes :

• La JEP 458: Launch Multi-File Source-Code Programs qui permet de lancer un programme Java dont le code est réparti dans plusieurs fichiers sources sans avoir besoin de les compiler préalablement
• La JEP 511: Module Import Declarations qui permet d'importer tous les packages exportés par un module java
• La JEP 512: Compact Source Files and Instance Main Methods qui permet de :
  • Se passer de déclaration de classe
  • Simplifier la déclaration de la méthode main
  • Utiliser les méthodes println et readln de la classe java.lang.IO

Le template utilise la librairie record-args, développée par Nicolai Parlog, et qui s'appuie sur les record et les interfaces sealed pour définir les arguments de la ligne de commande et en effectuer le parsing.

• Créer une application depuis ce template
• Construire votre application
  • Changer le nom de l'application
  • Lancer l'application localement
  • Afficher l'aide de l'application
  • Construire le livrable de l'application
• Installer l'application
  • Shell de lancement
  • Lancer l'application installée
• Exécuter les tests
• Autres templates

Créer une application depuis ce template

Pour créer une application depuis ce template, on procédera comme suit :

Vous trouverez sur GitHub l'application générée dans cet asciicast.

Construire votre application

Après avoir créé le dépôt GitHub de votre nouvelle application à partir de ce template, vous pouvez suivre les étapes suivantes pour construire votre application.

Changer le nom de l'application

Pour changer le nom de l'application, initialement nommée BasicQuickstart, il faut positionner la variable APP_NAME dans le terminal comme suit :

$ export APP_NAME=MyCmdLine

Lancer l'application localement

$ make run-app

./bin/Application.sh --language French
Bonjour 🇫🇷

Afficher l'aide de l'application

$ make run-app-help

./bin/Application.sh --help
Usage: Application [--language French | English] [--help]

Construire le livrable de l'application

Le livrable de l'application comprend les sources ainsi que ses dépendances.

$ make package

mkdir --parents build/MyCmdLine/src build/MyCmdLine/lib build/MyCmdLine/bin
cp --update --recursive src lib bin build/MyCmdLine
cd build/MyCmdLine \
	&& mv src/Application.java src/MyCmdLine.java \
	&& mv bin/Application.sh bin/MyCmdLine.sh
cd build \
	&& zip --quiet --recurse-paths MyCmdLine.zip MyCmdLine

Installer l'application

$ DEST_DIR=/home/user make install

unzip -q -d /home/user build/MyCmdLine.zip

Shell de lancement

Le script de lancement Application.sh, dont le rôle est de lancer le fichier Application.java, est renommé lors de la construction du livrable en MyCmdLine.sh.

Cela permet d'ajouter plusieurs applications dans le PATH et donc d'invoquer directement MyCmdLine.sh.

Lancer l'application installée

$ DEST_DIR=/home/user make run-installed-app

PATH=/home/user/MyCmdLine/bin:/usr/lib/jvm/jdk-25-ea/bin:/home/fopy/.local/bin:... MyCmdLine.sh
Bonjour 🇫🇷

Il ne nous reste plus qu'à :

• Implémenter notre métier dans Application.java
• Ajouter les fichiers qui déclarent les classes utilisées par Application.java dans le répertoire src
• Ajouter les jars de nos dépendances dans le répertoire lib
• Implémenter des tests

Exécuter les tests

💡 Avec la JEP 458, il est également possible d'implémenter des tests, que l'on lancera en ligne de commande comme c'est déjà le cas pour l'application.

La classe LanguageTest qui utilise la classe TestRunner et les assertions Java montre comment procéder :

$ make test

./src/LanguageTest.java
✅ Test fromStringTest is successful
❌ Test failingTest has failed
java.lang.AssertionError: Test was expected to fail !
	at LanguageTest.failingTest(LanguageTest.java:13)
	at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104)
	at java.base/java.lang.reflect.Method.invoke(Method.java:565)
	at TestRunner.runTest(TestRunner.java:21)
	at TestRunner.lambda$runTests$0(TestRunner.java:12)
	at java.base/java.util.Spliterators$ArraySpliterator.forEachRemaining(Spliterators.java:1024)
	at java.base/java.util.stream.ReferencePipeline$Head.forEach(ReferencePipeline.java:803)
	at TestRunner.runTests(TestRunner.java:12)
	at TestRunner.runTests(TestRunner.java:6)
	at LanguageTest.main(LanguageTest.java:4)
	at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104)
	at java.base/java.lang.reflect.Method.invoke(Method.java:565)
	at jdk.compiler/com.sun.tools.javac.launcher.SourceLauncher.execute(SourceLauncher.java:256)
	at jdk.compiler/com.sun.tools.javac.launcher.SourceLauncher.run(SourceLauncher.java:138)
	at jdk.compiler/com.sun.tools.javac.launcher.SourceLauncher.main(SourceLauncher.java:76)
✅ Test getGreetingTest is successful

Ces tests peuvent aussi être exécutés depuis l'environnement de développement en lançant la méthode main de la classe de test.

⚠️ Actuellement, il n'est pas possible de lancer uniquement un test : il faut lancer tous les tests en même temps.

Autres templates

Si vous ne disposez pas de Java 25, vous avez trois possibilités :

• Utiliser les templates basic-java-23-quickstart ou basic-java-22-quickstart qui ne nécessitent respectivement que la version 23 ou 22 de Java.
• Utiliser le template basic-java-11-quickstart qui ne requiert que la version 11 de Java. Il est alors nécessaire que tout le code Java réside dans le même fichier comme décrit dans la JEP 330.