updated
This commit is contained in:
1 parent
ea6a330fab
commit
af46c19651
1 file changed
+68
-3
@@ -67,7 +67,8 @@ zu bauen die an das Frontend geschickt wird.
|
||||
|
||||
### Mapper (`Mapper/`)
|
||||
|
||||
Klassen, welche die Models aus der Datenbank zu DTOs mappen
|
||||
Klassen, welche die Models aus der Datenbank zu DTOs mappen. Nötig um GET
|
||||
Anfragen zu nutzen.
|
||||
|
||||
### Models (`Model/`)
|
||||
|
||||
@@ -84,6 +85,70 @@ Implementierung aufweist.
|
||||
### Services (`Service/`)
|
||||
|
||||
Serviceklassen, welche Methoden für die Controller zur Verfügung stellen,
|
||||
um die jeweile HTTP-Request erfüllen zu können.
|
||||
um die jeweile HTTP-Request erfüllen zu können. Sie kapseln die Logik von den Controllern.
|
||||
|
||||
## Architektur Frontend
|
||||
### Templating (`src/main/resources/templates`)
|
||||
|
||||
Da die Webapp einen Hybridansatz beim Rendering verfolgt, wurden Thymeleaf-Templates
|
||||
genutzt um die Seite beim Aufrufen bereitzustellen. Die `PageController` Klasse
|
||||
stellt diese bereit.
|
||||
|
||||
## Architektur Frontend (`src/main/resources/static`)
|
||||
|
||||
Genutzt wurde Vanilla-JS und CSS. Das CSS liegt unter `static/css` und das JS unter `static/js`.
|
||||
Jede aufrufbare Seite (`/` und `/list`) hat seinen eigenen Ordner, wo für die Seite
|
||||
spezifische JS Dateien liegen. Hier finden sich zwei Unterordner: `api/` und `ui/`.
|
||||
Unter jenen Ordner befinden sich Funktionen die jeweils API und UI abwickeln.
|
||||
Die `.js` Datei die in dem Ordnerroot liegt, nutzt und bündelt diese.
|
||||
Die Trennung wurde getätigt um bessere Übersicht und
|
||||
sauberere Entwicklung zu ermöglichen.
|
||||
Unter `shared/` liegen Dateien, die von alle Seiten
|
||||
genutzt werden. Unter Models liegen die Implementierungen der CustomHTML-Elemente.
|
||||
|
||||
### Custom Elemente (`/static/js/models`)
|
||||
|
||||
Im Laufe der Entwicklung wurden CustomHTML Elemente genommen, um die ShoppingList,
|
||||
ShoppingCategory und ShoppingItems darzustellen und besser zu handhaben. Es wurde
|
||||
sich für ein LightDOM Ansatz entschieden, da zum einen die Eventpropagation einfacher
|
||||
zu gestalten ist (EventListener auf `div`) und zum anderen die CSS Klassen greifen.
|
||||
Mit einem Shadow-DOM Ansatz mit zB `templates` wäre das umständlicher.
|
||||
|
||||
### Index Seite (`/static/js/index`)
|
||||
|
||||
Hier liegen nötige Javascriptdateien für die Root Seite `/`.
|
||||
Unter `/api` liegen die API Methoden, unter `/ui` UI Methoden
|
||||
|
||||
### List Seite (`static/js/list`)
|
||||
|
||||
Hier liegen nötige Javascriptdateien für die Seite `/list/{id}`.
|
||||
Unter `/api` liegen die API Methoden, unter `/ui` UI Methoden.
|
||||
Da die Seite sowohl Kategorien als auch Gegenstände
|
||||
behandelt sind in den Ordnern jeweils API und UI Dateien für die beiden Elemente.
|
||||
Diese sind dann in den jeweilen `listUI.js` und `listAPI.js` gebündelt.
|
||||
|
||||
### Shared Module (`static/js/shared`)
|
||||
|
||||
#### editing.js
|
||||
|
||||
Hier liegt die Logik, welche genutzt wird um eines
|
||||
der Elemente (Liste, Kategorie, Gegenstand) zu bearbeiten.
|
||||
Zusammen mit `sharedUI.js` bildet sie den Ablauf ab.
|
||||
Die beiden Dateien sind bewusst getrennt,
|
||||
da die Funktion `editElement()` eine Mischung aus UI und API Aufrufe hat.
|
||||
Das Muster, dass API und UI Funktionen in getrennten Dateien leben,
|
||||
sollte beibehalten werden.
|
||||
|
||||
#### error.js
|
||||
|
||||
Globale Fehlermeldungsdarstellung. Eine Clientseitige Validierung findet
|
||||
nicht statt, da sie serverseitig behandelt werden.
|
||||
|
||||
#### helper.js
|
||||
|
||||
Hilfsfunktion für das Abwickeln von `fetch()` Anfragen.
|
||||
Zur Vereinheitlichung der Funktionen die API calls nutzen.
|
||||
|
||||
#### sharedUI.js
|
||||
|
||||
Stellt UI-Funktionen bereit, die alle Seiten nutzen. Momentan nur für
|
||||
Bearbeitung der Elemente.
|
||||
Reference in new issue
Block a user