Skip to Content

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
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,17 +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  
62 -== SSH ==
63 63  
64 -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:
65 -
66 -[[image:1792324965203-193.png]]
67 -
68 68  == Nach dem Klonen ==
69 69  
70 70  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
... ... @@ -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,11 +122,9 @@
122 122  
123 123  
124 124  [[image:1755246162330-595.png]]
125 -{{/expandable}}
126 126  
127 127  == Development-Profil aktivieren ==
128 128  
129 -{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
130 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.
131 131  
132 132  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
... ... @@ -143,7 +143,6 @@
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  
... ... @@ -164,7 +164,6 @@
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]]
... ... @@ -173,8 +173,8 @@
173 173  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.
174 174  
175 175  [[image:1755246292057-581.png]]
176 -{{/expandable}}
177 177  
161 +
178 178  = Überblick über das Basisprojekt =
179 179  
180 180  [[image:1755249096987-249.png]]
... ... @@ -200,10 +200,6 @@
200 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 201  {{/info}}
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]]
... ... @@ -253,7 +253,6 @@
253 253  
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.
... ... @@ -373,8 +373,8 @@
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  
356 +
378 378  = Asynchrone Kommunikation zum Client: WebSockets =
379 379  
380 380  [[image:1756890800817-370.png||height="604" width="1121"]]
... ... @@ -421,6 +421,7 @@
421 421  * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
422 422  * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
423 423  
403 +
424 424  [[image:1756891125969-748.png||height="317" width="726"]]
425 425  
426 426  Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
... ... @@ -452,7 +452,6 @@
452 452  
453 453  == Wie verbindet sich ein Client mit dem Server? ==
454 454  
455 -{{expandable summary="Technische Details zum Verbindungsaufbau"}}
456 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.
457 457  
458 458  [[image:1756891512330-186.png||height="170" width="820"]]
... ... @@ -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