Skip to Content

Changes for page Basisprojekt

Last modified by Marco Grawunder on 2026/09/08 10:20
From version 66.1
edited by Marco Grawunder
on 2026/09/08 10:20
Change comment: There is no comment for this version
To version 63.1
edited by Marco Grawunder
on 2026/08/25 15:36
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,11 +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 3  {{info}}
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.
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.
9 9  {{/info}}
10 10  
11 11  {{toc/}}
... ... @@ -35,7 +35,6 @@
35 35  
36 36  == Access Token ==
37 37  
38 -{{expandable summary="Schritt-für-Schritt: Access Token einrichten"}}
39 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 40  
41 41  [[image:1757398899497-714.png||height="246" width="278"]]
... ... @@ -54,11 +54,11 @@
54 54  
55 55  {{warning}}
56 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}}
52 +{{/warning}}
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}}
54 +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  
56 +
62 62  == Nach dem Klonen ==
63 63  
64 64  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
... ... @@ -106,7 +106,6 @@
106 106  
107 107  == Logging umstellen ==
108 108  
109 -{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
110 110  Wenn man möchte, kann man das Logging umstellen.
111 111  
112 112  [[image:1755246135109-325.png]]
... ... @@ -116,11 +116,9 @@
116 116  
117 117  
118 118  [[image:1755246162330-595.png]]
119 -{{/expandable}}
120 120  
121 121  == Development-Profil aktivieren ==
122 122  
123 -{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
124 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 125  
126 126  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
... ... @@ -137,7 +137,6 @@
137 137  [[image:1755248752596-839.png]]
138 138  
139 139  Danach muss man den Server neu starten!
140 -{{/expandable}}
141 141  
142 142  == Client starten ==
143 143  
... ... @@ -158,7 +158,6 @@
158 158  
159 159  === Mehrere Instanzen des Clients ermöglichen ===
160 160  
161 -{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
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]]
... ... @@ -167,8 +167,8 @@
167 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 168  
169 169  [[image:1755246292057-581.png]]
170 -{{/expandable}}
171 171  
161 +
172 172  = Überblick über das Basisprojekt =
173 173  
174 174  [[image:1755249096987-249.png]]
... ... @@ -194,10 +194,6 @@
194 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 195  {{/info}}
196 196  
197 -{{info}}
198 -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 -{{/info}}
200 -
201 201  [[image:1755250026156-269.png]]
202 202  
203 203  [[image:1755250050031-304.png]]
... ... @@ -247,7 +247,6 @@
247 247  
248 248  = Erweiterung der REST-Schnittstelle =
249 249  
250 -{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
251 251  In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
252 252  
253 253  In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
... ... @@ -367,8 +367,8 @@
367 367  [[image:1756890010118-149.png||height="116" width="972"]]
368 368  
369 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 -{{/expandable}}
371 371  
356 +
372 372  = Asynchrone Kommunikation zum Client: WebSockets =
373 373  
374 374  [[image:1756890800817-370.png||height="604" width="1121"]]
... ... @@ -415,6 +415,7 @@
415 415  * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
416 416  * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
417 417  
403 +
418 418  [[image:1756891125969-748.png||height="317" width="726"]]
419 419  
420 420  Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
... ... @@ -446,7 +446,6 @@
446 446  
447 447  == Wie verbindet sich ein Client mit dem Server? ==
448 448  
449 -{{expandable summary="Technische Details zum Verbindungsaufbau"}}
450 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 451  
452 452  [[image:1756891512330-186.png||height="170" width="820"]]
... ... @@ -473,10 +473,3 @@
473 473  3) Über den Kontext ein Event pushen LoggedInEvent
474 474  
475 475  4) Jede Serververbindung hat eine Session
476 -{{/expandable}}
477 -
478 -= Siehe auch =
479 -
480 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
481 -* [[Glossar>>doc:Main.Glossar.WebHome]]
482 -* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]