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 rapidement créer et exécuter un projet.
Pour créer une nouvelle application webforJ à partir d'un archétype, vous pouvez utiliser startforJ ou la ligne de commande.
Avant de commencer, passez en revue les prérequis nécessaires pour configurer et utiliser webforJ.
Utilisation de startforJ
La façon 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 inclut toutes les dépendances requises, les fichiers de configuration et une mise en page préfabriquée, afin que vous puissiez commencer à travailler dessus 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, ID de groupe, ID d’artefact)
- Version de webforJ et version de Java
- Couleur du 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
webforJ inclut 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.
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 mettre en place un nouveau projet hello-world, suivez ces étapes :
- Naviguez vers le répertoire approprié: Ouvrez un terminal et déplacez-vous dans le dossier où vous souhaitez créer votre nouveau projet.
- Exécuter la commande archetype:generate: Utilisez la commande Maven ci-dessous et personnalisez le groupId, l'artifactId et la 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 d'archétype spécifique. Utiliser LATEST sélectionne la version la plus récente disponible. |
groupId | Représente l'espace de nom du projet généré. Généralement structuré comme un package Java, par exemple 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'artifact 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électionnez un type de projet :
|
appName | Un paramètre optionnel pouvant être utilisé dans le fichier POM du projet généré. Selon l'archétype webforJ utilisé, il peut servir de titre par défaut pour l'application. |
Après l'exécution de la commande, Maven générera les fichiers de projet nécessaires pour exécuter le projet.
Running the app
Before running your app, install the prerequisites if you haven't yet. Then, navigate to the project's root directory and run the following command:
mvn
The shorthand mvn command works because the archetype's POM file includes a <defaultGoal> configuration that automatically runs the appropriate goal for your project type. If your project doesn't have <defaultGoal>, run the following:
# for a standard webforJ app
mvn jetty:run
# for a webforJ + Spring Boot app
mvn spring-boot:run
Once the server is running, open your browser and go to http://localhost:8080 to view the app.