Wiki source code of Basisprojekt

Version 70.2 by Marco Grawunder on 2026/10/19 15:56

Show last authors
1 [[image:Main.Organisatorisches.WebHome@softwareprojekt_logo_transparent.png||alt="SoftwareprojektLogo.png" data-xwiki-image-style-alignment="end" height="136" width="309"]]
2
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.
9 {{/info}}
10
11 {{toc/}}
12
13
14 = Basisprojekt mit IntelliJ einrichten =
15
16 [[image:1755245956916-184.png]]
17
18 == Repository klonen ==
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}}
23
24 Sie finden die Clone-URL wie folgt:
25
26 * Loggen Sie sich auf [[https:~~/~~/gitlab.swl.informatik.uni-oldenburg.de/>>https://gitlab.swl.informatik.uni-oldenburg.de/]] ein
27 * Falls nicht vorausgewählt, wählen Sie auf der linken Seite "Projects"
28 [[image:1757398628416-879.png||height="119" width="541"]]
29 * Da Sie bisher noch nichts gemacht haben, ist diese Seite leer. Wechseln Sie auf den Reiter Member
30 * Dort sollte ihr Repository zu finden sein.
31 * Oben rechts gibt es einen Button Code. Kopieren Sie dort die URL, die hinter "Clone with HTTPS" steht.
32 [[image:1757398731084-704.png||height="454" width="323"]]
33
34 [[image:1755245971657-468.png]]
35
36 == Access Token ==
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 anschließend **Access tokens**.
40
41 [[image:1757398899497-714.png||height="246" width="278"]]
42
43 Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen.
44
45 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.
46
47 [[image:1757399088336-273.png||height="92" width="547"]]
48
49 Bei den Scopes sollten die beiden Rechte "read_repository" und "write_repository" gewählt werden.
50
51 Danach wird das Access Token generiert
52
53 [[image:1757399184270-348.png||height="99" width="978"]]
54
55 {{warning}}
56 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.**
57 {{/warning}}
58
59 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.
60 {{/expandable}}
61
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
68 == Nach dem Klonen ==
69
70 sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
71
72 [[image:1755245980026-164.png]]
73
74 Auf dem main-Branch (master) kann keine Änderung gemacht werden, deswegen muss auf einen anderen Branch gewechselt werden. Im Beispiel development.
75
76 [[image:1755245996886-733.png]]
77
78 == Initialer Maven-Build und Codegenerierung ==
79
80 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.
81
82 [[image:1755246008466-477.png]]
83
84
85 [[image:1755246018789-616.png]]
86
87
88 == Lombok-Plugin ==
89
90 Falls das Lombok-Plugin noch nicht installiert ist, installieren bzw. aktivieren Sie es in IntelliJ.
91
92 [[image:1755248508652-523.png]]
93
94 Je nach IntelliJ-Edition kann zusätzlich das Spring-/Spring-Boot-Plugin hilfreich sein.
95
96 [[image:1756886220468-891.png]]
97
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 Man kann auch versuchen, die Caches von IntelliJ einmal zu löschen: File → Invalidate Caches → Invalidate and Restart
118
119 Falls es immer noch Problem gibt: Es gibt eine erweiterte Checkliste: [[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
120
121 == Server starten ==
122
123 Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.
124
125 [[image:1755246035428-328.png]]
126
127
128 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.
129
130 [[image:1755246072443-191.png]]
131
132
133 [[image:1755246118807-452.png]]
134
135
136 == Logging umstellen ==
137
138 {{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
139 Wenn man möchte, kann man das Logging umstellen.
140
141 [[image:1755246135109-325.png]]
142
143
144 [[image:1755246147827-679.png]]
145
146
147 [[image:1755246162330-595.png]]
148 {{/expandable}}
149
150 == Development-Profil aktivieren ==
151
152 {{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
153 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.
154
155 Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
156
157 [[image:1757399848941-253.png||height="209" width="558"]]
158
159 [[image:1755246173415-934.png]]
160
161
162 Wenn die verwendete IntelliJ-Version keine Spring-Unterstützung bietet, kann das Profil über eine Umgebungsvariable in der Server-Konfiguration gesetzt werden:
163
164 **SPRING_PROFILES_ACTIVE=dev**
165
166 [[image:1755248752596-839.png]]
167
168 Danach muss man den Server neu starten!
169 {{/expandable}}
170
171 == Client starten ==
172
173 Wenn der Server gestartet ist, kann man mehrere Clients starten. Dafür auf jeden Fall die Klasse Main verwenden.
174
175 {{warning}}
176 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.
177 {{/warning}}
178
179 [[image:1755246257400-525.png]]
180
181
182 [[image:1755246212916-883.png]]
183
184
185 [[image:1755246223246-834.png]]
186
187
188 === Mehrere Instanzen des Clients ermöglichen ===
189
190 {{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
191 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.
192
193 [[image:1755246233218-893.png]]
194
195
196 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.
197
198 [[image:1755246292057-581.png]]
199 {{/expandable}}
200
201 = Überblick über das Basisprojekt =
202
203 [[image:1755249096987-249.png]]
204
205
206 [[image:1755249136156-419.png]]
207
208
209 == Projektstruktur ==
210
211 [[image:1755249228556-469.png]]
212
213
214 = Kommunikation vom Client zum Server: REST =
215
216 [[image:1755249285866-367.png]]
217
218 Für klassische Request/Response-Operationen verwendet das Basisprojekt **REST über HTTP**. Als Austauschformat wird **JSON** verwendet. Die zentrale Spiellogik verbleibt auf dem Server.
219
220 = OpenAPI =
221
222 {{info}}
223 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.
224 {{/info}}
225
226 {{info}}
227 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
228 {{/info}}
229
230 [[image:1755250026156-269.png]]
231
232 [[image:1755250050031-304.png]]
233
234 * **Paths**: Endpunkte der API (z.B. /users, /lobbies).
235 * **Operations**: Spezifikation von Methoden wie GET, POST.
236 * **Schemas**: Beschreibung der Datenstrukturen für Ein- und Ausgaben.
237 * **Security**: Authentifizierungsmechanismen.
238
239 [[image:1755250061990-172.png]]
240
241 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.
242
243 [[image:1755250157536-746.png]]
244
245 Die aktuelle Version des OpenAPI Dokumentes findet sich im Basisprojekt 2 [[https:~~/~~/gitlab.swl.informatik.uni-oldenburg.de/SPB/SWPBasisprojekt2/-/blob/master/openapi.yaml?ref_type=heads>>https://gitlab.swl.informatik.uni-oldenburg.de/SPB/SWPBasisprojekt2/-/blob/master/openapi.yaml?ref_type=heads]]
246
247 Dort wird die Datei auch grafisch dargestellt.
248
249
250 = Maven und OpenAPI =
251
252 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]]
253
254 Die Generierung kann über die Kommandozeile erfolgen; im Basisprojekt ist sie bereits in den Maven-Build integriert.
255
256 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:
257
258 == Client ==
259
260 Im Java-Client wird ein HTTP-Client für den Zugriff auf die generierte API verwendet.
261
262
263 [[image:1756887005209-855.png]]
264
265 == Server ==
266
267 Auf der Serverseite werden Spring-/Spring-Boot-kompatible Schnittstellen und Controller-Strukturen generiert.
268
269 [[image:1756887037619-847.png]]
270
271 {{info}}
272 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]].
273 {{/info}}
274
275
276
277 = Erweiterung der REST-Schnittstelle =
278
279 {{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
280 In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
281
282 In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
283
284 == Schritt 1: OpenAPI-Dokument erweitern ==
285
286 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.
287
288 Die Funktion soll sehr einfach sein und keine Parameter verlangen. Dafür bietet sich die GET-Funktion an.
289
290 Im folgenden Bild sind alle Anpassungen zu sehen:
291
292 [[image:1756887436525-790.png||height="355" width="974"]]
293
294
295 Nach dem Speichern, sollte das OpenAPI-Dokument wie folgt aussehen
296
297 [[image:1756887488020-376.png||height="642" width="904"]]
298
299
300 Jetzt kann man entweder in IntelliJ
301
302 [[image:1756888245896-845.png||height="347" width="620"]]
303
304 oder im Terminal (z.B. auch in IntelliJ)
305
306 [[image:1756888279902-777.png||height="637" width="1053"]]
307
308 Wobei hier auch clean compile reichen würde.
309
310 **ACHTUNG! Falls maven Problem macht, kann das auch an einer falschen Java-Version im System liegen (siehe auch [[FAQ>>doc:.Basisprojekt FAQ.WebHome]])**
311
312 Es werden durch den Aufruf neue Inhalte generiert (bzw. die alten überschrieben).
313
314 [[image:1756888428042-802.png||height="538" width="1077"]]
315
316 Hinweis: Niemals Änderungen unterhalb des target-Ordners machen. Das wird von Maven bei clean gelöscht.
317
318 === Wo wird die eigentliche Funktionalität implementiert? ===
319
320 Für jeden API-Bereich (z. B. `lobbies` und `users`) werden serverseitig typischerweise mehrere Schnittstellen bzw. Klassen generiert:
321
322 * *Api (z.B, LobbiesApi): Beschreibung der REST-Methoden, vor allem auch das Mapping von z.B. /lobbies/join auf die Methode lobbyJoin(String)
323 * (((
324 *ApiController implements *Api (Für Spring) (z.B. LobbiesApiController)
325 )))
326 * (((
327 * `*ApiDelegate` (z. B. `LobbiesApiDelegate`): Delegationsschnittstelle. Die fachliche Implementierung erfolgt **im eigenen, nicht generierten Code**.
328 )))
329
330
331
332 == Schritt 2: Erweiterung auf Server-Seite ==
333
334 Da es schon Funktionen für die Lobbies gibt, gibt es auch bereits eine Implementierung, die LobbiesApiDelegate überschreibt
335
336 [[image:1756888762381-912.png||height="48" width="789"]]
337
338 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.
339
340 In der Klasse muss man dann die neue Methode lobbyList aus der API überschreiben.
341
342 [[image:1756888929507-312.png||height="156" width="1161"]]
343
344 Dabei wird folgendes gemacht:
345
346 1. Es wird ein Rückgabeobjekt vom Typ Liste erzeugt
347 1. Es wird über alles Lobbies auf dem Server gegangen (lobbyManagement.getLobbies())
348 1. Da der Client u.U. nicht die vollständigen Informationen über die Lobbies bekommen soll, gibt es zwei unterschiedliche Klassen: ServerLobby und LobbyDTO.
349 1. Die Foreach-Schleife sorgt dafür, dass in das Rückgabeobjekt nur die LobbyDTOs eingefügt werden.
350 1. Dafür wird eine Funktion mit dem Namen lobbyMapping verwendet
351 1. Schließlich wird am Ende gesagt, dass alles ok ist und eine Antwort ResponseEntity.ok mit dem Rückgabeobjekt (lobbies) gesendet.
352
353 **Anmerkung**: Das Basisprojekt ist aktuell so eingerichtet, dass Spring Exceptions auffängt und entsprechend an den Client leitet. Diese findet in der Klasse  GlobalExceptionHandler statt
354
355 Auf Server-Seite fehlt jetzt noch die Methode getLobbies im LobbyManagement
356
357 [[image:1756889590500-656.png||height="81" width="518"]]
358
359
360 === LobbyMapping ===
361
362 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.
363
364 Also z.B.
365
366 [[image:1756889440395-856.png]]
367
368 und definiert ein Interface mit einer Annotation
369
370 [[image:1756889472103-847.png]]
371
372 und damit kann man die Funktion aufrufen. Hinweis: Der Mapper ist im LobbyService über die Spring Dependency Injection gebunden.
373
374 == Schritt 3: Erweiterung auf Client-Seite (Java) ==
375
376 {{info}}
377 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.
378 {{/info}}
379
380 Auf der Client-Seite wird die komplette Kommunikation mit dem Server in der generierten Klasse DefaultApi gekapselt.
381
382 [[image:1756889795622-530.png]]
383
384 Dort gibt es eine neue Methode lobbyList. Die sorgt dafür, dass der REST-Aufruf auf die Server-Seite geht und liefert das passende Objekt List<LobbyDTO> zurück
385
386 Im Client gibt es auch eine Klasse LobbyService. Dort ist die DefaultApi Klasse über Dependency Injection gebunden.
387
388 [[image:1756889917681-650.png]]
389
390 Dort kann man nun eine neue Methode getLobbies() integrieren:
391
392 [[image:1756889979252-910.png]]
393
394 Und das Ganze dann z.B. im MainMenuPresenter verwenden:
395
396 [[image:1756890010118-149.png||height="116" width="972"]]
397
398 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.
399 {{/expandable}}
400
401 = Asynchrone Kommunikation zum Client: WebSockets =
402
403 [[image:1756890800817-370.png||height="604" width="1121"]]
404
405 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.
406
407 Spring bietet eine native Unterstützung von WebSockets. Für eigene Funktionen kann man sich in die Kommunikation über die Serverklasse WebSocketHandler einklinken
408
409
410 [[image:1756890924024-346.png||height="377" width="1092"]]
411
412
413 Sobald sich jemand beim Server für WebSockets angemeldet hat wird von Spring ein org.springframework.web.socket.messaging.SessionConnectedEvent
414 geworfen, welches in der folgenden Methode (im WebSocketHandler) aufgefangen wird
415
416 [[image:1756890958794-603.png||height="373" width="1087"]]
417
418 Die Methode ist Observer für das Event SessionConnectedEvent
419
420 Der WebSocketServer kennt die Nutzer und erlaubt das Einloggen nur, wenn Login und Passwort stimmen (durch Spring Security)
421
422 [[image:1756891019715-621.png]]
423
424 1)Aus dem Event kann der Nutzer gelesen werden (der sollte nie leer sein)
425
426 2) Dann wird sich aus dem Repository (später mehr) der Nutzer geholt, der durch den Namen identifiziert ist (z.B. „test1“)
427
428 3) Schließlich werden allen anderen darüber informiert, dass ein neuer Nutzer da ist
429
430 == STOMP ==
431
432 WebSocket stellt einen bidirektionalen Kommunikationskanal bereit. Für eine strukturierte Nachrichtenkommunikation verwendet das Basisprojekt darüber **STOMP (Streaming Text Oriented Messaging Protocol)**.
433
434 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.
435
436
437 Veröffentlicht der Server eine Nachricht auf einem Topic, erhalten sie die dafür registrierten Clients. Dieses Modell entspricht dem **Publish/Subscribe-Pattern**.
438
439 [[https:~~/~~/docs.spring.io/spring-framework/reference/web/websocket/stomp.html>>url:https://docs.spring.io/spring-framework/reference/web/websocket/stomp.html]]
440
441
442 Der Server definiert je nach fachlichem Bereich unterschiedliche Topics. Für das Nutzermanagement sind beispielsweise vorgesehen:
443
444 * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
445 * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
446
447 [[image:1756891125969-748.png||height="317" width="726"]]
448
449 Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
450
451 == WebSockets: Versenden von Nachrichten ==
452
453 [[image:1756891180516-843.png||height="426" width="801"]]
454
455 [[image:1756891216134-578.png||height="428" width="699"]]
456
457 == Nachrichteninhalt ==
458
459 [[image:1756891254830-647.png||height="101" width="777"]]
460
461 * message kann grundsätzlich alles sein, was serialisiert werden kann
462 * Technisch könnte Java-Serialisierung verwendet werden; das alte Basisprojekt hat dies teilweise getan.
463 * Das hat aber eine Reihe von Nachteilen
464 ** 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
465 ** Es gibt eine Reihe von Sicherheitsproblemen
466 * Besser ist ein technologieunabhängigeres Austauschformat. Im Basisprojekt wird deshalb JSON verwendet.
467 * Insbesondere Web-Clients (JavaScript) bieten hervorragende Möglichkeiten, an JSON zu verarbeiten
468 * Client und Server haben sich damit auf Format für den Austausch geeinigt
469 ** Topic: Strings
470 ** Message: JSON
471
472 Auch über WebSockets werden an Clients nur geeignete DTOs übertragen; interne Serverobjekte bleiben serverintern.
473
474 [[image:1756891375095-158.png||height="266" width="775"]]
475
476 == Wie verbindet sich ein Client mit dem Server? ==
477
478 {{expandable summary="Technische Details zum Verbindungsaufbau"}}
479 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.
480
481 [[image:1756891512330-186.png||height="170" width="820"]]
482
483 === Auf Client-Seite: WebSocketConnectionManager ===
484
485 [[image:1756891551794-161.png||height="387" width="1019"]]
486
487 1) Variablen definieren
488
489 2) WebSocketClient erzeugen
490
491 3) Daraus WebSocketStompClient machen
492
493 4) Jackson als Mapper definieren (DTO-Object <-> JSON)
494
495 [[image:1756891617399-232.png||height="289" width="1006"]]
496
497
498 1) Asynchron die Verbindung zum Server aufbauen
499
500 2) Wenn erfolgreich in das Hauptmenü wechseln (showScene à später mehr)
501
502 3) Über den Kontext ein Event pushen LoggedInEvent
503
504 4) Jede Serververbindung hat eine Session
505 {{/expandable}}
506
507 = Siehe auch =
508
509 * [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
510 * [[Glossar>>doc:Main.Glossar.WebHome]]
511 * [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]