Wiki source code of Basisprojekt

Last modified by Carl Welsch on 2026/10/23 16:19

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

Wiki source code of Basisprojekt

Applications

Navigation