diff --git a/docs/DATENMODELL-ARCHITEKTUR.md b/docs/DATENMODELL-ARCHITEKTUR.md new file mode 100644 index 0000000..67adeab --- /dev/null +++ b/docs/DATENMODELL-ARCHITEKTUR.md @@ -0,0 +1,89 @@ +# Datenmodell und Architektur + +Das Projekt nutzt die Modelle `ShoppingList`, `ShoppingItem` und `ShoppingCategory`. + +## Diagram + +```mermaid +erDiagram + ShoppingList ||--o{ ShoppingCategory : hat + ShoppingList ||--o{ ShoppingItem : hat + ShoppingCategory ||--o{ ShoppingItem : enthält +``` + +## Modelle + +### ShoppingList + +Eine ShoppingList hat beliebige ShoppingCategory und ShoppingItem. +Der Name darf nicht leer sein. + +### ShoppingCategory + +Eine ShoppingCategory hat beliebige ShoppingItem. +Der Name darf nicht leer sein. + +### ShoppingItem + +Ein ShoppingItem hat sowohl einen Namen als auch eine Menge. +Der Nutzer hat und sollte die Freiheit haben, +die Felder so zu befüllen wie er will. +Es findet deshalb keine Eingabevalidierung in dem Sinne statt, +dass bei Menge nur Mengeneinheiten stehen dürfen oder im Namen keine Zahlen. +Die einzige Anforderung ist es, dass der Nutzer einen der beiden Felder +ausfüllen muss. + +## Architektur Backend (`src/main/java/de/timaldinger/einkaufsliste/`) + +### Controller (`Controller/`) + +`PageController` ist zuständig für das Bereitstellen von den einzelnen Seiten. +Die restlichen Controller sind RESTController, welche die API-Schnittstelle +behandeln. Sie sind nach der betroffenen Ressource aufgeteilt. + +### Data Transfer Objects (`Dto/`) + +Die Webapp nutzt sogenannte DTOs (Data transfer objects) +um die geschickten JSON-Daten auf das Model abzubilden. Diese liegen unter `Dto/`. +Dort sind die DTOs nochmal nach den HTTP-Methoden aufgeteilt, da je nach Methode +der Nutzer unterschiedliche Daten mitschicken tut. + +### Exceptions (`Exceptions/`) + +Hier liegen benutzerdefinierte Fehlermeldungen, die an das Frontend geschickt werden +(hauptsächlich für 400 und 404) +und ein eigener Exception Handler `GlobalExceptionHandler.java`. +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 +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. + +Das Record `ErrorResponse.java` stellt einen JSON-Body dar um daraus die Fehlermeldung +zu bauen die an das Frontend geschickt wird. + +### Mapper (`Mapper/`) + +Klassen, welche die Models aus der Datenbank zu DTOs mappen + +### Models (`Model/`) + +Unter `Models/` liegen die Modelle. Die Modelle werden in der Datenbank +so abgebildet wie sie in der Klasse definiert sind. + +### Repository (`Repository/`) + +Interfaces, die das JpaRepositories-Interface implementieren. Das JPARep wurde genommen, +da man dort Bulkfunktionen wie `saveAll` nutzen kann, +Rückgabetypen wie `List` erlaubt sind und diese auch eine `h2`-db +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. + +## Architektur Frontend diff --git a/docs/DATENMODELL.md b/docs/DATENMODELL.md deleted file mode 100644 index 0e39dc2..0000000 --- a/docs/DATENMODELL.md +++ /dev/null @@ -1,12 +0,0 @@ -# Datenmodell - -Das Projekt nutzt die Modelle `ShoppingList`, `ShoppingItem` und `ShoppingCategory`. - -## Diagram - -```mermaid -erDiagram - ShoppingList ||--o{ ShoppingCategory : hat - ShoppingList ||--o{ ShoppingItem : hat - ShoppingCategory ||--o{ ShoppingItem : enthält -```