Getting Started
Cet article décrit les étapes pour créer une nouvelle application webforJ en utilisant les archétypes webforJ. Les archétypes fournissent des structures de projet préconfigurées et du code de démarrage afin que vous puissiez démarrer un projet rapidement.
Pour créer une nouvelle application webforJ à partir d'un archétype, vous pouvez utiliser startforJ ou la ligne de commande.
Avant de commencer, consultez les prérequis nécessaires pour configurer et utiliser webforJ.
Utilisation de startforJ
La manière la plus simple de créer une nouvelle application webforJ est startforJ, qui génère un projet de démarrage minimal basé sur un archétype webforJ choisi. Ce projet de démarrage comprend toutes les dépendances nécessaires, les fichiers de configuration et une mise en page préconçue, afin que vous puissiez commencer à construire immédiatement.
Personnalisation avec startforJ
Lorsque vous créez une application avec startforJ, vous pouvez la personnaliser en fournissant les informations suivantes :
- Métadonnées de base du projet (Nom de l'application, Identifiant de groupe, Identifiant de l'artifact)
- Version de webforJ et version de Java
- Couleur de thème et icône
- Archétype
- Saveur
Il y a deux options de saveur parmi lesquelles choisir, "webforJ Only" étant la valeur par défaut :
- webforJ Only : Application webforJ standard
- webforJ + Spring Boot : Application webforJ avec support Spring Boot
L'option de saveur Spring Boot n'est disponible qu'à partir de la version 25.02 de webforJ et au-delà. Si vous choisissez cette option, assurez-vous de sélectionner une version compatible.
webforJ est livré avec plusieurs archétypes prédéfinis pour vous aider à démarrer rapidement. Pour une liste complète des archétypes disponibles, consultez le catalogue des archétypes.
En utilisant ces informations, startforJ créera un projet de base à partir de l'archétype choisi avec vos personnalisations choisies.
Vous pouvez choisir de télécharger votre projet en tant que fichier ZIP ou de le publier directement sur GitHub.
Une fois que vous avez téléchargé votre projet, ouvrez le dossier du projet dans votre IDE et passez à l'exécution de l'application.
Utilisation de la ligne de commande
Si vous préférez utiliser la ligne de commande, vous pouvez générer un projet directement en utilisant l'archétype Maven :
Pour créer et structurer un nouveau projet hello-world, suivez ces étapes :
- Naviguer vers le bon répertoire: Ouvrez un terminal et déplacez-vous vers le dossier où vous voulez créer votre nouveau projet.
- Exécuter la commande archetype:generate: Utilisez la commande Maven ci-dessous et personnalisez groupId, artifactId et version selon les besoins de votre projet.
- Bash/Zsh
- PowerShell
- Command Prompt
mvn -B archetype:generate \
-DarchetypeGroupId=com.webforj \
-DarchetypeArtifactId=webforj-archetype-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT \
-Dflavor=webforj \
-DappName=MyApp
mvn -B archetype:generate `
-DarchetypeGroupId="com.webforj" `
-DarchetypeArtifactId="webforj-archetype-hello-world" `
-DarchetypeVersion="LATEST" `
-DgroupId="org.example" `
-DartifactId="my-app" `
-Dversion="1.0-SNAPSHOT" `
-Dflavor="webforj" `
-DappName="MyApp"
mvn -B archetype:generate ^
-DarchetypeGroupId="com.webforj" ^
-DarchetypeArtifactId="webforj-archetype-hello-world" ^
-DarchetypeVersion="LATEST" ^
-DgroupId="org.example" ^
-DartifactId="my-app" ^
-Dversion="1.0-SNAPSHOT" ^
-Dflavor="webforj" ^
-DappName="MyApp"
| Argument | Explication |
|---|---|
archetypeGroupId | L'ID de groupe de l'archétype est com.webforj pour les archétypes webforJ. |
archetypeArtifactId | Spécifie le nom de l'archétype à utiliser. |
archetypeVersion | Spécifie la version de l'archétype à utiliser. Cela garantit que le projet généré est compatible avec une version spécifique de l'archétype. Utiliser LATEST sélectionne la version la plus récente disponible. |
groupId | Représente l'espace de noms pour le projet généré. Typiquement structuré comme un package Java, tel que org.example, et est utilisé pour identifier de manière unique votre organisation ou domaine de projet. |
artifactId | Spécifie le nom du projet généré. Ce sera le nom de l'artefact résultant et du dossier du projet. |
version | Définit la version du projet généré. Une convention courante est MAJOR.MINOR-SNAPSHOT, comme 1.0-SNAPSHOT, où SNAPSHOT indique que le projet est encore en développement. |
flavor | Sélectionne une variante de projet :
|
appName | Un paramètre optionnel qui peut être utilisé dans le fichier POM du projet généré. Selon l'archétype webforJ utilisé, il peut être utilisé comme titre par défaut pour l'application. |
Après avoir exécuté la commande, Maven générera les fichiers de projet nécessaires pour exécuter le projet.
Exécution de l'application
Avant d'exécuter votre application, installez les prérequis si ce n'est pas déjà fait.
Ensuite, accédez au répertoire racine du projet et exécutez la commande suivante :
# pour une application webforJ standard
mvn jetty:run
# pour webforJ + Spring Boot
mvn spring-boot:run
Une fois le serveur en cours d'exécution, ouvrez votre navigateur et allez sur http://localhost:8080 pour voir l'application.
Pour des informations sur le filigrane présent dans les projets non licenciés, consultez Licences et Filigrane.