Wiki source code of Basisprojekt

Version 65.1 by Marco Grawunder on 2026/08/26 10:13

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