Skip to Content

Changes for page Basisprojekt

Last modified by Carl Welsch on 2026/10/23 16:19
From version 78.4
edited by Carl Welsch
on 2026/10/23 12:39
Change comment: Auto-saved during real-time collaboration
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
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cwelsch
1 +XWiki.mgrawunder
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,31 +35,18 @@
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 finden Sie in der Spalte links den Bereich **Access tokens**.
34 +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 -[[image:1792748594897-686.png||height="305" width="258"]]
36 +[[image:1757398899497-714.png||height="246" width="278"]]
42 42  
43 -Unter dem Bereich **Access** finden Sie den Unterbereich **Personal access token**.
38 +Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen.
44 44  
45 -[[image:1792748661578-664.png||height="594" width="259"]]
40 +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 46  
47 -Dort können Sie mit **Generate token** ein neues Token anlegen. Wählen Sie hier **Generate fine-grained token **aus.
42 +[[image:1757399088336-273.png||height="92" width="547"]]
48 48  
49 -[[image:1792749012547-899.png||height="77" width="637"]]
44 +Bei den Scopes sollten die beiden Rechte "read_repository" und "write_repository" gewählt werden.
50 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 63  Danach wird das Access Token generiert
64 64  
65 65  [[image:1757399184270-348.png||height="99" width="978"]]
... ... @@ -66,17 +66,11 @@
66 66  
67 67  {{warning}}
68 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 -{{/warning}}
52 +{{/warning}}
70 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.
72 -{{/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.
73 73  
74 -== SSH ==
75 75  
76 -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 80  == Nach dem Klonen ==
81 81  
82 82  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
... ... @@ -107,29 +107,6 @@
107 107  
108 108  [[image:1756886220468-891.png]]
109 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]]
132 -
133 133  == Server starten ==
134 134  
135 135  Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.
... ... @@ -147,7 +147,6 @@
147 147  
148 148  == Logging umstellen ==
149 149  
150 -{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
151 151  Wenn man möchte, kann man das Logging umstellen.
152 152  
153 153  [[image:1755246135109-325.png]]
... ... @@ -157,11 +157,9 @@
157 157  
158 158  
159 159  [[image:1755246162330-595.png]]
160 -{{/expandable}}
161 161  
162 162  == Development-Profil aktivieren ==
163 163  
164 -{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
165 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 166  
167 167  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
... ... @@ -178,7 +178,6 @@
178 178  [[image:1755248752596-839.png]]
179 179  
180 180  Danach muss man den Server neu starten!
181 -{{/expandable}}
182 182  
183 183  == Client starten ==
184 184  
... ... @@ -199,7 +199,6 @@
199 199  
200 200  === Mehrere Instanzen des Clients ermöglichen ===
201 201  
202 -{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
203 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 204  
205 205  [[image:1755246233218-893.png]]
... ... @@ -208,8 +208,8 @@
208 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 209  
210 210  [[image:1755246292057-581.png]]
211 -{{/expandable}}
212 212  
161 +
213 213  = Überblick über das Basisprojekt =
214 214  
215 215  [[image:1755249096987-249.png]]
... ... @@ -235,10 +235,6 @@
235 235  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.
236 236  {{/info}}
237 237  
238 -{{info}}
239 -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 -{{/info}}
241 -
242 242  [[image:1755250026156-269.png]]
243 243  
244 244  [[image:1755250050031-304.png]]
... ... @@ -288,7 +288,6 @@
288 288  
289 289  = Erweiterung der REST-Schnittstelle =
290 290  
291 -{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
292 292  In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
293 293  
294 294  In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
... ... @@ -408,8 +408,8 @@
408 408  [[image:1756890010118-149.png||height="116" width="972"]]
409 409  
410 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 -{{/expandable}}
412 412  
356 +
413 413  = Asynchrone Kommunikation zum Client: WebSockets =
414 414  
415 415  [[image:1756890800817-370.png||height="604" width="1121"]]
... ... @@ -456,6 +456,7 @@
456 456  * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
457 457  * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
458 458  
403 +
459 459  [[image:1756891125969-748.png||height="317" width="726"]]
460 460  
461 461  Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
... ... @@ -487,7 +487,6 @@
487 487  
488 488  == Wie verbindet sich ein Client mit dem Server? ==
489 489  
490 -{{expandable summary="Technische Details zum Verbindungsaufbau"}}
491 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 492  
493 493  [[image:1756891512330-186.png||height="170" width="820"]]
... ... @@ -514,13 +514,3 @@
514 514  3) Über den Kontext ein Event pushen LoggedInEvent
515 515  
516 516  4) Jede Serververbindung hat eine Session
517 -{{/expandable}}
518 -
519 -= Siehe auch =
520 -
521 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
522 -* [[Glossar>>doc:Main.Glossar.WebHome]]
523 -* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]
524 -* (((
525 -[[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
526 -)))
1792324965203-193.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.mgrawunder
Size
... ... @@ -1,1 +1,0 @@
1 -29.6 KB
Content
1792748594897-686.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -44.4 KB
Content
1792748661578-664.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -92.0 KB
Content
1792749012547-899.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -46.3 KB
Content
1792750917132-904.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -232.1 KB
Content
1792751165237-439.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -164.3 KB
Content
1792751550136-821.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -241.6 KB
Content
1792751732971-755.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.cwelsch
Size
... ... @@ -1,1 +1,0 @@
1 -144.2 KB
Content