Wiki source code of Basisprojekt

Version 73.2 by Carl Welsch on 2026/10/23 11:44

Manage
- Copy
Actions
- Export
- Print Preview
Viewers
- Source
- Children
- Content
- Comments
- Attachments (68)
- History
- Information
- Likes

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

Wiki source code of Basisprojekt

Applications

Navigation