Wiki source code of Basisprojekt

Version 72.1 by Carl Welsch on 2026/10/23 11:43

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