Skip to Content

Changes for page Basisprojekt

Last modified by Carl Welsch on 2026/10/23 16:19
From version 73.2
edited by Carl Welsch
on 2026/10/23 11:44
Change comment: Auto-saved during real-time collaboration
To version 63.1
edited by Marco Grawunder
on 2026/08/25 15:36
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cwelsch
1 +XWiki.mgrawunder
Content
... ... @@ -1,11 +1,7 @@
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 -**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.
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.
9 9  {{/info}}
10 10  
11 11  {{toc/}}
... ... @@ -35,13 +35,10 @@
35 35  
36 36  == Access Token ==
37 37  
38 -{{expandable summary="Schritt-für-Schritt: Access Token einrichten"}}
39 -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 finden Sie in der Spalte links den Bereich **Access tokens**.
34 +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**.
40 40  
41 -[[image:1792748594897-686.png||height="305" width="258"]] <~-~- Edit Profile
36 +[[image:1757398899497-714.png||height="246" width="278"]]
42 42  
43 -[[image:1792748661578-664.png]]
44 -
45 45  Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen.
46 46  
47 47  Als Namen kann z. B. `IntelliJ` verwendet werden. Access Tokens sind aus Sicherheitsgründen zeitlich begrenzt. Wählen Sie ein Ablaufdatum, das zum Projektzeitraum passt.
... ... @@ -56,17 +56,11 @@
56 56  
57 57  {{warning}}
58 58  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.**
59 -{{/warning}}
52 +{{/warning}}
60 60  
61 -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.
62 -{{/expandable}}
54 +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.
63 63  
64 -== SSH ==
65 65  
66 -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:
67 -
68 -[[image:1792324965203-193.png]]
69 -
70 70  == Nach dem Klonen ==
71 71  
72 72  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
... ... @@ -97,29 +97,6 @@
97 97  
98 98  [[image:1756886220468-891.png]]
99 99  
100 -== Probleme mit Maven oder IntelliJ ==
101 -
102 -Falls IntelliJ nach dem Klonen des Repositories nicht alle Abhängigkeiten oder Klassen erkennt, überprüfen Sie bitte folgende Punkte:
103 -
104 -1. **Java-Version:** Das Basisprojekt benötigt mindestens Java 21. Kontrollieren Sie mit java -version und mvn -version, welche Versionen verwendet werden.
105 -1. **IntelliJ-Projekt:** Öffnen Sie das gesamte Projekt mit der übergeordneten pom.xml, nicht nur das Server- oder Client-Verzeichnis.
106 -1. **Maven-Konfiguration:** Überprüfen Sie unter //Settings → Build Tools → Maven//, ob Maven mit einem passenden JDK ausgeführt wird.
107 -1. **Maven aktualisieren:** Öffnen Sie das Maven-Toolfenster und wählen Sie //Reload All Maven Projects//.
108 -1. (((
109 -**Projekt bauen:** Öffnen Sie ein Terminal im Hauptverzeichnis des Projekts und führen Sie folgenden Befehl aus:
110 -
111 -mvn -U clean install -DskipTests
112 -)))
113 -1. **Generierte Klassen:** Stellen Sie sicher, dass die durch OpenAPI generierten Java-Klassen unter target/generated-sources vorhanden sind und von IntelliJ erkannt werden.
114 -1. **Lombok:** Prüfen Sie, ob das Lombok-Plugin aktiviert ist und Annotation Processing korrekt funktioniert.
115 -1. **Server starten:** Starten Sie die Klasse ServerApp im Server-Modul. Überprüfen Sie bei Problemen die Java-Version und die Startkonfiguration.
116 -
117 -**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.
118 -
119 -Man kann auch versuchen, die Caches von IntelliJ einmal zu löschen: File → Invalidate Caches → Invalidate and Restart
120 -
121 -Falls es immer noch Problem gibt: Es gibt eine erweiterte Checkliste: [[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
122 -
123 123  == Server starten ==
124 124  
125 125  Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.
... ... @@ -137,7 +137,6 @@
137 137  
138 138  == Logging umstellen ==
139 139  
140 -{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
141 141  Wenn man möchte, kann man das Logging umstellen.
142 142  
143 143  [[image:1755246135109-325.png]]
... ... @@ -147,11 +147,9 @@
147 147  
148 148  
149 149  [[image:1755246162330-595.png]]
150 -{{/expandable}}
151 151  
152 152  == Development-Profil aktivieren ==
153 153  
154 -{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
155 155  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.
156 156  
157 157  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
... ... @@ -168,7 +168,6 @@
168 168  [[image:1755248752596-839.png]]
169 169  
170 170  Danach muss man den Server neu starten!
171 -{{/expandable}}
172 172  
173 173  == Client starten ==
174 174  
... ... @@ -189,7 +189,6 @@
189 189  
190 190  === Mehrere Instanzen des Clients ermöglichen ===
191 191  
192 -{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
193 193  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.
194 194  
195 195  [[image:1755246233218-893.png]]
... ... @@ -198,8 +198,8 @@
198 198  Falls die Anmeldung eines vorbereiteten Testnutzers fehlschlägt, prüfen Sie insbesondere, ob das `dev`-Profil aktiv ist und der Benutzer angelegt wurde. Läuft der Server nicht, erscheint in der Regel eine andere Fehlermeldung.
199 199  
200 200  [[image:1755246292057-581.png]]
201 -{{/expandable}}
202 202  
161 +
203 203  = Überblick über das Basisprojekt =
204 204  
205 205  [[image:1755249096987-249.png]]
... ... @@ -225,10 +225,6 @@
225 225  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.
226 226  {{/info}}
227 227  
228 -{{info}}
229 -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
230 -{{/info}}
231 -
232 232  [[image:1755250026156-269.png]]
233 233  
234 234  [[image:1755250050031-304.png]]
... ... @@ -278,7 +278,6 @@
278 278  
279 279  = Erweiterung der REST-Schnittstelle =
280 280  
281 -{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
282 282  In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
283 283  
284 284  In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
... ... @@ -398,8 +398,8 @@
398 398  [[image:1756890010118-149.png||height="116" width="972"]]
399 399  
400 400  Anmerkung: Obwohl DefaultApi alle Funktionen zum Server kapselt, sollte man im Client spezifische Services für bestimmte Bereich haben, die diese Klasse verwenden.  Das führt zu einer besseren Trennung von Funktionalitäten im Code.
401 -{{/expandable}}
402 402  
356 +
403 403  = Asynchrone Kommunikation zum Client: WebSockets =
404 404  
405 405  [[image:1756890800817-370.png||height="604" width="1121"]]
... ... @@ -446,6 +446,7 @@
446 446  * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
447 447  * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
448 448  
403 +
449 449  [[image:1756891125969-748.png||height="317" width="726"]]
450 450  
451 451  Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
... ... @@ -477,7 +477,6 @@
477 477  
478 478  == Wie verbindet sich ein Client mit dem Server? ==
479 479  
480 -{{expandable summary="Technische Details zum Verbindungsaufbau"}}
481 481  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.
482 482  
483 483  [[image:1756891512330-186.png||height="170" width="820"]]
... ... @@ -504,13 +504,3 @@
504 504  3) Über den Kontext ein Event pushen LoggedInEvent
505 505  
506 506  4) Jede Serververbindung hat eine Session
507 -{{/expandable}}
508 -
509 -= Siehe auch =
510 -
511 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
512 -* [[Glossar>>doc:Main.Glossar.WebHome]]
513 -* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]
514 -* (((
515 -[[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
516 -)))
1792324965203-193.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.mgrawunder
Size
... ... @@ -1,1 +1,0 @@
1 -29.6 KB
Content
1792748594897-686.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -44.4 KB
Content
1792748661578-664.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -92.0 KB
Content