Skip to Content

Changes for page Basisprojekt

Last modified by Carl Welsch on 2026/10/23 16:19
From version 75.1
edited by Carl Welsch
on 2026/10/23 12:21
Change comment: Uploaded new attachment "1792750917132-904.png", version {1}
To version 64.1
edited by Marco Grawunder
on 2026/08/25 16:31
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/}}
... ... @@ -36,20 +36,15 @@
36 36  == Access Token ==
37 37  
38 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**.
40 40  
41 -[[image:1792748594897-686.png||height="305" width="258"]]
36 +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**.
42 42  
43 -Unter dem Bereich **Access** finden Sie den Unterbereich **Personal access token**.
38 +[[image:1757398899497-714.png||height="246" width="278"]]
44 44  
45 -[[image:1792748661578-664.png||height="594" width="259"]]
40 +Dort können Sie mit [[image:1757398947128-748.png||height="89" width="197"]] ein neues Token anlegen.
46 46  
47 -Dort können Sie mit **Generate token** ein neues Token anlegen. Wählen Sie hier **Generate fine-grained token **aus.
42 +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.
48 48  
49 -[[image:1792749012547-899.png||height="77" width="637"]]
50 -
51 -Als Namen für den Token kann z. B. `IntelliJ` verwendet werden. Access Tokens sind aus Sicherheitsgründen zeitlich begrenzt. Wählen Sie ein Ablaufdatum, das zum Projektzeitraum passt.
52 -
53 53  [[image:1757399088336-273.png||height="92" width="547"]]
54 54  
55 55  Bei den Scopes sollten die beiden Rechte "read_repository" und "write_repository" gewählt werden.
... ... @@ -60,17 +60,11 @@
60 60  
61 61  {{warning}}
62 62  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.**
63 -{{/warning}}
54 +{{/warning}}
64 64  
65 65  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.
66 66  {{/expandable}}
67 67  
68 -== SSH ==
69 -
70 -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:
71 -
72 -[[image:1792324965203-193.png]]
73 -
74 74  == Nach dem Klonen ==
75 75  
76 76  sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
... ... @@ -101,29 +101,6 @@
101 101  
102 102  [[image:1756886220468-891.png]]
103 103  
104 -== Probleme mit Maven oder IntelliJ ==
105 -
106 -Falls IntelliJ nach dem Klonen des Repositories nicht alle Abhängigkeiten oder Klassen erkennt, überprüfen Sie bitte folgende Punkte:
107 -
108 -1. **Java-Version:** Das Basisprojekt benötigt mindestens Java 21. Kontrollieren Sie mit java -version und mvn -version, welche Versionen verwendet werden.
109 -1. **IntelliJ-Projekt:** Öffnen Sie das gesamte Projekt mit der übergeordneten pom.xml, nicht nur das Server- oder Client-Verzeichnis.
110 -1. **Maven-Konfiguration:** Überprüfen Sie unter //Settings → Build Tools → Maven//, ob Maven mit einem passenden JDK ausgeführt wird.
111 -1. **Maven aktualisieren:** Öffnen Sie das Maven-Toolfenster und wählen Sie //Reload All Maven Projects//.
112 -1. (((
113 -**Projekt bauen:** Öffnen Sie ein Terminal im Hauptverzeichnis des Projekts und führen Sie folgenden Befehl aus:
114 -
115 -mvn -U clean install -DskipTests
116 -)))
117 -1. **Generierte Klassen:** Stellen Sie sicher, dass die durch OpenAPI generierten Java-Klassen unter target/generated-sources vorhanden sind und von IntelliJ erkannt werden.
118 -1. **Lombok:** Prüfen Sie, ob das Lombok-Plugin aktiviert ist und Annotation Processing korrekt funktioniert.
119 -1. **Server starten:** Starten Sie die Klasse ServerApp im Server-Modul. Überprüfen Sie bei Problemen die Java-Version und die Startkonfiguration.
120 -
121 -**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.
122 -
123 -Man kann auch versuchen, die Caches von IntelliJ einmal zu löschen: File → Invalidate Caches → Invalidate and Restart
124 -
125 -Falls es immer noch Problem gibt: Es gibt eine erweiterte Checkliste: [[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
126 -
127 127  == Server starten ==
128 128  
129 129  Den Serverbereich aufklappen und dort auf die Datei ServerApp mit der rechten Maustaste klicken.
... ... @@ -142,6 +142,7 @@
142 142  == Logging umstellen ==
143 143  
144 144  {{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
107 +
145 145  Wenn man möchte, kann man das Logging umstellen.
146 146  
147 147  [[image:1755246135109-325.png]]
... ... @@ -156,6 +156,7 @@
156 156  == Development-Profil aktivieren ==
157 157  
158 158  {{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
122 +
159 159  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.
160 160  
161 161  Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
... ... @@ -194,6 +194,7 @@
194 194  === Mehrere Instanzen des Clients ermöglichen ===
195 195  
196 196  {{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
161 +
197 197  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.
198 198  
199 199  [[image:1755246233218-893.png]]
... ... @@ -229,10 +229,6 @@
229 229  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.
230 230  {{/info}}
231 231  
232 -{{info}}
233 -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
234 -{{/info}}
235 -
236 236  [[image:1755250026156-269.png]]
237 237  
238 238  [[image:1755250050031-304.png]]
... ... @@ -283,6 +283,7 @@
283 283  = Erweiterung der REST-Schnittstelle =
284 284  
285 285  {{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
247 +
286 286  In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
287 287  
288 288  In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
... ... @@ -450,6 +450,7 @@
450 450  * `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
451 451  * `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
452 452  
415 +
453 453  [[image:1756891125969-748.png||height="317" width="726"]]
454 454  
455 455  Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
... ... @@ -482,6 +482,7 @@
482 482  == Wie verbindet sich ein Client mit dem Server? ==
483 483  
484 484  {{expandable summary="Technische Details zum Verbindungsaufbau"}}
448 +
485 485  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.
486 486  
487 487  [[image:1756891512330-186.png||height="170" width="820"]]
... ... @@ -510,11 +510,4 @@
510 510  4) Jede Serververbindung hat eine Session
511 511  {{/expandable}}
512 512  
513 -= Siehe auch =
514 514  
515 -* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
516 -* [[Glossar>>doc:Main.Glossar.WebHome]]
517 -* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]
518 -* (((
519 -[[Basisprojekt Checkliste>>doc:.Basisprojekt Checkliste.WebHome]]
520 -)))
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