Getting Started

In ChatGPT öffnen

Dieser Artikel beschreibt die Schritte zur Erstellung einer neuen webforJ-App mithilfe von webforJ Archetypen. Archetypen bieten vorkonfigurierte Projektstrukturen und Startercode, sodass Sie ein Projekt schnell einrichten und ausführen können. Um eine neue webforJ-App aus einem Archetyp zu erstellen, können Sie startforJ oder die Befehlszeile verwenden.

Voraussetzungen

Bevor Sie beginnen, überprüfen Sie die erforderlichen Voraussetzungen für die Einrichtung und Verwendung von webforJ.

Verwendung von startforJ

Die einfachste Möglichkeit, eine neue webforJ-App zu erstellen, ist startforJ, das ein minimales Starterprojekt basierend auf einem gewählten webforJ-Archetyp generiert. Dieses Starterprojekt enthält alle erforderlichen Abhängigkeiten, Konfigurationsdateien und ein vorgefertigtes Layout, sodass Sie sofort darauf aufbauen können.

Anpassung mit startforJ

Wenn Sie eine App mit startforJ erstellen, können Sie diese anpassen, indem Sie die folgenden Informationen bereitstellen:

• Grundlegende Projektmetadaten (App-Name, Gruppen-ID, Artefakt-ID)
• webforJ-Version und Java-Version
• Themenfarbe und Symbol
• Archetyp
• Geschmack

Es gibt zwei Geschmacksoptionen zur Auswahl, wobei "webforJ Only" die Standardoption ist:

• webforJ Only: Standard-webforJ-App
• webforJ + Spring Boot: webforJ-App mit Spring Boot-Unterstützung

Unterstützung für Spring Boot

Die Spring Boot-Option ist nur in webforJ-Version 25.02 und höher verfügbar. Wenn Sie diese Option auswählen, stellen Sie sicher, dass Sie eine kompatible Version wählen.

Verfügbare Archetypen

webforJ wird mit mehreren vordefinierten Archetypen geliefert, um Ihnen einen schnellen Start zu ermöglichen. Für eine vollständige Liste der verfügbaren Archetypen siehe den Archetypen-Katalog.

Mit diesen Informationen erstellt startforJ ein grundlegendes Projekt aus Ihrem gewählten Archetyp mit Ihren gewählten Anpassungen. Sie können wählen, ob Sie Ihr Projekt als ZIP-Datei herunterladen oder direkt auf GitHub veröffentlichen möchten.

Sobald Sie Ihr Projekt heruntergeladen haben, öffnen Sie den Projektordner in Ihrer IDE und fahren Sie mit dem Ausführen der App fort.

Verwendung der Befehlszeile

Wenn Sie die Befehlszeile bevorzugen, können Sie ein Projekt direkt mithilfe des Maven-Archetyps generieren:

Um ein neues hello-world-Projekt zu erstellen und zu scaffolden, folgen Sie diesen Schritten:

1. Navigieren Sie zum richtigen Verzeichnis: Öffnen Sie ein Terminal und wechseln Sie in den Ordner, in dem Sie Ihr neues Projekt erstellen möchten.
2. Führe den Befehl archetype:generate aus: Verwenden Sie den folgenden Maven-Befehl und passen Sie groupId, artifactId und version nach Bedarf für Ihr Projekt an.

Bash/Zsh

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

PowerShell

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"

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"

Argumentation	Erklärung
archetypeGroupId	Die Gruppen-ID des Archetyps ist com.webforj für webforJ-Archetypen.
archetypeArtifactId	Gibt den Namen des zu verwendenden Archetyps an.
archetypeVersion	Legt die zu verwendende Version des Archetyps fest. Dies stellt sicher, dass das generierte Projekt mit einer bestimmten Archetyp-Version kompatibel ist. Die Auswahl von LATEST wählt die aktuellste verfügbare Version aus.
groupId	Namespace für das generierte Projekt. Typisch strukturiert wie ein Java-Paket, z.B. org.example und wird verwendet, um Ihre Organisation oder Projektdomain eindeutig zu identifizieren.
artifactId	Gibt den Namen des generierten Projekts an. Dies wird der Name des resultierenden Artefakts und des Projektordners sein.
version	Legt die Version des generierten Projekts fest. Eine gängige Konvention ist MAJOR.MINOR-SNAPSHOT, wie 1.0-SNAPSHOT, wobei SNAPSHOT bedeutet, dass sich das Projekt noch in der Entwicklung befindet.
flavor	Wählen Sie einen Projektgeschmack aus: webforj - Standard webforJ-App. webforj-spring - webforJ-App mit Unterstützung für Spring Boot (erfordert webforJ 25.02 oder höher).
appName	Ein optionaler Parameter, der in der POM-Datei des generierten Projekts verwendet werden kann. Abhängig vom verwendeten webforJ-Archetyp kann er als Standardtitel für die Anwendung genutzt werden.

Nach Ausführung des Befehls wird Maven die benötigten Projektdateien generieren, um das Projekt auszuführen.

Ausführen der App

Bevor Sie Ihre App ausführen, installieren Sie die Voraussetzungen, falls Sie dies noch nicht getan haben. Navigieren Sie dann zum Stammverzeichnis des Projekts und führen Sie den folgenden Befehl aus:

# für die Standard-webforJ-App
mvn jetty:run

# für webforJ + Spring Boot
mvn spring-boot:run

Sobald der Server läuft, öffnen Sie Ihren Browser und gehen Sie zu http://localhost:8080, um die App anzuzeigen.