Docker-Installation

In ChatGPT öffnen

Dieser Abschnitt der Dokumentation behandelt die Schritte, die erforderlich sind, um mit Docker zu entwickeln. Änderungen an Ihrem Code werden auf Ihrem Entwicklungsrechner vorgenommen, und die resultierende App wird in Docker ausgeführt.

1. Docker herunterladen

Der Installationsprozess für Docker unterscheidet sich geringfügig zwischen Windows-, Mac- und Linux-Benutzern. Siehe den Abschnitt unten, der Ihrem Betriebssystem entspricht.

Windows

Info

Es wird empfohlen, die neueste Version des Windows Subsystem for Linux herunterzuladen. Weitere Informationen finden Sie an diesem Link.

1. Docker Desktop herunterladen:

• Besuchen Sie die Download-Seite für Docker Desktop für Windows: Docker Desktop für Windows
• Klicken Sie auf die Schaltfläche "Get Docker Desktop for Windows", um den Installer herunterzuladen.

2. Docker Desktop installieren:

• Führen Sie den heruntergeladenen Installer aus.
• Folgen Sie dem Installationsassistenten und stellen Sie sicher, dass Hyper-V aktiviert ist (wenn Sie dazu aufgefordert werden), da Docker für Windows Hyper-V für die Virtualisierung verwendet.
• Nach Abschluss der Installation startet Docker Desktop automatisch.

3. Installation überprüfen:

• Öffnen Sie ein Terminal und führen Sie den Befehl docker --version aus, um zu überprüfen, ob Docker installiert und korrekt funktioniert.

Mac

1. Docker Desktop herunterladen:

• Besuchen Sie die Download-Seite für Docker Desktop für Mac: Docker Desktop für Mac

2. Docker Desktop installieren:

• Führen Sie den heruntergeladenen Installer aus.
• Nach Abschluss der Installation startet Docker Desktop automatisch.

3. Installation überprüfen:

• Öffnen Sie ein Terminal und führen Sie den Befehl docker --version aus, um zu überprüfen, ob Docker installiert und korrekt funktioniert.

2. Konfiguration

Sobald Docker Desktop heruntergeladen wurde, suchen Sie nach dem neuesten webforJ-Image, das derzeit unter dem Namen webforj/sandbox verfügbar ist.

Klicken Sie auf die Liste der Tags, um die verfügbaren Optionen zu sehen.

Wählen Sie für den aktuellsten Build "rc".

Ziehen Sie das Image, um Ihren Container zu starten.

Sobald der Download abgeschlossen ist, klicken Sie auf die Schaltfläche "Run", die die Konfigurationseinstellungen öffnet.

Öffnen Sie das Menü "Optionale Einstellungen".

Wählen Sie einen gewünschten Host-Port, auf dem Sie Ihre App innerhalb von Docker sehen können.

Klicken Sie auf "Run", um den Container zu starten.

Wichtig

Stellen Sie sicher, dass Sie sich die benutzerdefinierte Host-Portnummer notieren, die Sie angegeben haben, da diese später benötigt wird.

3. Ihre App ausführen

Nachdem der Container erstellt wurde, können webforJ-Anwendungen innerhalb des Containers anstelle lokal ausgeführt werden. Zuerst ist es notwendig, die POM-Datei Ihres Projekts korrekt zu konfigurieren. Nachdem dies erledigt ist, wird das Aufrufen einer bestimmten URL im Browser die App anzeigen.

Konfigurieren Ihrer POM-Datei

Um ein webforJ-Projekt im Docker-Container auszuführen, ist die Verwendung des webforJ Install Plugins erforderlich, das über Ihre POM-Datei konfiguriert werden kann:

Erstellen Sie einen neuen <plugin>-Eintrag im <plugins>-Abschnitt der POM. Der folgende Code zeigt einen Starteintrag, der verwendet und nach Bedarf angepasst werden kann:

important

Wenn Ihre POM-Datei keinen <plugins>-Abschnitt hat, erstellen Sie einen.

<plugin>
<groupId>com.webforj</groupId>
<artifactId>webforj-install-maven-plugin</artifactId>
<version>${webforj.version}</version>
<executions>
  <execution>
  <goals>
    <goal>install</goal>
  </goals>
  </execution>
</executions>
<configuration>
  <deployurl>http://localhost:8888/webforj-install</deployurl>
  <classname>samples.HelloWorldApp</classname>
  <publishname>hello-world</publishname>
  <debug>true</debug>
</configuration>
</plugin>

Sobald ein Eintrag ähnlich dem oben stehenden erstellt wurde, passen Sie die folgenden Informationen an:

• Ändern Sie den <deployurl>-Eintrag, um die Portnummer zu verwenden, die mit dem Host-Port übereinstimmt, den Sie für Ihren Container in den vorherigen Schritten konfiguriert haben.

• Stellen Sie sicher, dass der <classname>-Eintrag mit dem Namen der App übereinstimmt, die Sie ausführen möchten.

• Wenn Ihre <username>- und <password>-Anmeldeinformationen für Ihre Installation von BBj unterschiedlich sind, ändern Sie diese.

Verwendung des Starterprojekts

Um ein neues bbj-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-bbj-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT \
-DappName=MyApp

PowerShell

mvn -B archetype:generate `
-DarchetypeGroupId="com.webforj" `
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" `
-DarchetypeVersion="LATEST" `
-DgroupId="org.example" `
-DartifactId="my-app" `
-Dversion="1.0-SNAPSHOT" `
-DappName="MyApp"

Command Prompt

mvn -B archetype:generate ^
-DarchetypeGroupId="com.webforj" ^
-DarchetypeArtifactId="webforj-archetype-bbj-hello-world" ^
-DarchetypeVersion="LATEST" ^
-DgroupId="org.example" ^
-DartifactId="my-app" ^
-Dversion="1.0-SNAPSHOT" ^
-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.
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.

App starten

Nachdem dies erledigt ist, führen Sie mvn install in Ihrem Projektverzeichnis aus. Dies wird das webforJ Install Plugin ausführen und Ihnen ermöglichen, auf Ihre App zuzugreifen. Um die App anzuzeigen, möchten Sie die folgende URL aufrufen:

http://localhost:YourHostPort/webapp/YourPublishName

Ersetzen Sie YourHostPort durch den Host-Port, den Sie mit Docker konfiguriert haben, und YourPublishName wird durch den Text im <publishname>-Tag der POM ersetzt. Wenn alles richtig gemacht wurde, sollten Sie Ihre App angezeigt bekommen.