Changes for page Basisprojekt
Last modified by Marco Grawunder on 2026/09/08 10:20
From version 64.1
edited by Marco Grawunder
on 2026/08/25 16:31
on 2026/08/25 16:31
Change comment:
There is no comment for this version
To version 62.1
edited by Marco Grawunder
on 2025/10/16 11:59
on 2025/10/16 11:59
Change comment:
There is no comment for this version
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,8 +1,6 @@ 1 1 [[image:Main.Organisatorisches.WebHome@softwareprojekt_logo_transparent.png||alt="SoftwareprojektLogo.png" data-xwiki-image-style-alignment="end" height="136" width="309"]] 2 2 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}} 3 +Hier folgen Erklärungen des neuen Basisprojekts. Es wird um die folgenden Themen gehen: 6 6 7 7 {{toc/}} 8 8 ... ... @@ -11,11 +11,9 @@ 11 11 12 12 [[image:1755245956916-184.png]] 13 13 14 -== Repository klonen==12 +== Clone == 15 15 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}} 14 +Achtung! In dem Screenshot wird das globale Basisprojekt verwendet. Für jede Gruppe existiert bereits ein eigenes Repository, welches verwendet werden sollte, 19 19 20 20 Sie finden die Clone-URL wie folgt: 21 21 ... ... @@ -31,15 +31,13 @@ 31 31 32 32 == Access Token == 33 33 34 - {{expandablesummary="Schritt-für-Schritt:AccessToken einrichten"}}30 +Beim ersten Mal clonen müssen Sie Ihre Gitlab-Zugangsdaten verwenden. Statt Name und Passwort ist es sinnvoll, einen Access-Token zu definieren. Das können Sie machen, in dem Sie auf ihre Profilbild klicken (auf der linken Seite) und dort "Edit Profile" auswählen. In dem nun folgenden Menü gibt es den Punkt Access tokens. 35 35 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**. 37 - 38 38 [[image:1757398899497-714.png||height="246" width="278"]] 39 39 40 40 Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen. 41 41 42 -Als Namen k ann z.B.`IntelliJ`verwendet werden.AccessTokenssindaus Sicherheitsgründenzeitlichbegrenzt.WählenSieeinAblaufdatum, daszumProjektzeitraumpasst.36 +Als Namen können Sie z.B. IntelliJ verwenden. Wichtig! Das Token ist aus Sicherheitsgründen nur eine bestimmte Zeit gültig. In diesem Gitlab kann dies maximal ein Jahr sein, standardmäßig ist ist hier aber ein Monat gewählt. Sie sollten also das Feld anpassen. 43 43 44 44 [[image:1757399088336-273.png||height="92" width="547"]] 45 45 ... ... @@ -49,15 +49,13 @@ 49 49 50 50 [[image:1757399184270-348.png||height="99" width="978"]] 51 51 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}} 46 +Jetzt ist es wichtig, dass Sie sich das Token sichern! 55 55 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}} 48 +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. 58 58 59 -== Nach dem Klonen == 60 60 51 +== Nach dem Clonen == 52 + 61 61 sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen: 62 62 63 63 [[image:1755245980026-164.png]] ... ... @@ -66,9 +66,10 @@ 66 66 67 67 [[image:1755245996886-733.png]] 68 68 69 -== Initialer Maven-Buildund Codegenerierung ==61 +== Initialer Build (Generierung) == 70 70 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. 63 +Dem neuen Code fehlen einige generierte Dateien. Diese werden wie folgt erzeugt. 64 +Hinweis: Immer, wenn an dem OpenAPI-Dokument etwas geändert wird oder neue Abhängigkeiten für Maven definiert werden, muss diese Aktion durchgeführt werden. 72 72 73 73 [[image:1755246008466-477.png]] 74 74 ... ... @@ -76,17 +76,17 @@ 76 76 [[image:1755246018789-616.png]] 77 77 78 78 79 -== Lombok -Plugin ==72 +== Lombok Plugin == 80 80 81 - Falls dasLombok-Pluginnoch nicht installiertist, installierenbzw. aktivierenSieesinIntelliJ.74 +**Lombok Plugin installiert? Wenn nein jetzt machen** 82 82 83 83 [[image:1755248508652-523.png]] 84 84 85 - Je nachIntelliJ-Editionkannzusätzlich das Spring-/Spring-Boot-Pluginhilfreich sein.78 +**Hinweis: Wenn man schon hier ist, kann man auch das Spring-(Boot)-Plugin **installieren 86 86 87 87 [[image:1756886220468-891.png]] 88 88 89 -== Server starten ==82 +== Server laufen lassen == 90 90 91 91 Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken. 92 92 ... ... @@ -93,7 +93,7 @@ 93 93 [[image:1755246035428-328.png]] 94 94 95 95 96 - FallsIntelliJnach dem Start AnnotationProcessingfürLombokanbietet,aktivierenSie es. Ohne korrekteingerichtetesLombokbzw. AnnotationProcessingwerdenÄnderungengegebenenfalls erstnach einemerneutenMaven-Buildkorrekt erkannt.89 +... und ggf. Lombok aktivieren (Man wird nach dem Start der Anwendung gefragt). WICHTIG! Wenn das Lombok-Plugin nicht installiert und die folgende Funktion nicht aktiviert ist, muss jede Änderung mit Hilfe von Maven passieren. 97 97 98 98 [[image:1755246072443-191.png]] 99 99 ... ... @@ -103,8 +103,6 @@ 103 103 104 104 == Logging umstellen == 105 105 106 -{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}} 107 - 108 108 Wenn man möchte, kann man das Logging umstellen. 109 109 110 110 [[image:1755246135109-325.png]] ... ... @@ -114,14 +114,11 @@ 114 114 115 115 116 116 [[image:1755246162330-595.png]] 117 -{{/expandable}} 118 118 119 -== Development -Profil aktivieren ==109 +== Development Profil aktivieren == 120 120 121 - {{expandablesummary="Schritt-für-Schritt:Development-Profil aktivieren"}}111 +Damit das Testen einfacher geht, gibt es ein spezielles Spring-Profil. In diesem werden automatisch user1-user9 mit jeweils dem identischen Passwort angelegt und man spart sich die Registierung. 122 122 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. 124 - 125 125 Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen: 126 126 127 127 [[image:1757399848941-253.png||height="209" width="558"]] ... ... @@ -129,7 +129,7 @@ 129 129 [[image:1755246173415-934.png]] 130 130 131 131 132 -Wenn die verwendeteIntelliJ-Versionkeine Spring-Unterstützungbietet, kanndasProfil über eine Umgebungsvariable in derServer-Konfigurationgesetztwerden:120 +**Wenn man IntelliJ nicht in der Pro-Version verwendet bzw. das Spring Boot Plugin nicht installiert hat, muss kann man ein Spring-Profil über eine Umgebungsvariable in der Konfiguration des Servers setzen: ** 133 133 134 134 **SPRING_PROFILES_ACTIVE=dev** 135 135 ... ... @@ -136,15 +136,12 @@ 136 136 [[image:1755248752596-839.png]] 137 137 138 138 Danach muss man den Server neu starten! 139 -{{/expandable}} 140 140 141 141 == Client starten == 142 142 143 143 Wenn der Server gestartet ist, kann man mehrere Clients starten. Dafür auf jeden Fall die Klasse Main verwenden. 144 144 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}} 132 +**Sollte es nun Problem geben, schauen Sie bitte, ob Sie noch eine alte Java-Version auf ihrem System installiert haben. Wir brauchen mindestens Java 21!** 148 148 149 149 [[image:1755246257400-525.png]] 150 150 ... ... @@ -157,20 +157,18 @@ 157 157 158 158 === Mehrere Instanzen des Clients ermöglichen === 159 159 160 -{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}} 161 - 162 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 163 164 164 [[image:1755246233218-893.png]] 165 165 166 166 167 - Falls dieAnmeldungeinesvorbereitetenTestnutzersfehlschlägt, prüfen Sie insbesondere,obdas`dev`-Profil aktivistundderBenutzer angelegtwurde.Läuftder Server nicht,erscheintin derRegel eine andere Fehlermeldung.150 +Wenn folgendes kommt, ist entweder das "dev" Profil nicht aktiviert, der Nutzer wurde nicht angelegt. Wenn der Server nicht läuft, gibt es eine andere Fehlermeldung. 168 168 169 169 [[image:1755246292057-581.png]] 170 -{{/expandable}} 171 171 172 -= Überblick über das Basisprojekt = 173 173 155 += Kurzer Blick ins Basisprojekt = 156 + 174 174 [[image:1755249096987-249.png]] 175 175 176 176 ... ... @@ -177,22 +177,20 @@ 177 177 [[image:1755249136156-419.png]] 178 178 179 179 180 -== Projektstruktur==163 +== Screenshots == 181 181 182 182 [[image:1755249228556-469.png]] 183 183 184 184 185 -= Kommunikation vomClientzumServer:REST=168 += Kommunikation Client ~-~-> Server = 186 186 187 187 [[image:1755249285866-367.png]] 188 188 189 - FürklassischeRequest/Response-Operationenverwendet dasBasisprojekt **RESTüberHTTP**.Als Austauschformatwird **JSON** verwendet. Die zentrale Spiellogik verbleibt auf dem Server.172 +Der Server verwendet das REST-Protokoll und als Austauschformat JSON 190 190 191 191 = OpenAPI = 192 192 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}} 176 +(Hinweis: Ich bin nicht sicher, ob IntelliJ diese Darstellung auch hat, wenn man nicht die Ultimate Version verwendet. Ggf. muss man das OpenAPI-Plugin installieren) 196 196 197 197 [[image:1755250026156-269.png]] 198 198 ... ... @@ -200,12 +200,12 @@ 200 200 201 201 * **Paths**: Endpunkte der API (z.B. /users, /lobbies). 202 202 * **Operations**: Spezifikation von Methoden wie GET, POST. 203 -* ** Schemas**: Beschreibungder DatenstrukturenfürEin- und Ausgaben.184 +* **Definitions**: Detaillierte Beschreibung von Eingabe- und Ausgabestrukturen. 204 204 * **Security**: Authentifizierungsmechanismen. 205 205 206 206 [[image:1755250061990-172.png]] 207 207 208 - OpenAPI-Dokumentekönnen inJSON oder YAMLformuliertwerden. **YAML** steht heuterekursivfür „YAML Ain't Markup Language“und istfür menschenlesbareKonfigurations-und Beschreibungsdateienhäufigkompakterals JSON.189 +Kann JSON oder YAML (Yet Another Markup Language) verwenden YAML ist wie JSON nur mit weniger Klammern 209 209 210 210 [[image:1755250157536-746.png]] 211 211 ... ... @@ -216,15 +216,15 @@ 216 216 217 217 = Maven und OpenAPI = 218 218 219 -Die OpenAPI -Datei kann verwendet werden, umTeileder[[REST-Schnittstelle>>doc:Main.Basisprojekt.WebHome||anchor="HErweiterungderREST-Schnittstelle"]]zugenerieren. DafürwirdderOpenAPI Generatoreingesetzt[[https:~~/~~/github.com/OpenAPITools/openapi-generator>>https://github.com/OpenAPITools/openapi-generator]]200 +Die OpenAPI Datei kann verwendet werden, um sich die [[REST-Schnittstellen>>doc:||anchor="HErweiterungderREST-Schnittstelle"]] generieren zu lassen. Diese Erzeugung erfolgt mit dem OpenAPI Generator [[https:~~/~~/github.com/OpenAPITools/openapi-generator>>https://github.com/OpenAPITools/openapi-generator]] 220 220 221 - Die Generierungkannüberdie Kommandozeile erfolgen;im Basisprojektist sie bereits inden Maven-Buildintegriert.202 +Man kann dabei jetzt einen Kommandozeilenaufruf verwenden oder man setzt auf das im Basisprojekt vorhandene MVN () 222 222 223 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 224 225 225 == Client == 226 226 227 -Im Java-Client wirdeinHTTP-Clientfür denZugriffauf die generierteAPIverwendet.208 +Im Client werden die Apache Http Bibliothek verwendet. 228 228 229 229 230 230 [[image:1756887005209-855.png]] ... ... @@ -231,25 +231,27 @@ 231 231 232 232 == Server == 233 233 234 - AufderServerseitewerdenSpring-/Spring-Boot-kompatibleSchnittstellenundController-Strukturen generiert.215 +Im Server wird Spring (Boot) verwendet 235 235 236 236 [[image:1756887037619-847.png]] 237 237 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}} 219 +TODO: Weitere Informationen zu 241 241 221 +- Lombok 242 242 223 +- Dependency Injection 243 243 244 - =ErweiterungderREST-Schnittstelle=225 +- Spring (Boot), siehe auch [[https:~~/~~/www.marcobehler.com/guides/spring-framework>>https://www.marcobehler.com/guides/spring-framework]] 245 245 246 -{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}} 247 247 228 + 229 += Erweiterung der REST-Schnittstelle = 230 + 248 248 In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann. 249 249 250 250 In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen. 251 251 252 -== Schritt 1: OpenAPI-Dokument erweitern==235 +== Schritt 1: Erweitere das OpenAPI-Dokument == 253 253 254 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 255 ... ... @@ -283,9 +283,9 @@ 283 283 284 284 Hinweis: Niemals Änderungen unterhalb des target-Ordners machen. Das wird von Maven bei clean gelöscht. 285 285 286 -=== Wo wirddieeigentliche Funktionalitätimplementiert? ===269 +=== Wie bekommt man dann aber nun die Funktionalität rein? === 287 287 288 -Für jeden API-Bereich(z.B.`lobbies`und`users`) werdenserverseitigtypischerweise mehrere Schnittstellen bzw.Klassengeneriert:271 +Für jeden Endpunkt (also aktuell lobbies und users) werden drei Interfaces/Klassen erzeugt: 289 289 290 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 291 * ((( ... ... @@ -292,7 +292,7 @@ 292 292 *ApiController implements *Api (Für Spring) (z.B. LobbiesApiController) 293 293 ))) 294 294 * ((( 295 -* `*ApiDelegate`(z.B.`LobbiesApiDelegate`):Delegationsschnittstelle.DiefachlicheImplementierungerfolgt**im eigenen,nichtgeneriertenCode**.278 +*ApiDelegate (z.B. LobbiesApiDelegate): Macht die eigentliche Arbeit und muss** im eigenen Code-Bereich** erweitert werden! 296 296 ))) 297 297 298 298 ... ... @@ -303,7 +303,7 @@ 303 303 304 304 [[image:1756888762381-912.png||height="48" width="789"]] 305 305 306 - Für diefachliche UmsetzungwirdeineigenerServicebzw.einepassendeDelegate-Implementierungverwendet.SolldieKlassevonSpringverwaltetwerden,musssiealsSpring-Komponente imApplication Contextregistriert sein.289 +Wenn man einen neuen Endpunkt definiert, muss man auch einen neuen Service definieren. (Hinweis: Der Service muss eine Spring Komponenten sein, damit sie in den Spring Context aufgenommen wird). 307 307 308 308 In der Klasse muss man dann die neue Methode lobbyList aus der API überschreiben. 309 309 ... ... @@ -327,7 +327,7 @@ 327 327 328 328 === LobbyMapping === 329 329 330 -Da interne Serverobjektehäufig in DTOsüberführtwerden müssen,verwendetdas Basisprojekt**MapStruct**. DieDTOswerdeninderRegel ausderOpenAPI-Beschreibung generiert; dasMapping zwischeninternem Modell undDTO wirdimeigenenCodedefiniert.313 +Da man relativ oft Server-Objekt in DTO umwandeln muss gibt es im Basisprojekt MapStruct. Damit muss man nur die DTO-Klasse anlegen (i.d.R. über OpenAPI!!) 331 331 332 332 Also z.B. 333 333 ... ... @@ -341,9 +341,7 @@ 341 341 342 342 == Schritt 3: Erweiterung auf Client-Seite (Java) == 343 343 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}} 327 +Hinweis: Das Beispiel bezieht sich hier auf eine Client mit Java. Für andere Clients wie Angular ist das Vorgehen anders. 347 347 348 348 Auf der Client-Seite wird die komplette Kommunikation mit dem Server in der generierten Klasse DefaultApi gekapselt. 349 349 ... ... @@ -364,13 +364,13 @@ 364 364 [[image:1756890010118-149.png||height="116" width="972"]] 365 365 366 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. 367 -{{/expandable}} 368 368 369 -= Asynchrone Kommunikation zum Client: WebSockets = 370 370 350 += Kommunikation: Server ~-~-> Client (WebSockets) = 351 + 371 371 [[image:1756890800817-370.png||height="604" width="1121"]] 372 372 373 - FürklassischeREST-AufrufeinitiiertderClientdieAnfrage.MussderServer Clients**asynchron über Ereignisseoder Zustandsänderungen informieren**,verwendet dasBasisprojekt WebSockets.354 +Da man mit REST nicht Nachrichten vom Server an den Client schicken kann, werden im Basisprojekt dafür WebSockets verwendet. 374 374 375 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 376 ... ... @@ -397,26 +397,47 @@ 397 397 398 398 == STOMP == 399 399 400 -WebSocket stellteinenbidirektionalenKommunikationskanal bereit. Für einestrukturierte NachrichtenkommunikationverwendetdasBasisprojektdarüber **STOMP (Streaming TextOriented Messaging Protocol)**.381 +WebSockets haben kein Protokoll (wie z.B. http) 401 401 402 - STOMPdefiniertu. a. Operationenwie`CONNECT`,`SEND` und`SUBSCRIBE` undarbeitetmit Topics. EinClientkannein Topic abonnierenunderhält anschließendNachrichten,die der Serveraufdiesem Topic veröffentlicht.383 +Es können entweder binäre oder textuelle Daten verarbeitet werden (die jeweiligen Gegenstellen müssen das wissen!) 403 403 385 +Wenn man jetzt mehr als nur Text verschicken möchte, muss man sich überlegen, wie man Objekte z.B. mit JSON serialisiert (analog zu REST) 404 404 405 - VeröffentlichtderServer eine Nachricht auf einemTopic,erhaltensie die dafürregistriertenClients. DiesesModell entsprichtdem **Publish/Subscribe-Pattern**.387 +STOMP: Streaming Text Oriented Messaging Protocol 406 406 389 +Definiert ein einfaches Protokoll, welches es erlaubt, sinnvoll über WebSockets zu kommunizieren 390 + 391 +Ist ein Teil von Spring 392 + 393 +Methoden sind z.B. CONNECT, SEND oder SUBSCRIBE 394 + 395 +STOMP arbeitet mit Topics 396 + 397 +Ein Client registriert (SUBSCRIBE) sich für bestimmte Ereignistypen 398 + 399 + 400 +§Wenn auf der Server-Seite dieser Typ veröffentlich wird dann wird dies an die jeweils interessierten Clients geschickt 401 + 402 +Publish/Subscribe-Pattern 403 + 407 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 408 409 409 410 -Der Server definiert je nach fachlichem Bereichunterschiedliche Topics.Für das Nutzermanagementsindbeispielsweise vorgesehen:407 +§Der Server definiert unterschiedliche Topics (je nach Modul) 411 411 412 -* `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet. 413 -* `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt. 409 +§Beim Nutzermanagement aktuell: 414 414 411 +§/topic/users/loggedIn: Es hat sich ein neuer Nutzer angemeldet 415 415 413 +§/topic/users/loggedOut: Ein Nutzer hat sich ausgeloggt 414 + 415 + 416 416 [[image:1756891125969-748.png||height="317" width="726"]] 417 417 418 -Topic-Namen sind Strings, sollte nabereinem konsistentenfachlichenNamensschema folgen.Für Lobby-Ereignissebietet sich entsprechend `/topic/lobbies/...` an.418 +§Topic-Namen sind Strings, sollte aber Aufbau von oben entsprechen 419 419 420 +§In der Lobby würde es stattdessen /topic/lobbies/* heißen 421 + 420 420 == WebSockets: Versenden von Nachrichten == 421 421 422 422 [[image:1756891180516-843.png||height="426" width="801"]] ... ... @@ -428,29 +428,27 @@ 428 428 [[image:1756891254830-647.png||height="101" width="777"]] 429 429 430 430 * message kann grundsätzlich alles sein, was serialisiert werden kann 431 -* Technischkönnte Java-Serialisierung verwendet werden;dasalte Basisprojekthat diesteilweise getan.433 +* Man könnte nun einfach die Java-Serialisierung verwenden (im alten Basisprojekt ist das auch so) 432 432 * Das hat aber eine Reihe von Nachteilen 433 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 434 ** Es gibt eine Reihe von Sicherheitsproblemen 435 -* Besser isteintechnologieunabhängigeres Austauschformat.Im Basisprojektwird deshalbJSON verwendet.437 +* Besser: Definiere ein gemeinsames Austauschformat, was viele verstehen ~-~-> Im Basisprojekt (und in vielen anderen Projekten auch) JSON verwenden 436 436 * Insbesondere Web-Clients (JavaScript) bieten hervorragende Möglichkeiten, an JSON zu verarbeiten 437 437 * Client und Server haben sich damit auf Format für den Austausch geeinigt 438 438 ** Topic: Strings 439 439 ** Message: JSON 440 440 441 -A uchüberWebSocketswerden anClients nurgeeigneteDTOsübertragen; interne Serverobjektebleibenserverintern.443 +An den Clilent werden auch bei WebSockets nur DTOs verschickt! (userMapping) 442 442 443 443 [[image:1756891375095-158.png||height="266" width="775"]] 444 444 445 445 == Wie verbindet sich ein Client mit dem Server? == 446 446 447 - {{expandablesummary="TechnischeDetailszumVerbindungsaufbau"}}449 +UserService bietet eine Methode zum Login an. Diese ruft nun aber keine REST-Endpunkt auf (da man sich sowieso bei JEDEM Aufruf authentifizieren muss, macht so ein Endpunkt kein Sinn). Stattdessen wird die Verbindung mit dem WebSocket hergestellt und dort Nama und Passwort überprüft. 448 448 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. 450 - 451 451 [[image:1756891512330-186.png||height="170" width="820"]] 452 452 453 -=== Auf Client-Seite:WebSocketConnectionManager ===453 +=== Auf Server Seite (WebSocketConnectionManager): === 454 454 455 455 [[image:1756891551794-161.png||height="387" width="1019"]] 456 456 ... ... @@ -462,7 +462,7 @@ 462 462 463 463 4) Jackson als Mapper definieren (DTO-Object <-> JSON) 464 464 465 -[[image:1756891617399-232.png||height="289" width="1006"]] 465 +=== [[image:1756891617399-232.png||height="289" width="1006"]] === 466 466 467 467 468 468 1) Asynchron die Verbindung zum Server aufbauen ... ... @@ -472,6 +472,3 @@ 472 472 3) Über den Kontext ein Event pushen LoggedInEvent 473 473 474 474 4) Jede Serververbindung hat eine Session 475 -{{/expandable}} 476 - 477 -