Changes for page Basisprojekt
Last modified by Carl Welsch on 2026/10/23 16:19
From version 68.1
edited by Marco Grawunder
on 2026/10/18 14:02
on 2026/10/18 14:02
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)
-
Attachments (0 modified, 0 added, 1 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,13 +1,7 @@ 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 -**Worum geht es auf dieser Seite?** 3 +Hier folgen Erklärungen des neuen Basisprojekts. Es wird um die folgenden Themen gehen: 5 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. 9 -{{/info}} 10 - 11 11 {{toc/}} 12 12 13 13 ... ... @@ -15,11 +15,9 @@ 15 15 16 16 [[image:1755245956916-184.png]] 17 17 18 -== Repository klonen==12 +== Clone == 19 19 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}} 14 +Achtung! In dem Screenshot wird das globale Basisprojekt verwendet. Für jede Gruppe existiert bereits ein eigenes Repository, welches verwendet werden sollte, 23 23 24 24 Sie finden die Clone-URL wie folgt: 25 25 ... ... @@ -35,14 +35,13 @@ 35 35 36 36 == Access Token == 37 37 38 -{{expandable summary="Schritt-für-Schritt: Access Token einrichten"}} 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 anschließend **Access tokens**. 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. 40 40 41 41 [[image:1757398899497-714.png||height="246" width="278"]] 42 42 43 43 Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen. 44 44 45 -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. 46 46 47 47 [[image:1757399088336-273.png||height="92" width="547"]] 48 48 ... ... @@ -52,21 +52,13 @@ 52 52 53 53 [[image:1757399184270-348.png||height="99" width="978"]] 54 54 55 -{{warning}} 56 -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.** 57 -{{/warning}} 46 +Jetzt ist es wichtig, dass Sie sich das Token sichern! 58 58 59 -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. 60 -{{/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. 61 61 62 -== SSH == 63 63 64 - Hinweis:Man kann jetzt auchmit SSH clonen. Da gitlab aber hinter einemReverseproxyliegt, geht das nur mit der direkten Adresse des Host: vmisdata07.uni-oldenburg.de.Ist nun auch in Gitlab zu konfiguriert:51 +== Nach dem Clonen == 65 65 66 -[[image:1792324965203-193.png]] 67 - 68 -== Nach dem Klonen == 69 - 70 70 sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen: 71 71 72 72 [[image:1755245980026-164.png]] ... ... @@ -75,9 +75,10 @@ 75 75 76 76 [[image:1755245996886-733.png]] 77 77 78 -== Initialer Maven-Buildund Codegenerierung ==61 +== Initialer Build (Generierung) == 79 79 80 -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. 81 81 82 82 [[image:1755246008466-477.png]] 83 83 ... ... @@ -85,17 +85,17 @@ 85 85 [[image:1755246018789-616.png]] 86 86 87 87 88 -== Lombok -Plugin ==72 +== Lombok Plugin == 89 89 90 - Falls dasLombok-Pluginnoch nicht installiertist, installierenbzw. aktivierenSieesinIntelliJ.74 +**Lombok Plugin installiert? Wenn nein jetzt machen** 91 91 92 92 [[image:1755248508652-523.png]] 93 93 94 - 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 95 95 96 96 [[image:1756886220468-891.png]] 97 97 98 -== Server starten ==82 +== Server laufen lassen == 99 99 100 100 Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken. 101 101 ... ... @@ -102,7 +102,7 @@ 102 102 [[image:1755246035428-328.png]] 103 103 104 104 105 - 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. 106 106 107 107 [[image:1755246072443-191.png]] 108 108 ... ... @@ -112,7 +112,6 @@ 112 112 113 113 == Logging umstellen == 114 114 115 -{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}} 116 116 Wenn man möchte, kann man das Logging umstellen. 117 117 118 118 [[image:1755246135109-325.png]] ... ... @@ -122,12 +122,10 @@ 122 122 123 123 124 124 [[image:1755246162330-595.png]] 125 -{{/expandable}} 126 126 127 -== Development -Profil aktivieren ==109 +== Development Profil aktivieren == 128 128 129 -{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}} 130 -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. 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. 131 131 132 132 Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen: 133 133 ... ... @@ -136,7 +136,7 @@ 136 136 [[image:1755246173415-934.png]] 137 137 138 138 139 -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: ** 140 140 141 141 **SPRING_PROFILES_ACTIVE=dev** 142 142 ... ... @@ -143,15 +143,12 @@ 143 143 [[image:1755248752596-839.png]] 144 144 145 145 Danach muss man den Server neu starten! 146 -{{/expandable}} 147 147 148 148 == Client starten == 149 149 150 150 Wenn der Server gestartet ist, kann man mehrere Clients starten. Dafür auf jeden Fall die Klasse Main verwenden. 151 151 152 -{{warning}} 153 -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. 154 -{{/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!** 155 155 156 156 [[image:1755246257400-525.png]] 157 157 ... ... @@ -164,19 +164,18 @@ 164 164 165 165 === Mehrere Instanzen des Clients ermöglichen === 166 166 167 -{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}} 168 168 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. 169 169 170 170 [[image:1755246233218-893.png]] 171 171 172 172 173 - 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. 174 174 175 175 [[image:1755246292057-581.png]] 176 -{{/expandable}} 177 177 178 -= Überblick über das Basisprojekt = 179 179 155 += Kurzer Blick ins Basisprojekt = 156 + 180 180 [[image:1755249096987-249.png]] 181 181 182 182 ... ... @@ -183,27 +183,21 @@ 183 183 [[image:1755249136156-419.png]] 184 184 185 185 186 -== Projektstruktur==163 +== Screenshots == 187 187 188 188 [[image:1755249228556-469.png]] 189 189 190 190 191 -= Kommunikation vomClientzumServer:REST=168 += Kommunikation Client ~-~-> Server = 192 192 193 193 [[image:1755249285866-367.png]] 194 194 195 - 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 196 196 197 197 = OpenAPI = 198 198 199 -{{info}} 200 -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. 201 -{{/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) 202 202 203 -{{info}} 204 -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 205 -{{/info}} 206 - 207 207 [[image:1755250026156-269.png]] 208 208 209 209 [[image:1755250050031-304.png]] ... ... @@ -210,12 +210,12 @@ 210 210 211 211 * **Paths**: Endpunkte der API (z.B. /users, /lobbies). 212 212 * **Operations**: Spezifikation von Methoden wie GET, POST. 213 -* ** Schemas**: Beschreibungder DatenstrukturenfürEin- und Ausgaben.184 +* **Definitions**: Detaillierte Beschreibung von Eingabe- und Ausgabestrukturen. 214 214 * **Security**: Authentifizierungsmechanismen. 215 215 216 216 [[image:1755250061990-172.png]] 217 217 218 - 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 219 219 220 220 [[image:1755250157536-746.png]] 221 221 ... ... @@ -226,15 +226,15 @@ 226 226 227 227 = Maven und OpenAPI = 228 228 229 -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]] 230 230 231 - 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 () 232 232 233 233 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: 234 234 235 235 == Client == 236 236 237 -Im Java-Client wirdeinHTTP-Clientfür denZugriffauf die generierteAPIverwendet.208 +Im Client werden die Apache Http Bibliothek verwendet. 238 238 239 239 240 240 [[image:1756887005209-855.png]] ... ... @@ -241,24 +241,27 @@ 241 241 242 242 == Server == 243 243 244 - AufderServerseitewerdenSpring-/Spring-Boot-kompatibleSchnittstellenundController-Strukturen generiert.215 +Im Server wird Spring (Boot) verwendet 245 245 246 246 [[image:1756887037619-847.png]] 247 247 248 -{{info}} 249 -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]]. 250 -{{/info}} 219 +TODO: Weitere Informationen zu 251 251 221 +- Lombok 252 252 223 +- Dependency Injection 253 253 225 +- Spring (Boot), siehe auch [[https:~~/~~/www.marcobehler.com/guides/spring-framework>>https://www.marcobehler.com/guides/spring-framework]] 226 + 227 + 228 + 254 254 = Erweiterung der REST-Schnittstelle = 255 255 256 -{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}} 257 257 In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann. 258 258 259 259 In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen. 260 260 261 -== Schritt 1: OpenAPI-Dokument erweitern==235 +== Schritt 1: Erweitere das OpenAPI-Dokument == 262 262 263 263 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. 264 264 ... ... @@ -292,9 +292,9 @@ 292 292 293 293 Hinweis: Niemals Änderungen unterhalb des target-Ordners machen. Das wird von Maven bei clean gelöscht. 294 294 295 -=== Wo wirddieeigentliche Funktionalitätimplementiert? ===269 +=== Wie bekommt man dann aber nun die Funktionalität rein? === 296 296 297 -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: 298 298 299 299 * *Api (z.B, LobbiesApi): Beschreibung der REST-Methoden, vor allem auch das Mapping von z.B. /lobbies/join auf die Methode lobbyJoin(String) 300 300 * ((( ... ... @@ -301,7 +301,7 @@ 301 301 *ApiController implements *Api (Für Spring) (z.B. LobbiesApiController) 302 302 ))) 303 303 * ((( 304 -* `*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! 305 305 ))) 306 306 307 307 ... ... @@ -312,7 +312,7 @@ 312 312 313 313 [[image:1756888762381-912.png||height="48" width="789"]] 314 314 315 - 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). 316 316 317 317 In der Klasse muss man dann die neue Methode lobbyList aus der API überschreiben. 318 318 ... ... @@ -336,7 +336,7 @@ 336 336 337 337 === LobbyMapping === 338 338 339 -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!!) 340 340 341 341 Also z.B. 342 342 ... ... @@ -350,9 +350,7 @@ 350 350 351 351 == Schritt 3: Erweiterung auf Client-Seite (Java) == 352 352 353 -{{info}} 354 -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. 355 -{{/info}} 327 +Hinweis: Das Beispiel bezieht sich hier auf eine Client mit Java. Für andere Clients wie Angular ist das Vorgehen anders. 356 356 357 357 Auf der Client-Seite wird die komplette Kommunikation mit dem Server in der generierten Klasse DefaultApi gekapselt. 358 358 ... ... @@ -373,13 +373,13 @@ 373 373 [[image:1756890010118-149.png||height="116" width="972"]] 374 374 375 375 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. 376 -{{/expandable}} 377 377 378 -= Asynchrone Kommunikation zum Client: WebSockets = 379 379 350 += Kommunikation: Server ~-~-> Client (WebSockets) = 351 + 380 380 [[image:1756890800817-370.png||height="604" width="1121"]] 381 381 382 - 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. 383 383 384 384 Spring bietet eine native Unterstützung von WebSockets. Für eigene Funktionen kann man sich in die Kommunikation über die Serverklasse WebSocketHandler einklinken 385 385 ... ... @@ -406,25 +406,47 @@ 406 406 407 407 == STOMP == 408 408 409 -WebSocket stellteinenbidirektionalenKommunikationskanal bereit. Für einestrukturierte NachrichtenkommunikationverwendetdasBasisprojektdarüber **STOMP (Streaming TextOriented Messaging Protocol)**.381 +WebSockets haben kein Protokoll (wie z.B. http) 410 410 411 - 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!) 412 412 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) 413 413 414 - VeröffentlichtderServer eine Nachricht auf einemTopic,erhaltensie die dafürregistriertenClients. DiesesModell entsprichtdem **Publish/Subscribe-Pattern**.387 +STOMP: Streaming Text Oriented Messaging Protocol 415 415 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 + 416 416 [[https:~~/~~/docs.spring.io/spring-framework/reference/web/websocket/stomp.html>>url:https://docs.spring.io/spring-framework/reference/web/websocket/stomp.html]] 417 417 418 418 419 -Der Server definiert je nach fachlichem Bereichunterschiedliche Topics.Für das Nutzermanagementsindbeispielsweise vorgesehen:407 +§Der Server definiert unterschiedliche Topics (je nach Modul) 420 420 421 -* `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet. 422 -* `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt. 409 +§Beim Nutzermanagement aktuell: 423 423 411 +§/topic/users/loggedIn: Es hat sich ein neuer Nutzer angemeldet 412 + 413 +§/topic/users/loggedOut: Ein Nutzer hat sich ausgeloggt 414 + 415 + 424 424 [[image:1756891125969-748.png||height="317" width="726"]] 425 425 426 -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 427 427 420 +§In der Lobby würde es stattdessen /topic/lobbies/* heißen 421 + 428 428 == WebSockets: Versenden von Nachrichten == 429 429 430 430 [[image:1756891180516-843.png||height="426" width="801"]] ... ... @@ -436,28 +436,27 @@ 436 436 [[image:1756891254830-647.png||height="101" width="777"]] 437 437 438 438 * message kann grundsätzlich alles sein, was serialisiert werden kann 439 -* 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) 440 440 * Das hat aber eine Reihe von Nachteilen 441 441 ** 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 442 442 ** Es gibt eine Reihe von Sicherheitsproblemen 443 -* 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 444 444 * Insbesondere Web-Clients (JavaScript) bieten hervorragende Möglichkeiten, an JSON zu verarbeiten 445 445 * Client und Server haben sich damit auf Format für den Austausch geeinigt 446 446 ** Topic: Strings 447 447 ** Message: JSON 448 448 449 -A uchüberWebSocketswerden anClients nurgeeigneteDTOsübertragen; interne Serverobjektebleibenserverintern.443 +An den Clilent werden auch bei WebSockets nur DTOs verschickt! (userMapping) 450 450 451 451 [[image:1756891375095-158.png||height="266" width="775"]] 452 452 453 453 == Wie verbindet sich ein Client mit dem Server? == 454 454 455 -{{expandable summary="Technische Details zum Verbindungsaufbau"}} 456 -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. 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. 457 457 458 458 [[image:1756891512330-186.png||height="170" width="820"]] 459 459 460 -=== Auf Client-Seite:WebSocketConnectionManager ===453 +=== Auf Server Seite (WebSocketConnectionManager): === 461 461 462 462 [[image:1756891551794-161.png||height="387" width="1019"]] 463 463 ... ... @@ -469,7 +469,7 @@ 469 469 470 470 4) Jackson als Mapper definieren (DTO-Object <-> JSON) 471 471 472 -[[image:1756891617399-232.png||height="289" width="1006"]] 465 +=== [[image:1756891617399-232.png||height="289" width="1006"]] === 473 473 474 474 475 475 1) Asynchron die Verbindung zum Server aufbauen ... ... @@ -479,10 +479,3 @@ 479 479 3) Über den Kontext ein Event pushen LoggedInEvent 480 480 481 481 4) Jede Serververbindung hat eine Session 482 -{{/expandable}} 483 - 484 -= Siehe auch = 485 - 486 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]] 487 -* [[Glossar>>doc:Main.Glossar.WebHome]] 488 -* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]
- 1792324965203-193.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.mgrawunder - Size
-
... ... @@ -1,1 +1,0 @@ 1 -29.6 KB - Content