Compare commits
14 Commits
advancedSE
...
advancedSE
| Author | SHA1 | Date | |
|---|---|---|---|
| e4bc5347f1 | |||
| a360c4d986 | |||
| 9d393deaa7 | |||
| cf1bddd231 | |||
| f28603843d | |||
| 47c2ca7d36 | |||
| 52d6352334 | |||
| 68d7f3c3d9 | |||
| ce8a77d049 | |||
| 4f219ad5d5 | |||
| 0e70985ff3 | |||
| 735990b7cf | |||
| 48928f8587 | |||
| ef3b0fce5f |
2
.idea/misc.xml
generated
2
.idea/misc.xml
generated
@ -13,7 +13,7 @@
|
|||||||
</list>
|
</list>
|
||||||
</option>
|
</option>
|
||||||
</component>
|
</component>
|
||||||
<component name="ProjectRootManager" version="2" languageLevel="JDK_21" default="true" project-jdk-name="19" project-jdk-type="JavaSDK">
|
<component name="ProjectRootManager" version="2" languageLevel="JDK_19" default="true" project-jdk-name="19" project-jdk-type="JavaSDK">
|
||||||
<output url="file://$PROJECT_DIR$/out" />
|
<output url="file://$PROJECT_DIR$/out" />
|
||||||
</component>
|
</component>
|
||||||
</project>
|
</project>
|
||||||
28
combined.qmd
Normal file
28
combined.qmd
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
---
|
||||||
|
title: "Programmentwurf Advanced SoftwareEngineering"
|
||||||
|
subtitle: Für einen [PIC16f84-Simulator (Link)](https://git.paulmartin.cloud/paul/PIC-Simu/src/branch/advancedSE/)
|
||||||
|
abstract: Alle für die Vorlesung durchgeführten Änderungen befinden sich im Branch [advancedSE](https://git.paulmartin.cloud/paul/PIC-Simu/src/branch/advancedSE/). Als ursprünglicher Stand kann der [main-Branch](https://git.paulmartin.cloud/paul/PIC-Simu/src/branch/main/) oder [dieser Commit](https://git.paulmartin.cloud/paul/PIC-Simu/src/commit/c8f23176d25701c2de0723cd52bf2faaee121fb0) gesehen werden.
|
||||||
|
author:
|
||||||
|
- Luca Müller
|
||||||
|
- Paul Martin
|
||||||
|
date: 05/31/2025
|
||||||
|
date-format: "DD.MM.YYYY"
|
||||||
|
lang: de
|
||||||
|
format:
|
||||||
|
pdf:
|
||||||
|
toc: true
|
||||||
|
number-sections: true
|
||||||
|
colorlinks: true
|
||||||
|
crossref:
|
||||||
|
custom:
|
||||||
|
- kind: float
|
||||||
|
reference-prefix: UML-Diagramm
|
||||||
|
key: uml
|
||||||
|
latex-env: uml
|
||||||
|
latex-list-of-description: UML-Diagramme
|
||||||
|
---
|
||||||
|
|
||||||
|
\listof{uml}{Verzeichnis der UML-Diagramme}
|
||||||
|
|
||||||
|
{{< include paul.qmd >}}
|
||||||
|
{{< include luca.qmd >}}
|
||||||
25
luca.qmd
25
luca.qmd
@ -1,16 +1,17 @@
|
|||||||
---
|
---
|
||||||
title: "Programmentwurf AdvancedSoftwareEngineering"
|
|
||||||
author:
|
|
||||||
- Luca Müller
|
|
||||||
- Paul Martin
|
|
||||||
date: 05/31/2025
|
|
||||||
date-format: "DD.MM.YYYY"
|
|
||||||
lang: de
|
lang: de
|
||||||
format:
|
format:
|
||||||
pdf:
|
pdf:
|
||||||
toc: true
|
toc: true
|
||||||
number-sections: true
|
number-sections: true
|
||||||
colorlinks: true
|
colorlinks: true
|
||||||
|
crossref:
|
||||||
|
custom:
|
||||||
|
- kind: float
|
||||||
|
reference-prefix: UML-Diagramm
|
||||||
|
key: uml
|
||||||
|
latex-env: uml
|
||||||
|
latex-list-of-description: UML-Diagramme
|
||||||
---
|
---
|
||||||
|
|
||||||
# Code Smell 1: Long Method
|
# Code Smell 1: Long Method
|
||||||
@ -111,7 +112,6 @@ private static void showInterruptionDialog(String message){
|
|||||||
- **Erhöhte Wiederverwendbarkeit**: `showInterruptionDialog()` kann in anderen Kontexten genutzt werden
|
- **Erhöhte Wiederverwendbarkeit**: `showInterruptionDialog()` kann in anderen Kontexten genutzt werden
|
||||||
- **Bessere Testbarkeit**: Geschäftslogik und UI können separat getestet werden
|
- **Bessere Testbarkeit**: Geschäftslogik und UI können separat getestet werden
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Code Smell 2: Large Class
|
# Code Smell 2: Large Class
|
||||||
|
|
||||||
@ -252,7 +252,6 @@ public class Controller_Frontend {
|
|||||||
- **Erhöhte Wiederverwendbarkeit**: ExecutionState kann in anderen Klassen genutzt werden
|
- **Erhöhte Wiederverwendbarkeit**: ExecutionState kann in anderen Klassen genutzt werden
|
||||||
- **Bessere Wartbarkeit**: Änderungen an der Zustandslogik betreffen nur eine Klasse
|
- **Bessere Wartbarkeit**: Änderungen an der Zustandslogik betreffen nur eine Klasse
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
# Code Smell 3: Shotgun Surgery
|
# Code Smell 3: Shotgun Surgery
|
||||||
|
|
||||||
@ -399,12 +398,7 @@ public void checkAndActivateSleep() {
|
|||||||
- **Erweiterte Funktionalität**: Neue Features (wie Timeout) können zentral hinzugefügt werden
|
- **Erweiterte Funktionalität**: Neue Features (wie Timeout) können zentral hinzugefügt werden
|
||||||
- **Bessere Nachverfolgbarkeit**: Einheitliches Logging und Event-System
|
- **Bessere Nachverfolgbarkeit**: Einheitliches Logging und Event-System
|
||||||
|
|
||||||
---
|
# Anwendung von Programmierprinzipien im Projekt
|
||||||
|
|
||||||
---
|
|
||||||
title: "Anwendung von Programmierprinzipien im Projekt"
|
|
||||||
format: html
|
|
||||||
---
|
|
||||||
|
|
||||||
## Einleitung
|
## Einleitung
|
||||||
Im Rahmen der Refaktorisierung und Weiterentwicklung des Projekts wurde besonderer Fokus auf die Einhaltung zentraler Programmierprinzipien gelegt. Die folgenden Prinzipien wurden gezielt analysiert und angewendet:
|
Im Rahmen der Refaktorisierung und Weiterentwicklung des Projekts wurde besonderer Fokus auf die Einhaltung zentraler Programmierprinzipien gelegt. Die folgenden Prinzipien wurden gezielt analysiert und angewendet:
|
||||||
@ -454,7 +448,8 @@ public class ExecutionState {
|
|||||||
`Controller_Frontend` implementiert ein Interface, wodurch die Substituierbarkeit gemäß LSP gewährleistet ist:
|
`Controller_Frontend` implementiert ein Interface, wodurch die Substituierbarkeit gemäß LSP gewährleistet ist:
|
||||||
|
|
||||||
```java
|
```java
|
||||||
public class Controller_Frontend extends PICComponent implements FrontendControllerInterface { }
|
public class Controller_Frontend extends PICComponent
|
||||||
|
implements FrontendControllerInterface { }
|
||||||
|
|
||||||
public void resetPC() {
|
public void resetPC() {
|
||||||
programCounter = 0;
|
programCounter = 0;
|
||||||
|
|||||||
317
paul.qmd
Normal file
317
paul.qmd
Normal file
@ -0,0 +1,317 @@
|
|||||||
|
---
|
||||||
|
lang: de
|
||||||
|
format:
|
||||||
|
pdf:
|
||||||
|
toc: true
|
||||||
|
number-sections: true
|
||||||
|
colorlinks: true
|
||||||
|
crossref:
|
||||||
|
custom:
|
||||||
|
- kind: float
|
||||||
|
reference-prefix: UML-Diagramm
|
||||||
|
key: uml
|
||||||
|
latex-env: uml
|
||||||
|
latex-list-of-description: UML-Diagramme
|
||||||
|
---
|
||||||
|
|
||||||
|
{{< pagebreak >}}
|
||||||
|
|
||||||
|
# Entwurfsmuster
|
||||||
|
Zusätzlich zu den beiden im Folgenden dargestellten Entwursmustern benutzen wir einen [Service Locator](https://en.wikipedia.org/wiki/Service_locator_pattern), der zu den [Architectural Patterns](https://en.wikipedia.org/wiki/Architectural_pattern) zählt. Dieses Pattern nutzt ein `HashMap`, in der verschiedene Komponenten des Programms gespeichert werden, um das Komponenten-Management zu vereinfachen und explizite Abhängigkeiten der Komponenten untereinander zu vermeiden, die das Initialisieren der einzelnen Komponenten erschweren könnten.
|
||||||
|
In unserem Projekt fungiert [`PICComponentLocator`](https://git.paulmartin.cloud/paul/PIC-Simu/src/commit/c38835fd7b47c662a344c9ab2c41e0527760bd61/src/main/java/fabrik/simulator/pic16f84/PICComponentLocator.java) als dieser Locator. Er besitzt einen `componentCatalogue` als Member, der eine `Map<Class<? extends PICComponentInterface>, PICComponentInterface>` ist. Das bedeutet, dass alle Klassen, die durch den Locator gemanaget werden sollen, das `PICComponentInterface` implementieren müssen.
|
||||||
|
|
||||||
|
Um nicht bei allen Zugriffen die `PICComponentLocator.getComponent()` ausführen zu müssen, wurde zusätzlich die `abstract` Klasse `PICComponent` [eingeführt]. Sie besitzt als Member alle implementierten Komponenten, also sollten neue Komponenten ebenfalls das Interface implementieren und als Member in `PICComponent` angelegt werden. Alle Komponenten können diese Klasse `extend`en und dadurch auch alle weiteren Komponenten als Member haben, dies ist auch in @uml-observer dargestellt [^1]. Durch die `initialize`-Funktion des `PICComponent` werden durch einen Aufruf der `PICComponentLocator.initAll()` alle Member vom Locator geholt.
|
||||||
|
|
||||||
|
## Marker-Entwurfsmuster
|
||||||
|
[Marker-Patterns](https://en.wikipedia.org/wiki/Marker_interface_pattern) werden allgemein genutzt, um Klassen Metadaten zuzuordnen. In unserem Projekt stellen die `FrontendSpecific`-Interfaces Marker dar, die genutzt werden um zu kommunizieren, dass Klassen andere Klassen benötigen, die Frontend-spezifisch sind und somit besonders beachtet werden müssen. So können alle [`Interface`s](LINK ZU ORDNER) definiert werden ohne direkt von fremdem Code abhängig zu sein. Bei möglichen anderen Frontend-Implementierungen müssten entsprechend nur die passenden Klassen die jeweiligen Interfaces implementieren und nichts an den Interfaces ändern.
|
||||||
|
Eingeführt wurden die `FrontendSpecific`s in [diesem Commit](https://git.paulmartin.cloud/paul/PIC-Simu/commit/06e934801645e32dea5415ccb4f38368a1667df6) ([hier](https://git.paulmartin.cloud/paul/PIC-Simu/commit/ef3b0fce5f9b6cce06494ff6ce59f5534064e7d2) verfollständigt). Es wurde zunächst ein `FrontendSpecificObject`-Interface angelegt, das alle Frontend-spezifischen Klassen beschreibt, die von Methoden anderer Klassen genutzt werden (sprich, die in den [`Interface`s](https://git.paulmartin.cloud/paul/PIC-Simu/src/commit/f28603843d7ef6cbf4666ab2b2ceda02ca411eb7/src/main/java/fabrik/simulator/pic16f84/interfaces) vorkommen). Es ist - entsprechend des Marker-Patterns - komplett leer [definiert](https://git.paulmartin.cloud/paul/PIC-Simu/src/commit/f28603843d7ef6cbf4666ab2b2ceda02ca411eb7/src/main/java/fabrik/simulator/pic16f84/frontendspecifics/FrontendSpecificObject.java):
|
||||||
|
```java
|
||||||
|
public interface FrontendSpecificObject {
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Zusätzlich gibt es für spezifische Frontend-Klassen auch `FrontendSpecific`-Interfaces, sodass nach wie vor nur bestimmte Klassen über- bzw. zurückgegeben werden können. Diese spezifischen Interfaces sind ebenfalls leer, nur nutzen sie `extends FrontendSpecificObject` um zu verdeutlichen, dass sie zu den allgemeinen `FrontendSpecificObject`s gehören. Hier beispielsweise [`FrontendSpecificCircle`](https://git.paulmartin.cloud/paul/PIC-Simu/src/commit/ef3b0fce5f9b6cce06494ff6ce59f5534064e7d2/src/main/java/fabrik/simulator/pic16f84/frontendspecifics/FrontendSpecificCircle.java):
|
||||||
|
```java
|
||||||
|
public interface FrontendSpecificCircle extends FrontendSpecificObject {
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Tatsächlich genutzt werden die `FrontendSpecific`-Interfaces von [Circle], [ToggleButtonGroup] und [Vbox]. Sie `extenden` ihr jeweiliges `JavaFX`-Pendant und `implementen` ihr jeweiliges `FrontendSpecific`-Interface. Darüber hinaus implementieren sie nur die nötigen (also im Code tatsächlich genutzten) Konstruktoren, die wiederum nur `super()` aufrufen, hier bspw. [`ToggleButtonGroup`]:
|
||||||
|
```java
|
||||||
|
public class ToggleButtonGroup extends
|
||||||
|
com.gluonhq.charm.glisten.control.ToggleButtonGroup
|
||||||
|
implements FrontendSpecificToggleButtonGroup {
|
||||||
|
public ToggleButtonGroup(){
|
||||||
|
super();
|
||||||
|
}
|
||||||
|
|
||||||
|
public ToggleButtonGroup(ToggleButton... toggles) {
|
||||||
|
super(toggles);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
Alle für das Marker-Pattern eingeführten Klassen sind in @uml-marker erkennbar [^1]:
|
||||||
|
|
||||||
|
::: {#uml-marker}
|
||||||
|
|
||||||
|
```{mermaid}
|
||||||
|
%%| fig-width: 6.5
|
||||||
|
classDiagram
|
||||||
|
direction TB
|
||||||
|
class FrontendSpecificObject {
|
||||||
|
<<Interface>>
|
||||||
|
}
|
||||||
|
class FrontendSpecificToggleButtonGroup {
|
||||||
|
<<Interface>>
|
||||||
|
}
|
||||||
|
class ToggleButtonGroup {
|
||||||
|
public ToggleButtonGroup()
|
||||||
|
public ToggleButtonGroup(ToggleButton... toggles)
|
||||||
|
}
|
||||||
|
|
||||||
|
class `com.gluonhq.charm.glisten.control.ToggleButtonGroup` {
|
||||||
|
...
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
FrontendSpecificObject <|-- FrontendSpecificToggleButtonGroup : << extends >>
|
||||||
|
FrontendSpecificToggleButtonGroup <|-- ToggleButtonGroup : << implements >>
|
||||||
|
`com.gluonhq.charm.glisten.control.ToggleButtonGroup` <|-- ToggleButtonGroup : << extends >>
|
||||||
|
|
||||||
|
class FrontendSpecificVBox{
|
||||||
|
<<Interface>>
|
||||||
|
}
|
||||||
|
class VBox {
|
||||||
|
public VBox()
|
||||||
|
}
|
||||||
|
|
||||||
|
class `javafx.scene.layout.VBox` {
|
||||||
|
...
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
FrontendSpecificObject <|-- FrontendSpecificVBox : << extends >>
|
||||||
|
FrontendSpecificVBox <|-- VBox : << implements >>
|
||||||
|
`javafx.scene.layout.VBox` <|-- VBox : << extends >>
|
||||||
|
|
||||||
|
class FrontendSpecificCircle {
|
||||||
|
<<Interface>>
|
||||||
|
}
|
||||||
|
class Circle {
|
||||||
|
public Circle()
|
||||||
|
}
|
||||||
|
|
||||||
|
class `javafx.scene.shape.Circle` {
|
||||||
|
...
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
FrontendSpecificObject <|-- FrontendSpecificCircle : << extends >>
|
||||||
|
FrontendSpecificCircle <|-- Circle : << implements >>
|
||||||
|
`javafx.scene.shape.Circle` <|-- Circle : << extends >>
|
||||||
|
|
||||||
|
class PICComponentInterface{
|
||||||
|
<<Interface>>
|
||||||
|
+ initialize(PICComponentLocator picComponents)
|
||||||
|
}
|
||||||
|
|
||||||
|
class WindowManagement{
|
||||||
|
<<Interface>>
|
||||||
|
refreshTable()$
|
||||||
|
startFromMain(String[] args)$
|
||||||
|
}
|
||||||
|
|
||||||
|
FrontendSpecificObject <|-- WindowManagement : << extends >>
|
||||||
|
PICComponentInterface <|-- WindowManagement : << extends >>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Das genutzte Marker-Pattern und alle seine Verwendungen.
|
||||||
|
:::
|
||||||
|
## Beobachter- (/Observer-) Entwurfsmuster
|
||||||
|
[Beobachter-Entwurfsmuster](https://en.wikipedia.org/wiki/Observer_pattern) werden genutzt, damit ein Subjekt mehrere Beobachter über eine Zustandsänderung informieren kann. In unserem Projekt passiert das bei einer Änderung der `totalExecutionTime`. Das Subjekt `ExecutionTimeSubject` führt hierbei ein `Set` an Beobachtern, die bei uns durch das Interface `ExecutionTimeObserver` repräsentiert werden, welches durch die `registerObserver`- und `unregisterObserver`-Funktionen verwaltet werden kann. Bei einer Zustandsänderung muss die `notifyObservers`-Funktion aufgerufen werden, welche für alle Observer die im Interface spezifizierte `executionTimeChanged`-Funktion aufruft. Die Implementierung wurde [hier](https://git.paulmartin.cloud/paul/PIC-Simu/commit/85bc6e9ebae4655ba3ad7ee360332010edc910dd) begonnen, [hier](https://git.paulmartin.cloud/paul/PIC-Simu/commit/cf6bcd8498cd2d03e85b0c5f6faaaed935d3a155) vereinfacht um das Threading des Frontends zu respektieren und [hier](https://git.paulmartin.cloud/paul/PIC-Simu/commit/52d63523341179c3c49e0ac31a60a8d7c11cdddc) in die letzten Tests eingefügt.
|
||||||
|
In der aktuellen Umsetzung übernimmt die [`Commands`](https://git.paulmartin.cloud/paul/PIC-Simu/src/commit/ef3b0fce5f9b6cce06494ff6ce59f5534064e7d2/src/main/java/fabrik/simulator/pic16f84/Commands.java)-Klasse gleichzeitig die Rolle des `ExecutionTimeSubject`s und `CommandsInterface`s. Deshalb [wird in der `Main`-Klasse](https://git.paulmartin.cloud/paul/PIC-Simu/src/commit/85bc6e9ebae4655ba3ad7ee360332010edc910dd/src/main/java/fabrik/simulator/pic16f84/Main.java) das `Commands`-Objekt dem `ComponentLocator` sowohl für die `ExecutionTimeSubject.class` als auch für die `CommandInterface.class` hinzugefügt. `ExecutionTimeObserver` sind die Klassen, die vorher `commands.getTotalExecutionTime()` gepollt haben. Die Implementierung dieses Entwursmusters ist in @uml-observer erkennbar [^1]:
|
||||||
|
|
||||||
|
:::{#uml-observer}
|
||||||
|
|
||||||
|
```{mermaid}
|
||||||
|
%%| fig-width: 6.5
|
||||||
|
classDiagram
|
||||||
|
direction TB
|
||||||
|
class PICComponentInterface{
|
||||||
|
<<Interface>>
|
||||||
|
+ initialize(PICComponentLocator picComponents)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class CommandInterface {
|
||||||
|
<<Interface>>
|
||||||
|
+ CALL(int isr);
|
||||||
|
|
||||||
|
+ get_wRegister();
|
||||||
|
|
||||||
|
+ decode(int i);
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class PICComponent{
|
||||||
|
<<Abstract>>
|
||||||
|
# DataRegisterInterface dataRegister
|
||||||
|
...
|
||||||
|
|
||||||
|
+ initialize(PICComponentLocator locator)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class ExecutionTimeSubject{
|
||||||
|
<<Abstract>>
|
||||||
|
- Set~ExecutionTimeObserver~ observers
|
||||||
|
|
||||||
|
+ registerObserver(ExecutionTimeObserver observer)
|
||||||
|
+ unregisterObserver(ExecutionTimeObserver observer)
|
||||||
|
+ getTotalExecutionTime()
|
||||||
|
+ addExecutionTime(int i)
|
||||||
|
+ getExecutionTimeMultiplier()
|
||||||
|
# notifyObservers()
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class Commands{
|
||||||
|
- wRegister
|
||||||
|
- totalExecutionTime
|
||||||
|
- executionTimeMultiplier
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
class FrontendSpecificObject {
|
||||||
|
<<Interface>>
|
||||||
|
}
|
||||||
|
|
||||||
|
class FrontendControllerInterface{
|
||||||
|
<<Interface>>
|
||||||
|
+ getPORTbuttons() FrontendSpecificToggleButtonGroup[]
|
||||||
|
+ getTRISbuttons() FrontendSpecificToggleButtonGroup[]
|
||||||
|
+ stopRunFromBackend(String watchdogTimer)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class Controller_Frontend {
|
||||||
|
...
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
class TimerInterface {
|
||||||
|
<<Interface>>
|
||||||
|
+ cycles(int i)
|
||||||
|
+ incrementFromPin(int directRegister)
|
||||||
|
+ increment(boolean manual)
|
||||||
|
}
|
||||||
|
|
||||||
|
class Timer {
|
||||||
|
...
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class EEPROMInterface {
|
||||||
|
<<Interface>>
|
||||||
|
registerTime(double executionTime, boolean b)
|
||||||
|
parse(int i, int content, int i1)
|
||||||
|
read(int address) long
|
||||||
|
write(int address, long data)
|
||||||
|
}
|
||||||
|
|
||||||
|
class EEPROM {
|
||||||
|
...
|
||||||
|
....()
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
class ExecutionTimeObserver {
|
||||||
|
<<Interface>>
|
||||||
|
+ executionTimeChanged()
|
||||||
|
}
|
||||||
|
|
||||||
|
ExecutionTimeObserver <|-- Timer : << implements >>
|
||||||
|
TimerInterface <|-- Timer : << implements >>
|
||||||
|
PICComponent <|-- Timer : << extends >>
|
||||||
|
PICComponentInterface <|-- TimerInterface : << extends >>
|
||||||
|
PICComponentInterface <|-- EEPROMInterface : << extends >>
|
||||||
|
ExecutionTimeObserver <|-- EEPROM : << implements >>
|
||||||
|
EEPROMInterface <|-- EEPROM : << implements >>
|
||||||
|
PICComponent <|-- EEPROM : << extends >>
|
||||||
|
ExecutionTimeObserver <|-- Controller_Frontend : << implements >>
|
||||||
|
PICComponent <|-- Controller_Frontend : << extends >>
|
||||||
|
PICComponentInterface <|-- PICComponent : << implements >>
|
||||||
|
PICComponentInterface <|-- FrontendControllerInterface : << extends >>
|
||||||
|
FrontendControllerInterface <|-- Controller_Frontend : << implements >>
|
||||||
|
FrontendSpecificObject <|-- FrontendControllerInterface : << extends >>
|
||||||
|
CommandInterface <|-- Commands : << implements >>
|
||||||
|
ExecutionTimeSubject <|-- Commands : << extends >>
|
||||||
|
PICComponent <|-- ExecutionTimeSubject : << extends >>
|
||||||
|
PICComponentInterface <|-- CommandInterface : << extends >>
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
Das genutzte Observer-Pattern und seine Verwendungen im (Nicht-Test-) Code.
|
||||||
|
:::
|
||||||
|
|
||||||
|
[^1]: Für das Pattern unwichtige Funktionen und Variablen wurden ausgelassen
|
||||||
|
|
||||||
|
|
||||||
|
# Clean Architecture
|
||||||
|
|
||||||
|
Die Clean Architecture ist darauf ausgelegt, Softwareprojekte langfristig betreibbar, flexibel und wartbar zu halten. Dazu wird das Projekt in **konzentrische Schichten** unterteilt, in denen die **Abhängigkeitsrichtung stets von außen nach innen** verläuft – die sogenannte *Dependency Rule*. Der Kern der Anwendung bleibt dabei vollständig unabhängig von technischen Details wie Benutzeroberflächen, Datenbanken oder Netzwerken.
|
||||||
|
|
||||||
|
In unserem Projekt haben wir diese Schichtarchitektur wie folgt umgesetzt:
|
||||||
|
|
||||||
|
## 1. Interface/Adapter-Schicht
|
||||||
|
|
||||||
|
Diese Schicht enthält alle Klassen, die als Schnittstelle zwischen der Anwendung und der Benutzeroberfläche dienen.
|
||||||
|
Dazu zählen alle Klassen im Package, `fabrik.simulator.pic16f84.frontendspecifics` insbesondere:
|
||||||
|
|
||||||
|
- `Controller_Frontend`
|
||||||
|
- `CreateWindow`
|
||||||
|
- `IOPorts`
|
||||||
|
- `ToggleButtonGroupExt`
|
||||||
|
|
||||||
|
Diese Klassen erben vom `FrontendSpecificObject` und sind spezifisch für die grafische Oberfläche. Sie implementieren die Schnittstellen der inneren Schichten und leiten Benutzerinteraktionen weiter.
|
||||||
|
|
||||||
|
## 2. Application Code
|
||||||
|
|
||||||
|
Die nächstinnere Schicht beinhaltet die anwendungsspezifische Logik – unsere *Use Cases*. Dazu zählen sämtliche Klassen im Package `fabrik.simulator.pic16f84`, **sofern sie nicht vom `FrontendSpecificObject` erben**. Diese Schicht ist weitgehend unabhängig von der GUI und bleibt stabil, selbst wenn sich die Darstellung oder Eingabeform ändert.
|
||||||
|
Diese Klassen gehören zur Anwendungslogik:
|
||||||
|
|
||||||
|
- `Timer`
|
||||||
|
- `PreScaler`
|
||||||
|
- `WatchdogTimer`
|
||||||
|
- `ProgrammStack`
|
||||||
|
|
||||||
|
## Main-Klasse als Plugin
|
||||||
|
|
||||||
|
Die `Main`-Klasse bildet den äußeren Rahmen (Plugin-Schicht) und initialisiert die gesamte Anwendung:
|
||||||
|
|
||||||
|
- Es werden alle Objekte erzeugt und dem `Locator` zugewiesen.
|
||||||
|
- Das `WindowManagement` startet das Frontend.
|
||||||
|
|
||||||
|
Ein besonders interessanter Aspekt: Wenn man sämtliche Referenzen auf das Frontend (z. B. in Zeile 19, 20, 23) entfernt, lässt sich die App **trotzdem erfolgreich starten und nutzen**. Das zeigt, dass die Schichten entkoppelt sind – ein zentrales Ziel der Clean Architecture.
|
||||||
|
|
||||||
|
\newpage
|
||||||
|
|
||||||
|
## Visualisierung
|
||||||
|
|
||||||
|
```{mermaid}
|
||||||
|
flowchart TB
|
||||||
|
subgraph Interface/Adapter-Schicht
|
||||||
|
A1[Controller_Frontend, CreateWindow, IOPorts, ToggleButtonGroupExt]
|
||||||
|
end
|
||||||
|
subgraph Application Code
|
||||||
|
A2[Use Cases, WatchdogTimer, PreScaler, ProgrammStack, Timer]
|
||||||
|
end
|
||||||
|
subgraph Plugin-Schicht
|
||||||
|
A3[Main.java]
|
||||||
|
end
|
||||||
|
|
||||||
|
A3 --> A1
|
||||||
|
A1 --> A2
|
||||||
|
```
|
||||||
@ -1,6 +1,7 @@
|
|||||||
package fabrik.simulator.pic16f84;
|
package fabrik.simulator.pic16f84;
|
||||||
|
|
||||||
|
|
||||||
|
import fabrik.simulator.pic16f84.frontendspecifics.Circle;
|
||||||
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificToggleButtonGroup;
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificToggleButtonGroup;
|
||||||
import fabrik.simulator.pic16f84.frontendspecifics.ToggleButtonGroup;
|
import fabrik.simulator.pic16f84.frontendspecifics.ToggleButtonGroup;
|
||||||
|
|
||||||
@ -14,7 +15,6 @@ import javafx.fxml.FXML;
|
|||||||
import javafx.scene.Scene;
|
import javafx.scene.Scene;
|
||||||
import javafx.scene.control.*;
|
import javafx.scene.control.*;
|
||||||
import javafx.scene.layout.VBox;
|
import javafx.scene.layout.VBox;
|
||||||
import javafx.scene.shape.Circle;
|
|
||||||
import javafx.stage.FileChooser;
|
import javafx.stage.FileChooser;
|
||||||
|
|
||||||
import java.io.File;
|
import java.io.File;
|
||||||
|
|||||||
@ -4,9 +4,8 @@ import java.util.HashSet;
|
|||||||
import java.util.Set;
|
import java.util.Set;
|
||||||
|
|
||||||
import fabrik.simulator.pic16f84.interfaces.ExecutionTimeObserver;
|
import fabrik.simulator.pic16f84.interfaces.ExecutionTimeObserver;
|
||||||
import fabrik.simulator.pic16f84.interfaces.PICComponentInterface;
|
|
||||||
|
|
||||||
public abstract class ExecutionTimeSubject extends PICComponent implements PICComponentInterface{
|
public abstract class ExecutionTimeSubject extends PICComponent{
|
||||||
private Set<ExecutionTimeObserver> observers;
|
private Set<ExecutionTimeObserver> observers;
|
||||||
|
|
||||||
public ExecutionTimeSubject(){
|
public ExecutionTimeSubject(){
|
||||||
|
|||||||
@ -1,5 +1,7 @@
|
|||||||
package fabrik.simulator.pic16f84;
|
package fabrik.simulator.pic16f84;
|
||||||
|
|
||||||
|
import fabrik.simulator.pic16f84.frontendspecifics.Circle;
|
||||||
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificCircle;
|
||||||
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificToggleButtonGroup;
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificToggleButtonGroup;
|
||||||
import fabrik.simulator.pic16f84.frontendspecifics.ToggleButtonGroup;
|
import fabrik.simulator.pic16f84.frontendspecifics.ToggleButtonGroup;
|
||||||
import fabrik.simulator.pic16f84.interfaces.*;
|
import fabrik.simulator.pic16f84.interfaces.*;
|
||||||
@ -8,7 +10,6 @@ import javafx.scene.control.ToggleButton;
|
|||||||
import javafx.scene.paint.Color;
|
import javafx.scene.paint.Color;
|
||||||
import javafx.scene.paint.RadialGradient;
|
import javafx.scene.paint.RadialGradient;
|
||||||
import javafx.scene.paint.Stop;
|
import javafx.scene.paint.Stop;
|
||||||
import javafx.scene.shape.Circle;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
|
||||||
@ -187,9 +188,9 @@ public class IOPorts extends PICComponent implements IOPortInterface {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
public void setLEDs (Circle[] a, Circle[] b){
|
public void setLEDs (FrontendSpecificCircle[] a, FrontendSpecificCircle[] b){
|
||||||
allLEDsA = a;
|
allLEDsA = (Circle []) a;
|
||||||
allLEDsB = b;
|
allLEDsB = (Circle []) b;
|
||||||
}
|
}
|
||||||
|
|
||||||
public void refreshTable(ToggleButtonGroup parent) {
|
public void refreshTable(ToggleButtonGroup parent) {
|
||||||
|
|||||||
@ -2,20 +2,20 @@ package fabrik.simulator.pic16f84;
|
|||||||
|
|
||||||
import fabrik.simulator.pic16f84.interfaces.*;
|
import fabrik.simulator.pic16f84.interfaces.*;
|
||||||
|
|
||||||
public abstract class PICComponent {
|
public abstract class PICComponent implements PICComponentInterface{
|
||||||
DataRegisterInterface dataRegister;
|
protected DataRegisterInterface dataRegister;
|
||||||
EEPROMInterface eeprom;
|
protected EEPROMInterface eeprom;
|
||||||
PreScalerInterface preScaler;
|
protected PreScalerInterface preScaler;
|
||||||
IOPortInterface ioPorts;
|
protected IOPortInterface ioPorts;
|
||||||
TimerInterface timer;
|
protected TimerInterface timer;
|
||||||
InterruptInterface interrupts;
|
protected InterruptInterface interrupts;
|
||||||
TableInterface table;
|
protected TableInterface table;
|
||||||
FrontendControllerInterface frontendController;
|
protected FrontendControllerInterface frontendController;
|
||||||
WatchdogTimerInterface watchdogTimer;
|
protected WatchdogTimerInterface watchdogTimer;
|
||||||
ProgramStackInterface programStack;
|
protected ProgramStackInterface programStack;
|
||||||
CommandInterface commands;
|
protected CommandInterface commands;
|
||||||
ExecutionTimeSubject executionTime;
|
protected ExecutionTimeSubject executionTime;
|
||||||
ToggleButtonInterface toggleButtonExt;
|
protected ToggleButtonInterface toggleButtonExt;
|
||||||
|
|
||||||
public void initialize(PICComponentLocator locator) {
|
public void initialize(PICComponentLocator locator) {
|
||||||
toggleButtonExt = locator.getComponent(ToggleButtonInterface.class);
|
toggleButtonExt = locator.getComponent(ToggleButtonInterface.class);
|
||||||
|
|||||||
@ -0,0 +1,8 @@
|
|||||||
|
package fabrik.simulator.pic16f84.frontendspecifics;
|
||||||
|
|
||||||
|
|
||||||
|
public class Circle extends javafx.scene.shape.Circle implements FrontendSpecificCircle {
|
||||||
|
public Circle () {
|
||||||
|
super();
|
||||||
|
}
|
||||||
|
}
|
||||||
@ -0,0 +1,4 @@
|
|||||||
|
package fabrik.simulator.pic16f84.frontendspecifics;
|
||||||
|
|
||||||
|
public interface FrontendSpecificCircle extends FrontendSpecificObject {
|
||||||
|
}
|
||||||
@ -6,7 +6,4 @@ public interface CommandInterface extends PICComponentInterface {
|
|||||||
int get_wRegister();
|
int get_wRegister();
|
||||||
|
|
||||||
void decode(int i);
|
void decode(int i);
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,9 +1,8 @@
|
|||||||
package fabrik.simulator.pic16f84.interfaces;
|
package fabrik.simulator.pic16f84.interfaces;
|
||||||
|
|
||||||
import javafx.scene.shape.Circle;
|
|
||||||
|
|
||||||
import java.io.IOException;
|
import java.io.IOException;
|
||||||
|
|
||||||
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificCircle;
|
||||||
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificObject;
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificObject;
|
||||||
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificToggleButtonGroup;
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificToggleButtonGroup;
|
||||||
|
|
||||||
@ -24,7 +23,7 @@ public interface IOPortInterface extends PICComponentInterface, FrontendSpecific
|
|||||||
|
|
||||||
void reset();
|
void reset();
|
||||||
|
|
||||||
void setLEDs(Circle[] allLEDsA, Circle[] allLEDsB);
|
void setLEDs(FrontendSpecificCircle[] allLEDsA, FrontendSpecificCircle[] allLEDsB);
|
||||||
|
|
||||||
void setLEDs(boolean[] booleans);
|
void setLEDs(boolean[] booleans);
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,7 +1,6 @@
|
|||||||
package fabrik.simulator.pic16f84.interfaces;
|
package fabrik.simulator.pic16f84.interfaces;
|
||||||
|
|
||||||
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificVBox;
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificVBox;
|
||||||
import javafx.scene.layout.VBox;
|
|
||||||
|
|
||||||
public interface TableInterface extends PICComponentInterface {
|
public interface TableInterface extends PICComponentInterface {
|
||||||
void refresh();
|
void refresh();
|
||||||
|
|||||||
@ -1,6 +1,8 @@
|
|||||||
package fabrik.simulator.pic16f84.interfaces;
|
package fabrik.simulator.pic16f84.interfaces;
|
||||||
|
|
||||||
public interface WindowManagement extends PICComponentInterface {
|
import fabrik.simulator.pic16f84.frontendspecifics.FrontendSpecificObject;
|
||||||
|
|
||||||
|
public interface WindowManagement extends PICComponentInterface, FrontendSpecificObject {
|
||||||
static void refreshTable() {}
|
static void refreshTable() {}
|
||||||
|
|
||||||
static void startFromMain(String[] args) {}
|
static void startFromMain(String[] args) {}
|
||||||
|
|||||||
@ -47,6 +47,9 @@ class EEPROMTests {
|
|||||||
DataRegisterInterface mockDataRegister = Mockito.mock(DataRegisterInterface.class);
|
DataRegisterInterface mockDataRegister = Mockito.mock(DataRegisterInterface.class);
|
||||||
picComponents.registerComponent(DataRegisterInterface.class, mockDataRegister);
|
picComponents.registerComponent(DataRegisterInterface.class, mockDataRegister);
|
||||||
|
|
||||||
|
ExecutionTimeSubject mockExecutionTime = mock(ExecutionTimeSubject.class);
|
||||||
|
picComponents.registerComponent(ExecutionTimeSubject.class, mockExecutionTime);
|
||||||
|
|
||||||
EEPROMInterface eeprom = new EEPROM();
|
EEPROMInterface eeprom = new EEPROM();
|
||||||
picComponents.registerComponent(EEPROMInterface.class, eeprom);
|
picComponents.registerComponent(EEPROMInterface.class, eeprom);
|
||||||
picComponents.initAll();
|
picComponents.initAll();
|
||||||
@ -97,6 +100,9 @@ class EEPROMTests {
|
|||||||
CommandInterface mockCommands = mock(CommandInterface.class);
|
CommandInterface mockCommands = mock(CommandInterface.class);
|
||||||
picComponents.registerComponent(CommandInterface.class, mockCommands);
|
picComponents.registerComponent(CommandInterface.class, mockCommands);
|
||||||
|
|
||||||
|
ExecutionTimeSubject mockExecutionTime = mock(ExecutionTimeSubject.class);
|
||||||
|
picComponents.registerComponent(ExecutionTimeSubject.class, mockExecutionTime);
|
||||||
|
|
||||||
EEPROMInterface eeprom = new EEPROM();
|
EEPROMInterface eeprom = new EEPROM();
|
||||||
picComponents.registerComponent(EEPROMInterface.class, eeprom);
|
picComponents.registerComponent(EEPROMInterface.class, eeprom);
|
||||||
picComponents.initAll();
|
picComponents.initAll();
|
||||||
@ -122,6 +128,9 @@ class EEPROMTests {
|
|||||||
CommandInterface mockCommands = mock(CommandInterface.class);
|
CommandInterface mockCommands = mock(CommandInterface.class);
|
||||||
picComponents.registerComponent(CommandInterface.class, mockCommands);
|
picComponents.registerComponent(CommandInterface.class, mockCommands);
|
||||||
|
|
||||||
|
ExecutionTimeSubject mockExecutionTime = mock(ExecutionTimeSubject.class);
|
||||||
|
picComponents.registerComponent(ExecutionTimeSubject.class, mockExecutionTime);
|
||||||
|
|
||||||
EEPROMInterface eeprom = new EEPROM();
|
EEPROMInterface eeprom = new EEPROM();
|
||||||
picComponents.registerComponent(EEPROMInterface.class, eeprom);
|
picComponents.registerComponent(EEPROMInterface.class, eeprom);
|
||||||
picComponents.initAll();
|
picComponents.initAll();
|
||||||
|
|||||||
Reference in New Issue
Block a user