Das im Video zu den SOLID-Prinzipien vorgestellte Beispiel der “Bauzeichner 2.0”-Software wird in dieser Übung einmal gründlich gefactored - gemäß der Prinzipien von SOLID und Clean Code.
Alle nachfolgenden Schritte beziehen sich auf das Beispiel-Repo Bauzeichner2.0-CleanCode-SOLID. Das Repo ist so aufgebaut, dass es zwei Java-Projekte enthält.
before_refactoring ist die Version, die DDD- und SOLID-Prinzipien verletzt. Alle entsprechenden Tests
sind rot (bzw. gelb, in IntelliJ). Funktional ist die Implementierung ok (wenn auch unvollständig und
sehr lieblos runtergehauen …), was man daran sieht, dass die funktionalen Unit-Tests im
Package functionaltests grün sind.after_refactoring enthält die Variante nach dem Refactoring.Hinweis: Wegen der zwei Projekte sollten Sie also nicht den Top-Level-Ordner bauzeichner2.0-cleancode-solid
in IntelliJ öffnen, sondern die beiden unterliegenden Ordner before_refactoring und after_refactoring in
zwei verschiedenen IntelliJ-Instanzen.
Schauen Sie sich das Video an, und finden Sie Verstöße gegen die Clean-Code-Prinzipien. Das PMD-Plugin für IntelliJ kann Ihnen dabei helfen.
(Die Lösung finden Sie - genau wie auch bei den nachfolgenden Schritten 2 … 3c - in dem Projekt after_refactoring.)
Machen Sie gemäß unserer Konventionen für die DDD-Schichtenarchitektur ein Refactoring des Übungs-Repos, so dass die DDD-Konventionen eingehalten werden. Denken Sie auch an die Namenskonventionen.
Finden Sie den hauptsächlichen Verstoß gegen das Single Responsibility Principle (SRP) im Code. Beheben Sie ihn.
Finden Sie den hauptsächlichen Verstoß gegen das Open-Closed Principle (OCP) im Code. Beheben Sie ihn.
Finden Sie den hauptsächlichen Verstoß gegen das Dependency Inversion Principle (DIP) im Code. Beheben Sie ihn.
Das allgemeine Vorgehen ist auf einer eigenen Infoseite
beschrieben. Wenn Sie sich das Projekt before_refactoring anschauen, dann haben die Klassen Canvas und DrawingElement
die folgende zyklische Abhängigkeit:
Die Abhängigkeiten sind auch beide tatsächlich nötig, denn Canvas muss ausgeben können, welche Elemente
es enthält, bzw. welche Nachbar-Elemente ein DrawingElement hat. Sonst kann sich das Element nicht
z.B. in der Größe skalieren, denn es darf ja nicht mit Nachbarn kollidieren. Dafür gibt es die Methode
public List<DrawingElement> getNeighboursOf( DrawingElement drawingElement ) {
// ...
}
in Canvas. Auf der anderen Seite muss DrawingElement seine Zeichenfläche kennen, sonst kann es
keine Move-Befehle ausführen (es wüsste ja sonst nicht, wie weit es z.B. nach links oder rechts
rücken darf). Diese gegenseitige Abhängigkeit wird man also nicht so leicht los. Nach Schritt 2
(Anlegen der passenden Package-Strukturen) und Schritt 3a (Aufbrechen von DrawingElement in
die beiden Klassen Door und Window sieht dieser Zykel so aus (domain und application-Packages
sind aus Übersichtlichkeitsgründen nicht gezeigt):
Mit dem Dependency Inversion Principle kann man diese Abhängigkeiten aufheben. (Schauen Sie sich
bitte das entsprechende Video dazu an, siehe oben auf dieser Seite!) Dafür muss man auf der
Seite des Canvas-Package Interfaces definieren, die sozusagen die “Erwartungen” der Canvas-Seite
ausdrücken.
Drawable, das aus Sicht von Canvas alle Eigenschaften und nötigen
Methoden eines Zeichenelements enthält.DrawableServiceInterface, das
die Methoden für das Lifecycle-Management eines Drawable vorgibt.DrawingElement-Seite implementiert.
Die Implementieren referenzieren die Interfaces auf der Canvas-Seite.Damit ergibt sich folgendes Bild (die neuen Klassen sind rot eingefärbt). Am besten schauen Sie sich
das einmal im Code an. Die Abhängigkeiten sind dadurch tatsächlich nicht mehr zyklisch.
Jetzt kennt das DrawingElement-Package zwar Canvas, aber nicht mehr umgekehrt.
Wie Sie im Code sehen, entspricht die Implementierung nicht 100% der obigen Skizze. Drawable
ist tatsächlich eine abstrakte Klasse, kein Interface. Das ist deswegen nötig, weil Spring JPA
keine Interfaces via @OneToMany referenzieren kann, wohl aber abstrakte Klassen. Am Prinzip
ändert dieses Detail aber nichts. Die korrekte Modellierung ist dann so:
