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 anschließend **Access tokens**.

40

41

[[image:1757398899497-714.png||height="246" width="278"]]

42

43

Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen.

44

45

Als Namen kann z. B. `IntelliJ` verwendet werden. Access Tokens sind aus Sicherheitsgründen zeitlich begrenzt. Wählen Sie ein Ablaufdatum, das zum Projektzeitraum passt.

46

47

[[image:1757399088336-273.png||height="92" width="547"]]

48

49

Bei den Scopes sollten die beiden Rechte "read_repository" und "write_repository" gewählt werden.

50

51

Danach wird das Access Token generiert

52

53

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

54

55

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

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

61

62

== Nach dem Klonen ==

63

64

sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:

65

66

[[image:1755245980026-164.png]]

67

68

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

69

70

[[image:1755245996886-733.png]]

71

72

== Initialer Maven-Build und Codegenerierung ==

73

74

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.

75

76

[[image:1755246008466-477.png]]

77

78

79

[[image:1755246018789-616.png]]

== Lombok-Plugin ==

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

85

86

[[image:1755248508652-523.png]]

87

88

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

89

90

[[image:1756886220468-891.png]]

== Server starten ==

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

95

96

[[image:1755246035428-328.png]]

97

98

99

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.

100

101

[[image:1755246072443-191.png]]

102

103

104

[[image:1755246118807-452.png]]

105

106

107

== Logging umstellen ==

108

109

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

110

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

111

112

[[image:1755246135109-325.png]]

113

114

115

[[image:1755246147827-679.png]]

116

117

118

[[image:1755246162330-595.png]]

119

120

121

== Development-Profil aktivieren ==

122

123

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

124

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.

125

126

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

127

128

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

129

130

[[image:1755246173415-934.png]]

131

132

133

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

134

135

**SPRING_PROFILES_ACTIVE=dev**

136

137

[[image:1755248752596-839.png]]

138

139

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.

145

146

147

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.

148

149

150

[[image:1755246257400-525.png]]

151

152

153

[[image:1755246212916-883.png]]

154

155

156

[[image:1755246223246-834.png]]

157

158

159

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

160

161

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

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

164

[[image:1755246233218-893.png]]

165

166

167

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.

168

169

[[image:1755246292057-581.png]]

170

171

172

= Überblick über das Basisprojekt =

173

174

[[image:1755249096987-249.png]]

175

176

177

[[image:1755249136156-419.png]]

178

179

180

== Projektstruktur ==

181

182

[[image:1755249228556-469.png]]

183

184

185

= Kommunikation vom Client zum Server: REST =

186

187

[[image:1755249285866-367.png]]

188

189

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

199

200

201

[[image:1755250026156-269.png]]

202

203

[[image:1755250050031-304.png]]

204

205

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

206

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

207

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

208

* **Security**: Authentifizierungsmechanismen.

209

210

[[image:1755250061990-172.png]]

211

212

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.

213

214

[[image:1755250157536-746.png]]

215

216

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

217

218

Dort wird die Datei auch grafisch dargestellt.

219

220

221

= Maven und OpenAPI =

222

223

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

224

225

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

226

227

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.

232

233

234

[[image:1756887005209-855.png]]

== Server ==

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

239

240

[[image:1756887037619-847.png]]

241

242

243

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 =

249

250

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

251

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

252

253

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

254

255

== Schritt 1: OpenAPI-Dokument erweitern ==

256

257

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.

258

259

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

260

261

Im folgenden Bild sind alle Anpassungen zu sehen:

262

263

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

264

265

266

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

267

268

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

269

270

271

Jetzt kann man entweder in IntelliJ

272

273

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

274

275

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

276

277

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

278

279

Wobei hier auch clean compile reichen würde.

280

281

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

282

283

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

284

285

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

286

287

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

288

289

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

290

291

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

292

293

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

294

* (((

295

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

296

)))

297

* (((

298

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

)))

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

304

305

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

306

307

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

308

309

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.

310

311

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

312

313

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

314

315

Dabei wird folgendes gemacht:

316

317

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

318

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

319

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

320

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

321

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

322

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

323

324

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

325

326

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

327

328

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

338

339

und definiert ein Interface mit einer Annotation

340

341

[[image:1756889472103-847.png]]

342

343

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

344

345

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

346

347

348

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.

349

350

351

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

352

353

[[image:1756889795622-530.png]]

354

355

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

356

357

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

358

359

[[image:1756889917681-650.png]]

360

361

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

362

363

[[image:1756889979252-910.png]]

364

365

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

366

367

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

368

369

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.

370

371

372

= Asynchrone Kommunikation zum Client: WebSockets =

373

374

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

375

376

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.

377

378

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

379

380

381

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

382

383

384

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

385

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

386

387

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

388

389

Die Methode ist Observer für das Event SessionConnectedEvent

390

391

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

392

393

[[image:1756891019715-621.png]]

394

395

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

396

397

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

398

399

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

404

405

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.

406

407

408

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

409

410

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

411

412

413

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

414

415

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

416

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

417

418

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

419

420

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

421

422

== WebSockets: Versenden von Nachrichten ==

423

424

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

425

426

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

427

428

== Nachrichteninhalt ==

429

430

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

431

432

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

433

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

434

* Das hat aber eine Reihe von Nachteilen

435

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

436

** Es gibt eine Reihe von Sicherheitsproblemen

437

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

438

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

439

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

444

445

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

446

447

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

448

449

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

450

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.

451

452

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

453

454

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

455

456

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

457

458

1) Variablen definieren