Skip to Content

Changes for page Basisprojekt

Last modified by Carl Welsch on 2026/10/23 16:19
From version 73.3
edited by Carl Welsch
on 2026/10/23 11:46
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,15 +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"]]
36 +[[image:1757398899497-714.png||height="246" width="278"]]
42 42  
43 -Unter dem Bereich **Access** finden Sie den Unterbereich **Personal access tokes**.
44 -
45 -[[image:1792748661578-664.png||height="594" width="259"]]
46 -
47 47  Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen.
48 48  
49 49  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.
... ... @@ -58,17 +58,11 @@
58 58  
59 59  {{warning}}
60 60  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.**
61 -{{/warning}}
52 +{{/warning}}
62 62  
63 -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.
64 -{{/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.
65 65  
66 -== SSH ==
67 67  
68 -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:
69 -
70 -[[image:1792324965203-193.png]]
71 -
72 72  == Nach dem Klonen ==
73 73  
74 74  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
... ... @@ -99,29 +99,6 @@
99 99  
100 100  [[image:1756886220468-891.png]]
101 101  
102 -== Probleme mit Maven oder IntelliJ ==
103 -
104 -Falls IntelliJ nach dem Klonen des Repositories nicht alle Abhängigkeiten oder Klassen erkennt, überprüfen Sie bitte folgende Punkte:
105 -
106 -1. **Java-Version:** Das Basisprojekt benötigt mindestens Java 21. Kontrollieren Sie mit java -version und mvn -version, welche Versionen verwendet werden.
107 -1. **IntelliJ-Projekt:** Öffnen Sie das gesamte Projekt mit der übergeordneten pom.xml, nicht nur das Server- oder Client-Verzeichnis.
108 -1. **Maven-Konfiguration:** Überprüfen Sie unter //Settings → Build Tools → Maven//, ob Maven mit einem passenden JDK ausgeführt wird.
109 -1. **Maven aktualisieren:** Öffnen Sie das Maven-Toolfenster und wählen Sie //Reload All Maven Projects//.
110 -1. (((
111 -**Projekt bauen:** Öffnen Sie ein Terminal im Hauptverzeichnis des Projekts und führen Sie folgenden Befehl aus:
112 -
113 -mvn -U clean install -DskipTests
114 -)))
115 -1. **Generierte Klassen:** Stellen Sie sicher, dass die durch OpenAPI generierten Java-Klassen unter target/generated-sources vorhanden sind und von IntelliJ erkannt werden.
116 -1. **Lombok:** Prüfen Sie, ob das Lombok-Plugin aktiviert ist und Annotation Processing korrekt funktioniert.
117 -1. **Server starten:** Starten Sie die Klasse ServerApp im Server-Modul. Überprüfen Sie bei Problemen die Java-Version und die Startkonfiguration.
118 -
119 -**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.
120 -
121 -Man kann auch versuchen, die Caches von IntelliJ einmal zu löschen: File → Invalidate Caches → Invalidate and Restart
122 -
123 -Falls es immer noch Problem gibt: Es gibt eine erweiterte Checkliste: [[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
124 -
125 125  == Server starten ==
126 126  
127 127  Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.
... ... @@ -139,7 +139,6 @@
139 139  
140 140  == Logging umstellen ==
141 141  
142 -{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
143 143  Wenn man möchte, kann man das Logging umstellen.
144 144  
145 145  [[image:1755246135109-325.png]]
... ... @@ -149,11 +149,9 @@
149 149  
150 150  
151 151  [[image:1755246162330-595.png]]
152 -{{/expandable}}
153 153  
154 154  == Development-Profil aktivieren ==
155 155  
156 -{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
157 157  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.
158 158  
159 159  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
... ... @@ -170,7 +170,6 @@
170 170  [[image:1755248752596-839.png]]
171 171  
172 172  Danach muss man den Server neu starten!
173 -{{/expandable}}
174 174  
175 175  == Client starten ==
176 176  
... ... @@ -191,7 +191,6 @@
191 191  
192 192  === Mehrere Instanzen des Clients ermöglichen ===
193 193  
194 -{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
195 195  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.
196 196  
197 197  [[image:1755246233218-893.png]]
... ... @@ -200,8 +200,8 @@
200 200  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.
201 201  
202 202  [[image:1755246292057-581.png]]
203 -{{/expandable}}
204 204  
161 +
205 205  = Überblick über das Basisprojekt =
206 206  
207 207  [[image:1755249096987-249.png]]
... ... @@ -227,10 +227,6 @@
227 227  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.
228 228  {{/info}}
229 229  
230 -{{info}}
231 -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
232 -{{/info}}
233 -
234 234  [[image:1755250026156-269.png]]
235 235  
236 236  [[image:1755250050031-304.png]]
... ... @@ -280,7 +280,6 @@
280 280  
281 281  = Erweiterung der REST-Schnittstelle =
282 282  
283 -{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
284 284  In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
285 285  
286 286  In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
... ... @@ -400,8 +400,8 @@
400 400  [[image:1756890010118-149.png||height="116" width="972"]]
401 401  
402 402  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.
403 -{{/expandable}}
404 404  
356 +
405 405  = Asynchrone Kommunikation zum Client: WebSockets =
406 406  
407 407  [[image:1756890800817-370.png||height="604" width="1121"]]
... ... @@ -448,6 +448,7 @@
448 448  * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
449 449  * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
450 450  
403 +
451 451  [[image:1756891125969-748.png||height="317" width="726"]]
452 452  
453 453  Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
... ... @@ -479,7 +479,6 @@
479 479  
480 480  == Wie verbindet sich ein Client mit dem Server? ==
481 481  
482 -{{expandable summary="Technische Details zum Verbindungsaufbau"}}
483 483  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.
484 484  
485 485  [[image:1756891512330-186.png||height="170" width="820"]]
... ... @@ -506,13 +506,3 @@
506 506  3) Über den Kontext ein Event pushen LoggedInEvent
507 507  
508 508  4) Jede Serververbindung hat eine Session
509 -{{/expandable}}
510 -
511 -= Siehe auch =
512 -
513 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
514 -* [[Glossar>>doc:Main.Glossar.WebHome]]
515 -* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]
516 -* (((
517 -[[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
518 -)))
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