Skip to Content

Changes for page Basisprojekt

Last modified by Carl Welsch on 2026/10/23 16:19
From version 76.2
edited by Carl Welsch
on 2026/10/23 12:26
Change comment: Auto-saved during real-time collaboration
To version 62.1
edited by Marco Grawunder
on 2025/10/16 11:59
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,13 +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 -{{info}}
4 -**Worum geht es auf dieser Seite?**
3 +Hier folgen Erklärungen des neuen Basisprojekts. Es wird um die folgenden Themen gehen:
5 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.
9 -{{/info}}
10 -
11 11  {{toc/}}
12 12  
13 13  
... ... @@ -15,11 +15,9 @@
15 15  
16 16  [[image:1755245956916-184.png]]
17 17  
18 -== Repository klonen ==
12 +== Clone ==
19 19  
20 -{{warning}}
21 -Im Screenshot wird teilweise das globale Basisprojekt gezeigt. **Verwenden Sie für die Arbeit das bereits für Ihre Gruppe angelegte Repository.**
22 -{{/warning}}
14 +Achtung! In dem Screenshot wird das globale Basisprojekt verwendet. Für jede Gruppe existiert bereits ein eigenes Repository, welches verwendet werden sollte,
23 23  
24 24  Sie finden die Clone-URL wie folgt:
25 25  
... ... @@ -35,46 +35,29 @@
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**.
30 +Beim ersten Mal clonen müssen Sie Ihre Gitlab-Zugangsdaten verwenden. Statt Name und Passwort ist es sinnvoll, einen Access-Token zu definieren. Das können Sie machen, in dem Sie auf ihre Profilbild klicken (auf der linken Seite) und dort "Edit Profile" auswählen. In dem nun folgenden Menü gibt es den Punkt Access tokens.
40 40  
41 -[[image:1792748594897-686.png||height="305" width="258"]]
32 +[[image:1757398899497-714.png||height="246" width="278"]]
42 42  
43 -Unter dem Bereich **Access** finden Sie den Unterbereich **Personal access token**.
34 +Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen.
44 44  
45 -[[image:1792748661578-664.png||height="594" width="259"]]
36 +Als Namen können Sie z.B. IntelliJ verwenden. Wichtig! Das Token ist aus Sicherheitsgründen nur eine bestimmte Zeit gültig. In diesem Gitlab kann dies maximal ein Jahr sein, standardmäßig ist ist hier aber ein Monat gewählt. Sie sollten also das Feld anpassen.
46 46  
47 -Dort können Sie mit **Generate token** ein neues Token anlegen. Wählen Sie hier **Generate fine-grained token **aus.
38 +[[image:1757399088336-273.png||height="92" width="547"]]
48 48  
49 -[[image:1792749012547-899.png||height="77" width="637"]]
40 +Bei den Scopes sollten die beiden Rechte "read_repository" und "write_repository" gewählt werden.
50 50  
51 -Als Namen für den Token kann z. B. `IntelliJ` verwendet werden. Access Tokens sind aus Sicherheitsgründen zeitlich begrenzt. Wählen Sie ein Ablaufdatum, das zum Projektzeitraum passt. Anschließend wählen Sie unter **Group and project access **den Punkt **Only specific groups or projects I have access to** und wählen Ihre SWP-Gruppe aus.
52 -
53 -[[image:1792750917132-904.png||height="572" width="642"]]
54 -
55 -Bei den Permiss sollten die beiden Rechte "read_repository" und "write_repository" gewählt werden.
56 -
57 -[[image:1792751165237-439.png||height="568" width="369"]]
58 -
59 59  Danach wird das Access Token generiert
60 60  
61 61  [[image:1757399184270-348.png||height="99" width="978"]]
62 62  
63 -{{warning}}
64 -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.**
65 -{{/warning}}
46 +Jetzt ist es wichtig, dass Sie sich das Token sichern!
66 66  
67 -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.
68 -{{/expandable}}
48 +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.
69 69  
70 -== SSH ==
71 71  
72 -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:
51 +== Nach dem Clonen ==
73 73  
74 -[[image:1792324965203-193.png]]
75 -
76 -== Nach dem Klonen ==
77 -
78 78  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
79 79  
80 80  [[image:1755245980026-164.png]]
... ... @@ -83,9 +83,10 @@
83 83  
84 84  [[image:1755245996886-733.png]]
85 85  
86 -== Initialer Maven-Build und Codegenerierung ==
61 +== Initialer Build (Generierung) ==
87 87  
88 -Nach einem frischen Checkout fehlen zunächst generierte Quellen. Führen Sie deshalb einen Maven-Build aus. Eine erneute Generierung ist insbesondere notwendig, wenn die OpenAPI-Beschreibung geändert wurde oder generierte Quellen fehlen.
63 +Dem neuen Code fehlen einige generierte Dateien. Diese werden wie folgt erzeugt. 
64 +Hinweis: Immer, wenn an dem OpenAPI-Dokument etwas geändert wird oder neue Abhängigkeiten für Maven definiert werden, muss diese Aktion durchgeführt werden.
89 89  
90 90  [[image:1755246008466-477.png]]
91 91  
... ... @@ -93,47 +93,24 @@
93 93  [[image:1755246018789-616.png]]
94 94  
95 95  
96 -== Lombok-Plugin ==
72 +== Lombok Plugin ==
97 97  
98 -Falls das Lombok-Plugin noch nicht installiert ist, installieren bzw. aktivieren Sie es in IntelliJ.
74 +**Lombok Plugin installiert? Wenn nein jetzt machen**
99 99  
100 100  [[image:1755248508652-523.png]]
101 101  
102 -Je nach IntelliJ-Edition kann zusätzlich das Spring-/Spring-Boot-Plugin hilfreich sein.
78 +**Hinweis: Wenn man schon hier ist, kann man auch das Spring-(Boot)-Plugin **installieren
103 103  
104 104  [[image:1756886220468-891.png]]
105 105  
106 -== Probleme mit Maven oder IntelliJ ==
82 +== Server laufen lassen ==
107 107  
108 -Falls IntelliJ nach dem Klonen des Repositories nicht alle Abhängigkeiten oder Klassen erkennt, überprüfen Sie bitte folgende Punkte:
109 -
110 -1. **Java-Version:** Das Basisprojekt benötigt mindestens Java 21. Kontrollieren Sie mit java -version und mvn -version, welche Versionen verwendet werden.
111 -1. **IntelliJ-Projekt:** Öffnen Sie das gesamte Projekt mit der übergeordneten pom.xml, nicht nur das Server- oder Client-Verzeichnis.
112 -1. **Maven-Konfiguration:** Überprüfen Sie unter //Settings → Build Tools → Maven//, ob Maven mit einem passenden JDK ausgeführt wird.
113 -1. **Maven aktualisieren:** Öffnen Sie das Maven-Toolfenster und wählen Sie //Reload All Maven Projects//.
114 -1. (((
115 -**Projekt bauen:** Öffnen Sie ein Terminal im Hauptverzeichnis des Projekts und führen Sie folgenden Befehl aus:
116 -
117 -mvn -U clean install -DskipTests
118 -)))
119 -1. **Generierte Klassen:** Stellen Sie sicher, dass die durch OpenAPI generierten Java-Klassen unter target/generated-sources vorhanden sind und von IntelliJ erkannt werden.
120 -1. **Lombok:** Prüfen Sie, ob das Lombok-Plugin aktiviert ist und Annotation Processing korrekt funktioniert.
121 -1. **Server starten:** Starten Sie die Klasse ServerApp im Server-Modul. Überprüfen Sie bei Problemen die Java-Version und die Startkonfiguration.
122 -
123 -**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.
124 -
125 -Man kann auch versuchen, die Caches von IntelliJ einmal zu löschen: File → Invalidate Caches → Invalidate and Restart
126 -
127 -Falls es immer noch Problem gibt: Es gibt eine erweiterte Checkliste: [[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
128 -
129 -== Server starten ==
130 -
131 131  Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.
132 132  
133 133  [[image:1755246035428-328.png]]
134 134  
135 135  
136 -Falls IntelliJ nach dem Start Annotation Processing für Lombok anbietet, aktivieren Sie es. Ohne korrekt eingerichtetes Lombok bzw. Annotation Processing werden Änderungen gegebenenfalls erst nach einem erneuten Maven-Build korrekt erkannt.
89 +... und ggf. Lombok aktivieren (Man wird nach dem Start der Anwendung gefragt). WICHTIG! Wenn das Lombok-Plugin nicht installiert und die folgende Funktion nicht aktiviert ist, muss jede Änderung mit Hilfe von Maven passieren.
137 137  
138 138  [[image:1755246072443-191.png]]
139 139  
... ... @@ -143,7 +143,6 @@
143 143  
144 144  == Logging umstellen ==
145 145  
146 -{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
147 147  Wenn man möchte, kann man das Logging umstellen.
148 148  
149 149  [[image:1755246135109-325.png]]
... ... @@ -153,12 +153,10 @@
153 153  
154 154  
155 155  [[image:1755246162330-595.png]]
156 -{{/expandable}}
157 157  
158 -== Development-Profil aktivieren ==
109 +== Development Profil aktivieren ==
159 159  
160 -{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
161 -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.
111 +Damit das Testen einfacher geht, gibt es ein spezielles Spring-Profil. In diesem werden automatisch user1-user9 mit jeweils dem identischen Passwort angelegt und man spart sich die Registierung.
162 162  
163 163  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
164 164  
... ... @@ -167,7 +167,7 @@
167 167  [[image:1755246173415-934.png]]
168 168  
169 169  
170 -Wenn die verwendete IntelliJ-Version keine Spring-Unterstützung bietet, kann das Profil über eine Umgebungsvariable in der Server-Konfiguration gesetzt werden:
120 +**Wenn man IntelliJ nicht in der Pro-Version verwendet bzw. das Spring Boot Plugin nicht installiert hat, muss kann man ein Spring-Profil über eine Umgebungsvariable in der Konfiguration des Servers setzen: **
171 171  
172 172  **SPRING_PROFILES_ACTIVE=dev**
173 173  
... ... @@ -174,15 +174,12 @@
174 174  [[image:1755248752596-839.png]]
175 175  
176 176  Danach muss man den Server neu starten!
177 -{{/expandable}}
178 178  
179 179  == Client starten ==
180 180  
181 181  Wenn der Server gestartet ist, kann man mehrere Clients starten. Dafür auf jeden Fall die Klasse Main verwenden.
182 182  
183 -{{warning}}
184 -Falls der Start fehlschlägt, prüfen Sie insbesondere die tatsächlich verwendete Java-Version. Für das Basisprojekt wird mindestens **Java 21** benötigt.
185 -{{/warning}}
132 +**Sollte es nun Problem geben, schauen Sie bitte, ob Sie noch eine alte Java-Version auf ihrem System installiert haben. Wir brauchen mindestens Java 21!**
186 186  
187 187  [[image:1755246257400-525.png]]
188 188  
... ... @@ -195,19 +195,18 @@
195 195  
196 196  === Mehrere Instanzen des Clients ermöglichen ===
197 197  
198 -{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
199 199  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.
200 200  
201 201  [[image:1755246233218-893.png]]
202 202  
203 203  
204 -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.
150 +Wenn folgendes kommt, ist entweder das "dev" Profil nicht aktiviert, der Nutzer wurde nicht angelegt. Wenn der Server nicht läuft, gibt es eine andere Fehlermeldung.
205 205  
206 206  [[image:1755246292057-581.png]]
207 -{{/expandable}}
208 208  
209 -= Überblick über das Basisprojekt =
210 210  
155 += Kurzer Blick ins Basisprojekt =
156 +
211 211  [[image:1755249096987-249.png]]
212 212  
213 213  
... ... @@ -214,27 +214,21 @@
214 214  [[image:1755249136156-419.png]]
215 215  
216 216  
217 -== Projektstruktur ==
163 +== Screenshots ==
218 218  
219 219  [[image:1755249228556-469.png]]
220 220  
221 221  
222 -= Kommunikation vom Client zum Server: REST =
168 += Kommunikation Client ~-~-> Server =
223 223  
224 224  [[image:1755249285866-367.png]]
225 225  
226 -Für klassische Request/Response-Operationen verwendet das Basisprojekt **REST über HTTP**. Als Austauschformat wird **JSON** verwendet. Die zentrale Spiellogik verbleibt auf dem Server.
172 +Der Server verwendet das REST-Protokoll und als Austauschformat JSON
227 227  
228 228  = OpenAPI =
229 229  
230 -{{info}}
231 -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.
232 -{{/info}}
176 +(Hinweis: Ich bin nicht sicher, ob IntelliJ diese Darstellung auch hat, wenn man nicht die Ultimate Version verwendet. Ggf. muss man das OpenAPI-Plugin installieren)
233 233  
234 -{{info}}
235 -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
236 -{{/info}}
237 -
238 238  [[image:1755250026156-269.png]]
239 239  
240 240  [[image:1755250050031-304.png]]
... ... @@ -241,12 +241,12 @@
241 241  
242 242  * **Paths**: Endpunkte der API (z.B. /users, /lobbies).
243 243  * **Operations**: Spezifikation von Methoden wie GET, POST.
244 -* **Schemas**: Beschreibung der Datenstrukturen für Ein- und Ausgaben.
184 +* **Definitions**: Detaillierte Beschreibung von Eingabe- und Ausgabestrukturen.
245 245  * **Security**: Authentifizierungsmechanismen.
246 246  
247 247  [[image:1755250061990-172.png]]
248 248  
249 -OpenAPI-Dokumente können in JSON oder YAML formuliert werden. **YAML** steht heute rekursiv für „YAML Ain't Markup Language“ und ist für menschenlesbare Konfigurations- und Beschreibungsdateien häufig kompakter als JSON.
189 +Kann JSON oder YAML (Yet Another Markup Language) verwenden YAML ist wie JSON nur mit weniger Klammern
250 250  
251 251  [[image:1755250157536-746.png]]
252 252  
... ... @@ -257,15 +257,15 @@
257 257  
258 258  = Maven und OpenAPI =
259 259  
260 -Die OpenAPI-Datei kann verwendet werden, um Teile der [[REST-Schnittstelle>>doc:Main.Basisprojekt.WebHome||anchor="HErweiterungderREST-Schnittstelle"]] zu generieren. Dafür wird der OpenAPI Generator eingesetzt [[https:~~/~~/github.com/OpenAPITools/openapi-generator>>https://github.com/OpenAPITools/openapi-generator]]
200 +Die OpenAPI Datei kann verwendet werden, um sich die [[REST-Schnittstellen>>doc:||anchor="HErweiterungderREST-Schnittstelle"]] generieren  zu lassen. Diese Erzeugung erfolgt mit dem OpenAPI Generator [[https:~~/~~/github.com/OpenAPITools/openapi-generator>>https://github.com/OpenAPITools/openapi-generator]]
261 261  
262 -Die Generierung kann über die Kommandozeile erfolgen; im Basisprojekt ist sie bereits in den Maven-Build integriert.
202 +Man kann dabei jetzt einen Kommandozeilenaufruf verwenden oder man setzt auf das im Basisprojekt vorhandene MVN ()
263 263  
264 264  Dafür ist in den Maven-Dateien bereits das OpenAPI Generator Plugin integriert. Da im Client und im Server unterschiedliche Arten verwendet werden, erfolgt die Konfiguration im Client und im Server unterschiedlich:
265 265  
266 266  == Client ==
267 267  
268 -Im Java-Client wird ein HTTP-Client für den Zugriff auf die generierte API verwendet.
208 +Im Client werden die Apache Http Bibliothek verwendet.
269 269  
270 270  
271 271  [[image:1756887005209-855.png]]
... ... @@ -272,24 +272,27 @@
272 272  
273 273  == Server ==
274 274  
275 -Auf der Serverseite werden Spring-/Spring-Boot-kompatible Schnittstellen und Controller-Strukturen generiert.
215 +Im Server wird Spring (Boot) verwendet
276 276  
277 277  [[image:1756887037619-847.png]]
278 278  
279 -{{info}}
280 -Weiterführende technische Konzepte des Basisprojekts sind insbesondere **Lombok**, **Dependency Injection** und **Spring Boot**. Für Spring bietet z. B. der folgende Leitfaden eine ausführlichere Einführung: [[Spring Framework Guide>>url:https://www.marcobehler.com/guides/spring-framework]].
281 -{{/info}}
219 +TODO: Weitere Informationen zu
282 282  
221 +- Lombok
283 283  
223 +- Dependency Injection
284 284  
225 +- Spring (Boot), siehe auch [[https:~~/~~/www.marcobehler.com/guides/spring-framework>>https://www.marcobehler.com/guides/spring-framework]]
226 +
227 +
228 +
285 285  = Erweiterung der REST-Schnittstelle =
286 286  
287 -{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
288 288  In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
289 289  
290 290  In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
291 291  
292 -== Schritt 1: OpenAPI-Dokument erweitern ==
235 +== Schritt 1: Erweitere das OpenAPI-Dokument ==
293 293  
294 294  Um diese neue Funktion sowohl im Client als auch im Server verwenden zu können, ist es notwendig, diese neue Funktion im OpenAPI-Dokument zu definieren.
295 295  
... ... @@ -323,9 +323,9 @@
323 323  
324 324  Hinweis: Niemals Änderungen unterhalb des target-Ordners machen. Das wird von Maven bei clean gelöscht.
325 325  
326 -=== Wo wird die eigentliche Funktionalität implementiert? ===
269 +=== Wie bekommt man dann aber nun die Funktionalität rein? ===
327 327  
328 -Für jeden API-Bereich (z. B. `lobbies` und `users`) werden serverseitig typischerweise mehrere Schnittstellen bzw. Klassen generiert:
271 +Für jeden Endpunkt (also aktuell lobbies und users) werden drei Interfaces/Klassen erzeugt:
329 329  
330 330  * *Api (z.B, LobbiesApi): Beschreibung der REST-Methoden, vor allem auch das Mapping von z.B. /lobbies/join auf die Methode lobbyJoin(String)
331 331  * (((
... ... @@ -332,7 +332,7 @@
332 332  *ApiController implements *Api (Für Spring) (z.B. LobbiesApiController)
333 333  )))
334 334  * (((
335 -* `*ApiDelegate` (z. B. `LobbiesApiDelegate`): Delegationsschnittstelle. Die fachliche Implementierung erfolgt **im eigenen, nicht generierten Code**.
278 +*ApiDelegate (z.B. LobbiesApiDelegate): Macht die eigentliche Arbeit und muss** im eigenen Code-Bereich** erweitert werden!
336 336  )))
337 337  
338 338  
... ... @@ -343,7 +343,7 @@
343 343  
344 344  [[image:1756888762381-912.png||height="48" width="789"]]
345 345  
346 -Für die fachliche Umsetzung wird ein eigener Service bzw. eine passende Delegate-Implementierung verwendet. Soll die Klasse von Spring verwaltet werden, muss sie als Spring-Komponente im Application Context registriert sein.
289 +Wenn man einen neuen Endpunkt definiert, muss man auch einen neuen Service definieren. (Hinweis: Der Service muss eine Spring Komponenten sein, damit sie in den Spring Context aufgenommen wird).
347 347  
348 348  In der Klasse muss man dann die neue Methode lobbyList aus der API überschreiben.
349 349  
... ... @@ -367,7 +367,7 @@
367 367  
368 368  === LobbyMapping ===
369 369  
370 -Da interne Serverobjekte häufig in DTOs überführt werden müssen, verwendet das Basisprojekt **MapStruct**. Die DTOs werden in der Regel aus der OpenAPI-Beschreibung generiert; das Mapping zwischen internem Modell und DTO wird im eigenen Code definiert.
313 +Da man relativ oft Server-Objekt in DTO umwandeln muss gibt es im Basisprojekt MapStruct. Damit muss man nur die DTO-Klasse anlegen (i.d.R. über OpenAPI!!)
371 371  
372 372  Also z.B.
373 373  
... ... @@ -381,9 +381,7 @@
381 381  
382 382  == Schritt 3: Erweiterung auf Client-Seite (Java) ==
383 383  
384 -{{info}}
385 -Dieses Beispiel bezieht sich auf den Java-Client. Bei Web-Clients, z. B. mit Angular oder React, unterscheidet sich die konkrete technische Integration; der OpenAPI-Vertrag bleibt jedoch derselbe.
386 -{{/info}}
327 +Hinweis: Das Beispiel bezieht sich hier auf eine Client mit Java. Für andere Clients wie Angular ist das Vorgehen anders.
387 387  
388 388  Auf der Client-Seite wird die komplette Kommunikation mit dem Server in der generierten Klasse DefaultApi gekapselt.
389 389  
... ... @@ -404,13 +404,13 @@
404 404  [[image:1756890010118-149.png||height="116" width="972"]]
405 405  
406 406  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.
407 -{{/expandable}}
408 408  
409 -= Asynchrone Kommunikation zum Client: WebSockets =
410 410  
350 += Kommunikation: Server ~-~-> Client (WebSockets) =
351 +
411 411  [[image:1756890800817-370.png||height="604" width="1121"]]
412 412  
413 -Für klassische REST-Aufrufe initiiert der Client die Anfrage. Muss der Server Clients **asynchron über Ereignisse oder Zustandsänderungen informieren**, verwendet das Basisprojekt WebSockets.
354 +Da man mit REST nicht Nachrichten vom Server an den Client schicken kann, werden im Basisprojekt dafür WebSockets verwendet.
414 414  
415 415  Spring bietet eine native Unterstützung von WebSockets. Für eigene Funktionen kann man sich in die Kommunikation über die Serverklasse WebSocketHandler einklinken
416 416  
... ... @@ -437,25 +437,47 @@
437 437  
438 438  == STOMP ==
439 439  
440 -WebSocket stellt einen bidirektionalen Kommunikationskanal bereit. Für eine strukturierte Nachrichtenkommunikation verwendet das Basisprojekt darüber **STOMP (Streaming Text Oriented Messaging Protocol)**.
381 +WebSockets haben kein Protokoll (wie z.B. http)
441 441  
442 -STOMP definiert u. a. Operationen wie `CONNECT`, `SEND` und `SUBSCRIBE` und arbeitet mit Topics. Ein Client kann ein Topic abonnieren und erhält anschließend Nachrichten, die der Server auf diesem Topic veröffentlicht.
383 +Es können entweder binäre oder textuelle Daten verarbeitet werden (die jeweiligen Gegenstellen müssen das wissen!)
443 443  
385 +Wenn man jetzt mehr als nur Text verschicken möchte, muss man sich überlegen, wie man Objekte z.B. mit JSON serialisiert (analog zu REST)
444 444  
445 -Veröffentlicht der Server eine Nachricht auf einem Topic, erhalten sie die dafür registrierten Clients. Dieses Modell entspricht dem **Publish/Subscribe-Pattern**.
387 +STOMP: Streaming Text Oriented Messaging Protocol
446 446  
389 +Definiert ein einfaches Protokoll, welches es erlaubt, sinnvoll über WebSockets zu kommunizieren
390 +
391 +Ist ein Teil von Spring
392 +
393 +Methoden sind z.B. CONNECT, SEND oder SUBSCRIBE
394 +
395 +STOMP arbeitet mit Topics
396 +
397 +Ein Client registriert (SUBSCRIBE) sich für bestimmte Ereignistypen
398 +
399 +
400 +§Wenn auf der Server-Seite dieser Typ veröffentlich wird dann wird dies an die jeweils interessierten Clients geschickt
401 +
402 +Publish/Subscribe-Pattern
403 +
447 447  [[https:~~/~~/docs.spring.io/spring-framework/reference/web/websocket/stomp.html>>url:https://docs.spring.io/spring-framework/reference/web/websocket/stomp.html]]
448 448  
449 449  
450 -Der Server definiert je nach fachlichem Bereich unterschiedliche Topics. Für das Nutzermanagement sind beispielsweise vorgesehen:
407 +§Der Server definiert unterschiedliche Topics (je nach Modul)
451 451  
452 -* `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
453 -* `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
409 +§Beim Nutzermanagement aktuell:
454 454  
411 +§/topic/users/loggedIn: Es hat sich ein neuer Nutzer angemeldet
412 +
413 +§/topic/users/loggedOut: Ein Nutzer hat sich ausgeloggt
414 +
415 +
455 455  [[image:1756891125969-748.png||height="317" width="726"]]
456 456  
457 -Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
418 +§Topic-Namen sind Strings, sollte aber Aufbau von oben entsprechen
458 458  
420 +§In der Lobby würde es stattdessen /topic/lobbies/* heißen
421 +
459 459  == WebSockets: Versenden von Nachrichten ==
460 460  
461 461  [[image:1756891180516-843.png||height="426" width="801"]]
... ... @@ -467,28 +467,27 @@
467 467  [[image:1756891254830-647.png||height="101" width="777"]]
468 468  
469 469  * message kann grundsätzlich alles sein, was serialisiert werden kann
470 -* Technisch könnte Java-Serialisierung verwendet werden; das alte Basisprojekt hat dies teilweise getan.
433 +* Man könnte nun einfach die Java-Serialisierung verwenden (im alten Basisprojekt ist das auch so)
471 471  * Das hat aber eine Reihe von Nachteilen
472 472  ** Der Empfänger muss dafür unbedingt auch ein Java-Client sein und er muss exakt dieselbe Klasse bei sich haben, damit der das Objekt wieder zurück in ein Java-Objekt umwandeln kann
473 473  ** Es gibt eine Reihe von Sicherheitsproblemen
474 -* Besser ist ein technologieunabhängigeres Austauschformat. Im Basisprojekt wird deshalb JSON verwendet.
437 +* Besser: Definiere ein gemeinsames Austauschformat, was viele verstehen ~-~-> Im Basisprojekt (und in vielen anderen Projekten auch) JSON verwenden
475 475  * Insbesondere Web-Clients (JavaScript) bieten hervorragende Möglichkeiten, an JSON zu verarbeiten
476 476  * Client und Server haben sich damit auf Format für den Austausch geeinigt
477 477  ** Topic: Strings
478 478  ** Message: JSON
479 479  
480 -Auch über WebSockets werden an Clients nur geeignete DTOs übertragen; interne Serverobjekte bleiben serverintern.
443 +An den Clilent werden auch bei WebSockets nur DTOs verschickt! (userMapping)
481 481  
482 482  [[image:1756891375095-158.png||height="266" width="775"]]
483 483  
484 484  == Wie verbindet sich ein Client mit dem Server? ==
485 485  
486 -{{expandable summary="Technische Details zum Verbindungsaufbau"}}
487 -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.
449 +UserService bietet eine Methode zum Login an. Diese ruft nun aber keine REST-Endpunkt auf (da man sich sowieso bei JEDEM Aufruf authentifizieren muss, macht so ein Endpunkt kein Sinn). Stattdessen wird die Verbindung mit dem WebSocket hergestellt und dort Nama und Passwort überprüft.
488 488  
489 489  [[image:1756891512330-186.png||height="170" width="820"]]
490 490  
491 -=== Auf Client-Seite: WebSocketConnectionManager ===
453 +=== Auf Server Seite (WebSocketConnectionManager): ===
492 492  
493 493  [[image:1756891551794-161.png||height="387" width="1019"]]
494 494  
... ... @@ -500,7 +500,7 @@
500 500  
501 501  4) Jackson als Mapper definieren (DTO-Object <-> JSON)
502 502  
503 -[[image:1756891617399-232.png||height="289" width="1006"]]
465 +=== [[image:1756891617399-232.png||height="289" width="1006"]] ===
504 504  
505 505  
506 506  1) Asynchron die Verbindung zum Server aufbauen
... ... @@ -510,13 +510,3 @@
510 510  3) Über den Kontext ein Event pushen LoggedInEvent
511 511  
512 512  4) Jede Serververbindung hat eine Session
513 -{{/expandable}}
514 -
515 -= Siehe auch =
516 -
517 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
518 -* [[Glossar>>doc:Main.Glossar.WebHome]]
519 -* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]
520 -* (((
521 -[[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
522 -)))
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
1792749012547-899.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -46.3 KB
Content
1792750917132-904.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -232.1 KB
Content
1792751165237-439.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -164.3 KB
Content