update d-a.md
This commit is contained in:
1 parent
bcf735af2f
commit
c9132be067
1 file changed
+11
-6
@@ -1,7 +1,7 @@
|
||||
# Datenmodell und Architektur
|
||||
|
||||
Das Projekt nutzt die Modelle `ShoppingList`, `ShoppingItem` und `ShoppingCategory`.
|
||||
Neben den Spring und Thymeleaf Bibliotheken wurde noch zusätzlich lombok genutzt.
|
||||
Neben den Spring und Thymeleaf Bibliotheken wurde noch zusätzlich `lombok` genutzt.
|
||||
Lombok stellt Annotationen bereit um Boilerplatecode zu vermeiden.
|
||||
|
||||
## Diagramm
|
||||
@@ -17,12 +17,12 @@ erDiagram
|
||||
|
||||
### ShoppingList
|
||||
|
||||
Eine ShoppingList hat beliebige ShoppingCategory und ShoppingItem.
|
||||
Eine ShoppingList hat beliebig viele ShoppingCategory und ShoppingItem.
|
||||
Der Name darf nicht leer sein.
|
||||
|
||||
### ShoppingCategory
|
||||
|
||||
Eine ShoppingCategory hat beliebige ShoppingItem.
|
||||
Eine ShoppingCategory hat beliebig viele ShoppingItem.
|
||||
Der Name darf nicht leer sein.
|
||||
|
||||
### ShoppingItem
|
||||
@@ -39,6 +39,7 @@ ausfüllen muss.
|
||||
|
||||
### Controller (`Controller/`)
|
||||
|
||||
Hier liegen die Controller welche HTTP-Anfragen abwickeln.
|
||||
`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.
|
||||
@@ -82,7 +83,8 @@ 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.
|
||||
welche ihre Unterklassen dann auch haben. Die Klasse selbst wird nicht
|
||||
in der Datenbank abgebildet.
|
||||
|
||||
### Repository (`Repository/`)
|
||||
|
||||
@@ -133,7 +135,8 @@ Hier liegen nötige Javascriptdateien für die Seite `/list/{id}`.
|
||||
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.
|
||||
Die Imports sind dann in den jeweilen `listUI.js` und `listAPI.js` gebündelt
|
||||
welche dann in die `list.js` importiert wird.
|
||||
|
||||
### Shared Module (`static/js/shared`)
|
||||
|
||||
@@ -145,7 +148,9 @@ 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.
|
||||
sollte beibehalten werden. Es wurde nur die editElement() Funktion
|
||||
generalisiert, da die Bearbeitung eines Elementes für alle drei Models
|
||||
gleich abläuft im Gegensatz zu dem Hinzufügen und Löschen dieser.
|
||||
|
||||
#### error.js
|
||||
|
||||
|
||||
Reference in new issue
Block a user