Wiki source code of Basisprojekt

Version 64.1 by Marco Grawunder on 2026/08/25 16:31

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