zeilenlänge und so angepasst weil nvim heult
This commit is contained in:
1 parent
bb60da6aaa
commit
e22cd8c650
1 file changed
+19
-10
@@ -1,8 +1,10 @@
|
||||
# Datenmodell und Architektur
|
||||
|
||||
Das Projekt nutzt die Modelle `ShoppingList`, `ShoppingItem` und `ShoppingCategory`.
|
||||
Neben den Spring und Thymeleaf Bibliotheken wurde noch zusätzlich lombok genutzt.
|
||||
Lombok stellt Annotationen bereit um Boilerplatecode zu vermeiden.
|
||||
|
||||
## Diagram
|
||||
## Diagramm
|
||||
|
||||
```mermaid
|
||||
erDiagram
|
||||
@@ -57,11 +59,14 @@ Dieser wurde erstellt damit Fehlermeldungen
|
||||
besser dargestellt werden können und keine Spring-Fehlermeldungen an das Frontend
|
||||
geschickt werden.
|
||||
Er ist mit `@RestControllerAdvice` annotiert, das heißt,
|
||||
dass er für alle anderen Controller gilt. Er implementiert Methoden annotiert
|
||||
dass er für alle anderen Controller gilt. Er greift, wenn ein Fehler von
|
||||
einer Controllerklasse aus propagiert. Er implementiert Methoden annotiert
|
||||
mit `@ExceptionHandler`, welche angibt, für welche Funktion ein geworfener Fehler
|
||||
in einer Funktion des Controllers greift. Es werden in den Controllern die
|
||||
Custom Exceptions geworfen.
|
||||
|
||||
Die CustomException-Klassen erben von `RuntimeException`.
|
||||
|
||||
Das Record `ErrorResponse.java` stellt einen JSON-Body dar um daraus die Fehlermeldung
|
||||
zu bauen die an das Frontend geschickt wird.
|
||||
|
||||
@@ -70,15 +75,19 @@ zu bauen die an das Frontend geschickt wird.
|
||||
Klassen, welche die Models aus der Datenbank zu DTOs mappen. Nötig um GET
|
||||
Anfragen zu nutzen.
|
||||
|
||||
### Models (`Model/`)
|
||||
### Models (`Models/`)
|
||||
|
||||
Unter `Models/` liegen die Modelle. Die Modelle werden in der Datenbank
|
||||
so abgebildet wie sie in der Klasse definiert sind.
|
||||
so abgebildet wie sie in der Klasse definiert sind. Auch sind Relationen
|
||||
der Entities wie sie in der Datenbank seien sollen abgebildet mit
|
||||
Annotationen wie `@ManyToOne`. Es gibt eine abstrakte Klasse `ShoppingElement`,
|
||||
von welcher alle anderen Entities erben. Die Klasse hat eine Variable `id`,
|
||||
welche ihre Unterklassen dann auch haben.
|
||||
|
||||
### Repository (`Repository/`)
|
||||
|
||||
Interfaces, die das JpaRepositories-Interface implementieren. Das JPARep wurde genommen,
|
||||
da man dort Bulkfunktionen wie `saveAll` nutzen kann,
|
||||
da man dort Bulkfunktionen wie `saveAll` und `findAll` nutzen kann,
|
||||
Rückgabetypen wie `List` erlaubt sind und diese auch eine `h2`-db
|
||||
Implementierung aufweist.
|
||||
|
||||
@@ -97,7 +106,7 @@ stellt diese bereit.
|
||||
|
||||
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/`.
|
||||
spezifische JS Dateien liegen. Hier finden sich zwei Unterordner: `api/` und `frontend/`.
|
||||
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
|
||||
@@ -113,15 +122,15 @@ sich für ein LightDOM Ansatz entschieden, da zum einen die Eventpropagation ein
|
||||
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`)
|
||||
### Index Seite (`/static/js/pages/index`)
|
||||
|
||||
Hier liegen nötige Javascriptdateien für die Root Seite `/`.
|
||||
Unter `/api` liegen die API Methoden, unter `/ui` UI Methoden
|
||||
Unter `/api` liegen die API Methoden, unter `/frontend` UI Methoden
|
||||
|
||||
### List Seite (`static/js/list`)
|
||||
### List Seite (`static/js/pages/list`)
|
||||
|
||||
Hier liegen nötige Javascriptdateien für die Seite `/list/{id}`.
|
||||
Unter `/api` liegen die API Methoden, unter `/ui` UI Methoden.
|
||||
Unter `/api` liegen die API Methoden, unter `/frontend` 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.
|
||||
|
||||
Reference in new issue
Block a user