Changes for page Basisprojekt

Summary

• Page properties (1 modified, 0 added, 0 removed)

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,15 +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	66	== Nach dem Klonen ==
67	67
68	68	sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
...	...	@@ -110,7 +110,6 @@
110	110
111	111	== Logging umstellen ==
112	112
113		-{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
114	114	Wenn man möchte, kann man das Logging umstellen.
115	115
116	116	[[image:1755246135109-325.png]]
...	...	@@ -120,11 +120,9 @@
120	120
121	121
122	122	[[image:1755246162330-595.png]]
123		-{{/expandable}}
124	124
125	125	== Development-Profil aktivieren ==
126	126
127		-{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
128	128	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.
129	129
130	130	Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
...	...	@@ -141,7 +141,6 @@
141	141	[[image:1755248752596-839.png]]
142	142
143	143	Danach muss man den Server neu starten!
144		-{{/expandable}}
145	145
146	146	== Client starten ==
147	147
...	...	@@ -162,7 +162,6 @@
162	162
163	163	=== Mehrere Instanzen des Clients ermöglichen ===
164	164
165		-{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
166	166	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.
167	167
168	168	[[image:1755246233218-893.png]]
...	...	@@ -171,8 +171,8 @@
171	171	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.
172	172
173	173	[[image:1755246292057-581.png]]
174		-{{/expandable}}
175	175
	161	+
176	176	= Überblick über das Basisprojekt =
177	177
178	178	[[image:1755249096987-249.png]]
...	...	@@ -198,10 +198,6 @@
198	198	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.
199	199	{{/info}}
200	200
201		-{{info}}
202		-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
203		-{{/info}}
204		-
205	205	[[image:1755250026156-269.png]]
206	206
207	207	[[image:1755250050031-304.png]]
...	...	@@ -251,7 +251,6 @@
251	251
252	252	= Erweiterung der REST-Schnittstelle =
253	253
254		-{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
255	255	In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
256	256
257	257	In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
...	...	@@ -371,8 +371,8 @@
371	371	[[image:1756890010118-149.png||height="116" width="972"]]
372	372
373	373	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.
374		-{{/expandable}}
375	375
	356	+
376	376	= Asynchrone Kommunikation zum Client: WebSockets =
377	377
378	378	[[image:1756890800817-370.png||height="604" width="1121"]]
...	...	@@ -419,6 +419,7 @@
419	419	* `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
420	420	* `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
421	421
	403	+
422	422	[[image:1756891125969-748.png||height="317" width="726"]]
423	423
424	424	Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
...	...	@@ -450,7 +450,6 @@
450	450
451	451	== Wie verbindet sich ein Client mit dem Server? ==
452	452
453		-{{expandable summary="Technische Details zum Verbindungsaufbau"}}
454	454	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.
455	455
456	456	[[image:1756891512330-186.png||height="170" width="820"]]
...	...	@@ -477,10 +477,3 @@
477	477	3) Über den Kontext ein Event pushen LoggedInEvent
478	478
479	479	4) Jede Serververbindung hat eine Session
480		-{{/expandable}}
481		-
482		-= Siehe auch =
483		-
484		-* [[Stichwortverzeichnis>>doc:Main.Index.WebHome]]
485		-* [[Glossar>>doc:Main.Glossar.WebHome]]
486		-* [[Basisprojekt FAQ>>doc:Main.Basisprojekt.Basisprojekt FAQ.WebHome]]