Changes for page Basisprojekt

Summary

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

Details

Page properties

Content

...	...	@@ -1,7 +1,11 @@
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		-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.
	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.
5	5	{{/info}}
6	6
7	7	{{toc/}}
...	...	@@ -31,6 +31,7 @@
31	31
32	32	== Access Token ==
33	33
	38	+{{expandable summary="Schritt-für-Schritt: Access Token einrichten"}}
34	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**.
35	35
36	36	[[image:1757398899497-714.png||height="246" width="278"]]
...	...	@@ -49,11 +49,11 @@
49	49
50	50	{{warning}}
51	51	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.**
52		-{{/warning}}
	57	+{{/warning}}
53	53
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.
	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}}
55	55
56		-
57	57	== Nach dem Klonen ==
58	58
59	59	sollten Sie einen Bildschirm ähnlich zu dem folgenden sehen:
...	...	@@ -101,6 +101,7 @@
101	101
102	102	== Logging umstellen ==
103	103
	109	+{{expandable summary="Schritt-für-Schritt: Logging konfigurieren"}}
104	104	Wenn man möchte, kann man das Logging umstellen.
105	105
106	106	[[image:1755246135109-325.png]]
...	...	@@ -110,9 +110,11 @@
110	110
111	111
112	112	[[image:1755246162330-595.png]]
	119	+{{/expandable}}
113	113
114	114	== Development-Profil aktivieren ==
115	115
	123	+{{expandable summary="Schritt-für-Schritt: Development-Profil aktivieren"}}
116	116	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.
117	117
118	118	Wenn man die Anwendung einmal gestartet hat, kann man dies Configuration anpassen:
...	...	@@ -129,6 +129,7 @@
129	129	[[image:1755248752596-839.png]]
130	130
131	131	Danach muss man den Server neu starten!
	140	+{{/expandable}}
132	132
133	133	== Client starten ==
134	134
...	...	@@ -149,6 +149,7 @@
149	149
150	150	=== Mehrere Instanzen des Clients ermöglichen ===
151	151
	161	+{{expandable summary="Schritt-für-Schritt: mehrere Client-Instanzen starten"}}
152	152	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.
153	153
154	154	[[image:1755246233218-893.png]]
...	...	@@ -157,8 +157,8 @@
157	157	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.
158	158
159	159	[[image:1755246292057-581.png]]
	170	+{{/expandable}}
160	160
161		-
162	162	= Überblick über das Basisprojekt =
163	163
164	164	[[image:1755249096987-249.png]]
...	...	@@ -184,6 +184,10 @@
184	184	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.
185	185	{{/info}}
186	186
	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	+
187	187	[[image:1755250026156-269.png]]
188	188
189	189	[[image:1755250050031-304.png]]
...	...	@@ -233,6 +233,7 @@
233	233
234	234	= Erweiterung der REST-Schnittstelle =
235	235
	250	+{{expandable summary="Ausführliches Beispiel: REST-Schnittstelle erweitern"}}
236	236	In diesem Beispiel wird einmal gezeigt, wie die REST-Schnittstelle des Basisprojektes einfach erweitert werden kann.
237	237
238	238	In diesem Beispiel soll die aktuelle Schnittstelle um die Möglichkeit erweitert werden, alle Lobbies vom Server zu bekommen.
...	...	@@ -352,8 +352,8 @@
352	352	[[image:1756890010118-149.png||height="116" width="972"]]
353	353
354	354	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}}
355	355
356		-
357	357	= Asynchrone Kommunikation zum Client: WebSockets =
358	358
359	359	[[image:1756890800817-370.png||height="604" width="1121"]]
...	...	@@ -400,7 +400,6 @@
400	400	* `/topic/users/loggedIn`: Ein Nutzer hat sich angemeldet.
401	401	* `/topic/users/loggedOut`: Ein Nutzer hat sich ausgeloggt.
402	402
403		-
404	404	[[image:1756891125969-748.png||height="317" width="726"]]
405	405
406	406	Topic-Namen sind Strings, sollten aber einem konsistenten fachlichen Namensschema folgen. Für Lobby-Ereignisse bietet sich entsprechend `/topic/lobbies/...` an.
...	...	@@ -432,6 +432,7 @@
432	432
433	433	== Wie verbindet sich ein Client mit dem Server? ==
434	434
	449	+{{expandable summary="Technische Details zum Verbindungsaufbau"}}
435	435	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.
436	436
437	437	[[image:1756891512330-186.png||height="170" width="820"]]
...	...	@@ -458,3 +458,10 @@
458	458	3) Über den Kontext ein Event pushen LoggedInEvent
459	459
460	460	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]]