Basisprojekt - XWiki des Softwarelabors der Informatik in der Universität Oldenburg

1

[[image:Main.Organisatorisches.WebHome@softwareprojekt_logo_transparent.png||alt="SoftwareprojektLogo.png" data-xwiki-image-style-alignment="end" height="136" width="309"]]

2

3

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.

= Basisprojekt mit IntelliJ einrichten =

15

16

[[image:1755245956916-184.png]]

17

18

== Repository klonen ==

19

20

21

Im Screenshot wird teilweise das globale Basisprojekt gezeigt. **Verwenden Sie für die Arbeit das bereits für Ihre Gruppe angelegte Repository.**

22

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]]

== Access Token ==

{{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 finden Sie in der Spalte links den Bereich **Access tokens**.

40

41

[[image:1792748594897-686.png||height="305" width="258"]]

42

43

Unter dem Bereich **Access** finden Sie den Unterbereich **Personal access token**.

44

45

[[image:1792748661578-664.png||height="594" width="259"]]

46

47

Dort können Sie mit **Generate token** ein neues Token anlegen. Wählen Sie hier **Generate fine-grained token **aus.

48

49

[[image:1792749012547-899.png||height="77" width="637"]]

50

51

Als Namen für den Token kann z. B. `IntelliJ` verwendet werden. Außerdem muss eine Beschreibung für den Token angelegt werden, wie bspw. "SWP Laptop Verbindung", welcher später zur Identifizierung des Tokes dient. Access Tokens sind aus Sicherheitsgründen zeitlich begrenzt. Wählen Sie ein Ablaufdatum, das zum Projektzeitraum passt. Anschließend wählen Sie unter **Group and project access **den Punkt **Only specific groups or projects I have access to** und wählen Ihre SWP-Gruppe aus.

52

53

[[image:1792751550136-821.png||height="567" width="638"]]

54

55

Bei **Resource access** sollten unter **Repository** "Code" und "Repository" gewählt werden.

56

57

[[image:1792751165237-439.png||height="568" width="369"]]

58

59

Anschließend müssen Sie bei den Permissions setzen. Dafür wählen Sie bei Code "Download", Push und Read. Für Repository wählen Sie Create

60

61

[[image:1792751732971-755.png||height="471" width="610"]]

62

63

Danach wird das Access Token generiert

64

65

[[image:1757399184270-348.png||height="99" width="978"]]

66

67

68

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.**

69

70

71

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.

== SSH ==

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:

77

78

[[image:1792324965203-193.png]]

79

80

== Nach dem Klonen ==

81

82

sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:

83

84

[[image:1755245980026-164.png]]

85

86

Auf dem main-Branch (master) kann keine Änderung gemacht werden, deswegen muss auf einen anderen Branch gewechselt werden. Im Beispiel development.

87

88

[[image:1755245996886-733.png]]

89

90

== Initialer Maven-Build und Codegenerierung ==

91

92

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.

93

94

[[image:1755246008466-477.png]]

95

96

97

[[image:1755246018789-616.png]]

== Lombok-Plugin ==

Falls das Lombok-Plugin noch nicht installiert ist, installieren bzw. aktivieren Sie es in IntelliJ.

103

104

[[image:1755248508652-523.png]]

105

106

Je nach IntelliJ-Edition kann zusätzlich das Spring-/Spring-Boot-Plugin hilfreich sein.

107

108

[[image:1756886220468-891.png]]

109

110

== Probleme mit Maven oder IntelliJ ==

111

112

Falls IntelliJ nach dem Klonen des Repositories nicht alle Abhängigkeiten oder Klassen erkennt, überprüfen Sie bitte folgende Punkte:

113

114

1. **Java-Version:** Das Basisprojekt benötigt mindestens Java 21. Kontrollieren Sie mit java -version und mvn -version, welche Versionen verwendet werden.

115

1. **IntelliJ-Projekt:** Öffnen Sie das gesamte Projekt mit der übergeordneten pom.xml, nicht nur das Server- oder Client-Verzeichnis.

116

1. **Maven-Konfiguration:** Überprüfen Sie unter //Settings → Build Tools → Maven//, ob Maven mit einem passenden JDK ausgeführt wird.

117

1. **Maven aktualisieren:** Öffnen Sie das Maven-Toolfenster und wählen Sie //Reload All Maven Projects//.

118

1. (((

119

**Projekt bauen:** Öffnen Sie ein Terminal im Hauptverzeichnis des Projekts und führen Sie folgenden Befehl aus:

120

121

mvn -U clean install -DskipTests

122

)))

123

1. **Generierte Klassen:** Stellen Sie sicher, dass die durch OpenAPI generierten Java-Klassen unter target/generated-sources vorhanden sind und von IntelliJ erkannt werden.

124

1. **Lombok:** Prüfen Sie, ob das Lombok-Plugin aktiviert ist und Annotation Processing korrekt funktioniert.

125

1. **Server starten:** Starten Sie die Klasse ServerApp im Server-Modul. Überprüfen Sie bei Problemen die Java-Version und die Startkonfiguration.

126

127

**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.

128

129

Man kann auch versuchen, die Caches von IntelliJ einmal zu löschen: File → Invalidate Caches → Invalidate and Restart

130

131

Falls es immer noch Problem gibt: Es gibt eine erweiterte Checkliste: [[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]

== Server starten ==

Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.

136

137

[[image:1755246035428-328.png]]

138

139

140

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.

141

142

[[image:1755246072443-191.png]]

143

144

145

[[image:1755246118807-452.png]]

146

147

148

== Logging umstellen ==

149

150

{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}

151

Wenn man möchte, kann man das Logging umstellen.

152

153

[[image:1755246135109-325.png]]

154

155

156

[[image:1755246147827-679.png]]

157

158

159

[[image:1755246162330-595.png]]

160

161

162

== Development-Profil aktivieren ==

163

164

{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}

165

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.

166

167

Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:

168

169

[[image:1757399848941-253.png||height="209" width="558"]]

170

171

[[image:1755246173415-934.png]]

172

173

174

Wenn die verwendete IntelliJ-Version keine Spring-Unterstützung bietet, kann das Profil über eine Umgebungsvariable in der Server-Konfiguration gesetzt werden:

175

176

**SPRING_PROFILES_ACTIVE=dev**

177

178

[[image:1755248752596-839.png]]

179

180

Danach muss man den Server neu starten!

== Client starten ==

Wenn der Server gestartet ist, kann man mehrere Clients starten. Dafür auf jeden Fall die Klasse Main verwenden.

186

187

188

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.

189

190

191

[[image:1755246257400-525.png]]

192

193

194

[[image:1755246212916-883.png]]

195

196

197

[[image:1755246223246-834.png]]

198

199

200

=== Mehrere Instanzen des Clients ermöglichen ===

201

202

{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}

203

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.

204

205

[[image:1755246233218-893.png]]

206

207

208

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.

209

210

[[image:1755246292057-581.png]]

211

212

213

= Überblick über das Basisprojekt =

214

215

[[image:1755249096987-249.png]]

216

217

218

[[image:1755249136156-419.png]]

219

220

221

== Projektstruktur ==

222

223

[[image:1755249228556-469.png]]

224

225

226

= Kommunikation vom Client zum Server: REST =

227

228

[[image:1755249285866-367.png]]

229

230

Für klassische Request/Response-Operationen verwendet das Basisprojekt **REST über HTTP**. Als Austauschformat wird **JSON** verwendet. Die zentrale Spiellogik verbleibt auf dem Server.

= OpenAPI =

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.

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

240

241

242

[[image:1755250026156-269.png]]

243

244

[[image:1755250050031-304.png]]

245

246

* **Paths**: Endpunkte der API (z.B. /users, /lobbies).

247

* **Operations**: Spezifikation von Methoden wie GET, POST.

248

* **Schemas**: Beschreibung der Datenstrukturen für Ein- und Ausgaben.

249

* **Security**: Authentifizierungsmechanismen.

250

251

[[image:1755250061990-172.png]]

252

253

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.

254

255

[[image:1755250157536-746.png]]

256

257

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]]

258

259

Dort wird die Datei auch grafisch dargestellt.

260

261

262

= Maven und OpenAPI =

263

264

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]]

265

266

Die Generierung kann über die Kommandozeile erfolgen; im Basisprojekt ist sie bereits in den Maven-Build integriert.

267

268

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:

== Client ==

Im Java-Client wird ein HTTP-Client für den Zugriff auf die generierte API verwendet.

273

274

275

[[image:1756887005209-855.png]]

== Server ==

Auf der Serverseite werden Spring-/Spring-Boot-kompatible Schnittstellen und Controller-Strukturen generiert.

280

281

[[image:1756887037619-847.png]]

282

283

284

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]].

= Erweiterung der REST-Schnittstelle =

290

291

{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}

292

In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.

293

294

In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.

295

296

== Schritt 1: OpenAPI-Dokument erweitern ==

297

298

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.

299

300

Die Funktion soll sehr einfach sein und keine Parameter verlangen. Dafür bietet sich die GET-Funktion an.

301

302

Im folgenden Bild sind alle Anpassungen zu sehen:

303

304

[[image:1756887436525-790.png||height="355" width="974"]]

305

306

307

Nach dem Speichern, sollte das OpenAPI-Dokument wie folgt aussehen

308

309

[[image:1756887488020-376.png||height="642" width="904"]]

310

311

312

Jetzt kann man entweder in IntelliJ

313

314

[[image:1756888245896-845.png||height="347" width="620"]]

315

316

oder im Terminal (z.B. auch in IntelliJ)

317

318

[[image:1756888279902-777.png||height="637" width="1053"]]

319

320

Wobei hier auch clean compile reichen würde.

321

322

**ACHTUNG! Falls maven Problem macht, kann das auch an einer falschen Java-Version im System liegen (siehe auch [[FAQ>>doc:.Basisprojekt FAQ.WebHome]])**

323

324

Es werden durch den Aufruf neue Inhalte generiert (bzw. die alten überschrieben).

325

326

[[image:1756888428042-802.png||height="538" width="1077"]]

327

328

Hinweis: Niemals Änderungen unterhalb des target-Ordners machen. Das wird von Maven bei clean gelöscht.

329

330

=== Wo wird die eigentliche Funktionalität implementiert? ===

331

332

Für jeden API-Bereich (z. B. `lobbies` und `users`) werden serverseitig typischerweise mehrere Schnittstellen bzw. Klassen generiert:

333

334

* *Api (z.B, LobbiesApi): Beschreibung der REST-Methoden, vor allem auch das Mapping von z.B. /lobbies/join auf die Methode lobbyJoin(String)

335

* (((

336

*ApiController implements *Api (Für Spring) (z.B. LobbiesApiController)

337

)))

338

* (((

339

* `*ApiDelegate` (z. B. `LobbiesApiDelegate`): Delegationsschnittstelle. Die fachliche Implementierung erfolgt **im eigenen, nicht generierten Code**.

)))

== Schritt 2: Erweiterung auf Server-Seite ==

345

346

Da es schon Funktionen für die Lobbies gibt, gibt es auch bereits eine Implementierung, die LobbiesApiDelegate überschreibt

347

348

[[image:1756888762381-912.png||height="48" width="789"]]

349

350

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.

351

352

In der Klasse muss man dann die neue Methode lobbyList aus der API überschreiben.

353

354

[[image:1756888929507-312.png||height="156" width="1161"]]

355

356

Dabei wird folgendes gemacht:

357

358

1. Es wird ein Rückgabeobjekt vom Typ Liste erzeugt

359

1. Es wird über alles Lobbies auf dem Server gegangen (lobbyManagement.getLobbies())

360

1. Da der Client u.U. nicht die vollständigen Informationen über die Lobbies bekommen soll, gibt es zwei unterschiedliche Klassen: ServerLobby und LobbyDTO.

361

1. Die Foreach-Schleife sorgt dafür, dass in das Rückgabeobjekt nur die LobbyDTOs eingefügt werden.

362

1. Dafür wird eine Funktion mit dem Namen lobbyMapping verwendet

363

1. Schließlich wird am Ende gesagt, dass alles ok ist und eine Antwort ResponseEntity.ok mit dem Rückgabeobjekt (lobbies) gesendet.

364

365

**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

366

367

Auf Server-Seite fehlt jetzt noch die Methode getLobbies im LobbyManagement

368

369

[[image:1756889590500-656.png||height="81" width="518"]]

=== LobbyMapping ===

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.

Also z.B.

[[image:1756889440395-856.png]]

379

380

und definiert ein Interface mit einer Annotation

381

382

[[image:1756889472103-847.png]]

383

384

und damit kann man die Funktion aufrufen. Hinweis: Der Mapper ist im LobbyService über die Spring Dependency Injection gebunden.

385

386

== Schritt 3: Erweiterung auf Client-Seite (Java) ==

387

388

389

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.

390

391

392

Auf der Client-Seite wird die komplette Kommunikation mit dem Server in der generierten Klasse DefaultApi gekapselt.

393

394

[[image:1756889795622-530.png]]

395

396

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

397

398

Im Client gibt es auch eine Klasse LobbyService. Dort ist die DefaultApi Klasse über Dependency Injection gebunden.

399

400

[[image:1756889917681-650.png]]

401

402

Dort kann man nun eine neue Methode getLobbies() integrieren:

403

404

[[image:1756889979252-910.png]]

405

406

Und das Ganze dann z.B. im MainMenuPresenter verwenden:

407

408

[[image:1756890010118-149.png||height="116" width="972"]]

409

410

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.

411

412

413

= Asynchrone Kommunikation zum Client: WebSockets =

414

415

[[image:1756890800817-370.png||height="604" width="1121"]]

416

417

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.

418

419

Spring bietet eine native Unterstützung von WebSockets. Für eigene Funktionen kann man sich in die Kommunikation über die Serverklasse WebSocketHandler einklinken

420

421

422

[[image:1756890924024-346.png||height="377" width="1092"]]

423

424

425

Sobald sich jemand beim Server für WebSockets angemeldet hat wird von Spring ein org.springframework.web.socket.messaging.SessionConnectedEvent

426

geworfen, welches in der folgenden Methode (im WebSocketHandler) aufgefangen wird

427

428

[[image:1756890958794-603.png||height="373" width="1087"]]

429

430

Die Methode ist Observer für das Event SessionConnectedEvent

431

432

Der WebSocketServer kennt die Nutzer und erlaubt das Einloggen nur, wenn Login und Passwort stimmen (durch Spring Security)

433

434

[[image:1756891019715-621.png]]

435

436

1)Aus dem Event kann der Nutzer gelesen werden (der sollte nie leer sein)

437

438

2) Dann wird sich aus dem Repository (später mehr) der Nutzer geholt, der durch den Namen identifiziert ist (z.B. „test1“)

439

440

3) Schließlich werden allen anderen darüber informiert, dass ein neuer Nutzer da ist

== STOMP ==

WebSocket stellt einen bidirektionalen Kommunikationskanal bereit. Für eine strukturierte Nachrichtenkommunikation verwendet das Basisprojekt darüber **STOMP (Streaming Text Oriented Messaging Protocol)**.

445

446

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.

447

448

449

Veröffentlicht der Server eine Nachricht auf einem Topic, erhalten sie die dafür registrierten Clients. Dieses Modell entspricht dem **Publish/Subscribe-Pattern**.

450

451

[[https:~~/~~/docs.spring.io/spring-framework/reference/web/websocket/stomp.html>>url:https://docs.spring.io/spring-framework/reference/web/websocket/stomp.html]]

452

453

454

Der Server definiert je nach fachlichem Bereich unterschiedliche Topics. Für das Nutzermanagement sind beispielsweise vorgesehen:

455

456

* `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.

457

* `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.

458

459

[[image:1756891125969-748.png||height="317" width="726"]]

460

461

Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.

462

463

== WebSockets: Versenden von Nachrichten ==

464

465

[[image:1756891180516-843.png||height="426" width="801"]]

466

467

[[image:1756891216134-578.png||height="428" width="699"]]

468

469

== Nachrichteninhalt ==

470

471

[[image:1756891254830-647.png||height="101" width="777"]]

472

473

* message kann grundsätzlich alles sein, was serialisiert werden kann

474

* Technisch könnte Java-Serialisierung verwendet werden; das alte Basisprojekt hat dies teilweise getan.

475

* Das hat aber eine Reihe von Nachteilen

476

** 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

477

** Es gibt eine Reihe von Sicherheitsproblemen

478

* Besser ist ein technologieunabhängigeres Austauschformat. Im Basisprojekt wird deshalb JSON verwendet.

479

* Insbesondere Web-Clients (JavaScript) bieten hervorragende Möglichkeiten, an JSON zu verarbeiten

480

* Client und Server haben sich damit auf Format für den Austausch geeinigt

** Topic: Strings

** Message: JSON

Auch über WebSockets werden an Clients nur geeignete DTOs übertragen; interne Serverobjekte bleiben serverintern.

485

486

[[image:1756891375095-158.png||height="266" width="775"]]

487

488

== Wie verbindet sich ein Client mit dem Server? ==

489

490

{{expandable summary="Technische Details zum Verbindungsaufbau"}}

491

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.

492

493

[[image:1756891512330-186.png||height="170" width="820"]]

494

495

=== Auf Client-Seite: WebSocketConnectionManager ===

496

497

[[image:1756891551794-161.png||height="387" width="1019"]]

498

499

1) Variablen definieren