Skip to Content

Changes for page Basisprojekt

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