Getting Started

ChatGPT öffnen

Dieser Artikel beschreibt die Schritte zur Erstellung einer neuen webforJ-App mit 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 Nutzung von webforJ.

Verwendung von startforJ

Der einfachste Weg, 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 damit beginnen können, darauf aufzubauen.

Anpassung mit startforJ

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

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

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

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

Unterstützung für Spring Boot

Die Spring Boot-Geschmacksrichtung 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 kommt mit mehreren vordefinierten Archetypen, um Ihnen einen schnellen Einstieg zu ermöglichen. Für eine vollständige Liste der verfügbaren Archetypen siehe den Archetypen-Katalog.

Mit diesen Informationen wird startforJ ein grundlegendes Projekt aus Ihrem gewählten Archetyp mit Ihren bevorzugten Anpassungen erstellen. Sie können wählen, ob Sie Ihr Projekt als ZIP-Datei herunterladen oder es 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 mit dem Maven-Archetyp generieren:

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

1. Zum richtigen Verzeichnis navigieren: Öffnen Sie ein Terminal und navigieren Sie zum Ordner für Ihr neues Projekt.
2. Den archetype:generate Befehl ausführen: Maven-Befehl verwenden und groupId, artifactId und Version anpassen.

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"

Argument	Erklärung
archetypeGroupId	Die Gruppen-ID des Archetyps ist com.webforJ.
archetypeArtifactId	Gibt den Namen des zu verwendenden Archetypes an.
archetypeVersion	Gibt die Version des zu verwendenden Archetypes an. Dies stellt sicher, dass das generierte Projekt mit einer bestimmten Archetype-Version kompatibel ist. LATEST wählt die neueste verfügbare Version.
groupId	Repräsentiert den Namespace für das generierte Projekt. Typischerweise wie ein Java-Paket strukturiert, z.B. org.example, und wird verwendet, um Ihre Organisation oder Projektdomäne eindeutig zu identifizieren.
artifactId	Gibt den Namen des generierten Projekts an. Dies wird der Name des resultierenden Artefakts und des Projektordners sein.
version	Versionsnummer festlegen. Gängige Konvention: MAJOR.MINOR-SNAPSHOT, z. B. 1.0-SNAPSHOT.
flavor	Wählt eine Projektvariante: webforj - Standard webforJ-App. webforj-spring - webforJ-App mit Spring Boot-Unterstützung (erfordert webforJ 25.02 oder höher).
appName	Optionaler Parameter in der POM für Standardtitel.

Maven generiert nach Ausführung des Befehls die notwendigen Projektdateien.

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 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.

Lizenzierung und Wasserzeichen

Für Informationen über das Wasserzeichen, das in unlizenzierten Projekten vorhanden ist, siehe Lizenzierung und Wasserzeichen.