Skip to Content

Changes for page Basisprojekt

Last modified by Carl Welsch on 2026/10/23 16:19
From version 64.1
edited by Marco Grawunder
on 2026/08/25 16:31
Change comment: There is no comment for this version
To version 69.1
edited by Marco Grawunder
on 2026/10/19 15:33
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,7 +1,11 @@
1 1  [[image:Main.Organisatorisches.WebHome@softwareprojekt_logo_transparent.png||alt="SoftwareprojektLogo.png" data-xwiki-image-style-alignment="end" height="136" width="309"]]
2 2  
3 3  {{info}}
4 -Diese Seite erklärt den Einstieg in das bereitgestellte Basisprojekt und die darin verwendete Client-Server-Kommunikation. Das Basisprojekt verwendet mindestens **Java 21**. Screenshots der IDE oder von GitLab können sich bei neueren Versionen optisch unterscheiden; die beschriebenen Arbeitsschritte bleiben davon in der Regel unberührt.
4 +**Worum geht es auf dieser Seite?**
5 +
6 +Diese Seite erklärt den **Einstieg in das bereitgestellte Basisprojekt** und die darin verwendete Client-Server-Kommunikation. Behandelt werden insbesondere Einrichtung und Build, Spring, REST/OpenAPI, DTOs sowie WebSockets/STOMP.
7 +
8 +Das Basisprojekt verwendet mindestens **Java 21**. Screenshots können sich bei neueren Versionen optisch unterscheiden.
5 5  {{/info}}
6 6  
7 7  {{toc/}}
... ... @@ -32,7 +32,6 @@
32 32  == Access Token ==
33 33  
34 34  {{expandable summary="Schritt-für-Schritt: Access Token einrichten"}}
35 -
36 36  Beim ersten Git-Zugriff über HTTPS werden Zugangsdaten benötigt. Statt des normalen Passworts sollte ein persönlicher **Access Token** verwendet werden. Öffnen Sie dazu Ihr Profilbild, wählen Sie **Edit profile** und anschließend **Access tokens**.
37 37  
38 38  [[image:1757398899497-714.png||height="246" width="278"]]
... ... @@ -51,11 +51,17 @@
51 51  
52 52  {{warning}}
53 53  Kopieren und speichern Sie das erzeugte Token unmittelbar. Es wird nach der Erstellung nicht erneut vollständig angezeigt. **Tokens dürfen niemals in das Repository eingecheckt werden.**
54 -{{/warning}}
57 +{{/warning}}
55 55  
56 56  Beim **Einloggen **(Achtung! Gemeint ist hier, wenn Intellij (bzw. git) nach den Account-Daten beim Clonen fragt. Man kann auch einen Gitlab-Account hinterlegen (der dann aber parallel existiert). Hier für ist es wichtig, dass noch "api" und "read_user" als Recht vergeben wird.) in IntelliJ können Sie dieses Token im Passwort-Feld verwenden. Geben Sie ihren Account bei Name ein.
57 57  {{/expandable}}
58 58  
62 +== SSH ==
63 +
64 +Hinweis: Man kann jetzt auch mit SSH clonen. Da gitlab aber hinter einem Reverseproxy liegt, geht das nur mit der direkten Adresse des Host:  vmisdata07.uni-oldenburg.de. Ist nun auch in Gitlab zu konfiguriert:
65 +
66 +[[image:1792324965203-193.png]]
67 +
59 59  == Nach dem Klonen ==
60 60  
61 61  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
... ... @@ -86,6 +86,27 @@
86 86  
87 87  [[image:1756886220468-891.png]]
88 88  
98 +== Probleme mit Maven oder IntelliJ ==
99 +
100 +Falls IntelliJ nach dem Klonen des Repositories nicht alle Abhängigkeiten oder Klassen erkennt, überprüfen Sie bitte folgende Punkte:
101 +
102 +1. **Java-Version:** Das Basisprojekt benötigt mindestens Java 21. Kontrollieren Sie mit java -version und mvn -version, welche Versionen verwendet werden.
103 +1. **IntelliJ-Projekt:** Öffnen Sie das gesamte Projekt mit der übergeordneten pom.xml, nicht nur das Server- oder Client-Verzeichnis.
104 +1. **Maven-Konfiguration:** Überprüfen Sie unter //Settings → Build Tools → Maven//, ob Maven mit einem passenden JDK ausgeführt wird.
105 +1. **Maven aktualisieren:** Öffnen Sie das Maven-Toolfenster und wählen Sie //Reload All Maven Projects//.
106 +1. (((
107 +**Projekt bauen:** Öffnen Sie ein Terminal im Hauptverzeichnis des Projekts und führen Sie folgenden Befehl aus:
108 +
109 +mvn -U clean install -DskipTests
110 +)))
111 +1. **Generierte Klassen:** Stellen Sie sicher, dass die durch OpenAPI generierten Java-Klassen unter target/generated-sources vorhanden sind und von IntelliJ erkannt werden.
112 +1. **Lombok:** Prüfen Sie, ob das Lombok-Plugin aktiviert ist und Annotation Processing korrekt funktioniert.
113 +1. **Server starten:** Starten Sie die Klasse ServerApp im Server-Modul. Überprüfen Sie bei Problemen die Java-Version und die Startkonfiguration.
114 +
115 +**Hinweis:** Wenn Maven im Terminal erfolgreich durchläuft, IntelliJ aber weiterhin Fehler anzeigt, liegt das Problem häufig an der IntelliJ-Projektkonfiguration und nicht an den Abhängigkeiten selbst.
116 +
117 +Sollte der Server anschließend weiterhin nicht starten, teilen Sie bitte die erste aussagekräftige Fehlermeldung aus dem Run-Fenster beziehungsweise den ersten relevanten Caused by-Eintrag mit.
118 +
89 89  == Server starten ==
90 90  
91 91  Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.
... ... @@ -104,7 +104,6 @@
104 104  == Logging umstellen ==
105 105  
106 106  {{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
107 -
108 108  Wenn man möchte, kann man das Logging umstellen.
109 109  
110 110  [[image:1755246135109-325.png]]
... ... @@ -119,7 +119,6 @@
119 119  == Development-Profil aktivieren ==
120 120  
121 121  {{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
122 -
123 123  Für lokale Tests existiert das Spring-Profil `dev`. Darin werden automatisch vorbereitete Testnutzer (`user1` bis `user9`) angelegt, sodass nicht für jeden Testlauf neue Konten registriert werden müssen.
124 124  
125 125  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
... ... @@ -158,7 +158,6 @@
158 158  === Mehrere Instanzen des Clients ermöglichen ===
159 159  
160 160  {{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
161 -
162 162  Standardmäßig erlaubt IntelliJ nicht das Starten mehrerer Clients. Man könnte nun mehrere Configurations für den Client anlegen. Man kann aber auch in der Konfiguration unter "Modify options" den Haken bei "Allow multiple instances" setzen. Dann kann eine beliebige Anzahl von Clients gestartet werden.
163 163  
164 164  [[image:1755246233218-893.png]]
... ... @@ -194,6 +194,10 @@
194 194  Die grafische OpenAPI-Darstellung hängt von der verwendeten IntelliJ-Edition und den installierten Plugins ab. Falls sie nicht verfügbar ist, kann ein geeignetes OpenAPI-Plugin installiert werden.
195 195  {{/info}}
196 196  
224 +{{info}}
225 +Es gibt (als Beta-Version) ein Plugin für IntelliJ mit dem die Berbeitung, gerade zu Anfang hoffentlich etwas einfacher funktioniert. Zu finden ist das Plugin hier: https://swl.informatik.uni-oldenburg.de/swp/downloads/openapi/ (Achtung! Muss von der Platte installiert werden. Siehe https://www.jetbrains.com/help/idea/managing-plugins.html#install_plugin_from_disk
226 +{{/info}}
227 +
197 197  [[image:1755250026156-269.png]]
198 198  
199 199  [[image:1755250050031-304.png]]
... ... @@ -244,7 +244,6 @@
244 244  = Erweiterung der REST-Schnittstelle =
245 245  
246 246  {{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
247 -
248 248  In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
249 249  
250 250  In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
... ... @@ -412,7 +412,6 @@
412 412  * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
413 413  * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
414 414  
415 -
416 416  [[image:1756891125969-748.png||height="317" width="726"]]
417 417  
418 418  Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
... ... @@ -445,7 +445,6 @@
445 445  == Wie verbindet sich ein Client mit dem Server? ==
446 446  
447 447  {{expandable summary="Technische Details zum Verbindungsaufbau"}}
448 -
449 449  Der `UserService` bietet die Anmeldung an. Im Basisprojekt erfolgt sie beim Aufbau der WebSocket-/STOMP-Verbindung; die Zugangsdaten werden dabei über die bestehende Sicherheitskonfiguration geprüft.
450 450  
451 451  [[image:1756891512330-186.png||height="170" width="820"]]
... ... @@ -474,4 +474,8 @@
474 474  4) Jede Serververbindung hat eine Session
475 475  {{/expandable}}
476 476  
505 += Siehe auch =
477 477  
507 +* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
508 +* [[Glossar>>doc:Main.Glossar.WebHome]]
509 +* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]
1792324965203-193.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.mgrawunder
Size
... ... @@ -1,0 +1,1 @@
1 +29.6 KB
Content