Refactoring I. Nach Martin Fowler - Refactoring

Transkript

1 Refactoring I Nach Martin Fowler - Refactoring Kapitel 6 : Methoden zusammenstellen Kapitel 9 : Bedingte Ausdrücke vereinfachen Kapitel 10: Methodenaufrufe vereinfachen - Mario Boley -

2 Methoden zusammenstellen Lange Methode Methode ingegrieren Viele kurze Methoden Methode extrahieren Problem mit lokalen Variablen? Methode durch Methodenobjekt ersetzen sehr viele, stark verheddert mehrere Zuweisungen? Temporäre Variable zerlegen Temporäre Variable durch Abfrage erstezen später verwendete Zuweisung

3 Methode extrahieren Ausgangsituation: Codefragment, das zusammengefasst werden kann Nach Refactoring: - Fragment ist neue Methode - Name der Methode erklärt Aufgabe

4 Methode extrahieren - Warum? Nachteile langer Methoden verbergen Informationen zugrundeliegende Logik schwerer nachzuvollziehen Vorteile kurzer Methoden bessere Wiederverwendbarkeit Methoden höherer Ebenen besser lesbar einfacheres Überschreiben

5 Methode extrahieren - Warum? Nachteile langer Methoden Wichtig dazu: aussagekräftige Methodennamen verbergen Informationen zugrundeliegende Logik schwerer nachzuvollziehen Vorteile kurzer Methoden bessere Wiederverwendbarkeit Methoden höherer Ebenen besser lesbar einfacheres Überschreiben

6 Methode extrahieren Vorgehen ohne Eclipse Neue Methode erstellen / nach Aufgabe benennen Zu extrahierenden Code in neue Methode kopieren Verwendung lokaler Variablen prüfen lokale Variable wird im extrahierten Code verändert! temporäre Variable wird nur im extrahierten Code benutzt! zunächst andere Refactorings durchführen in der neuen Methode lokal deklarieren! benötigte lokale Variablen als Parameter übergeben Kompilieren - Testen Ersetzen des extrahierten Codes durch Aufruf neuer Methode Kompilieren

7 Methode extrahieren - Vorgehen Neue Methode erstellen / nach Aufgabe benennen Zu extrahierenden Code in neue Methode kopieren Verwendung lokaler Variablen prüfen lokale Variable wird im extrahierten Code verändert! zunächst andere Refactorings durchführen - Temporäre Variable durch Abfrage ersetzen temporäre Variable wird nur im extrahierten Code benutzt! - Temporäre Variable zerlegen in der neuen Methode lokal deklarieren! - Methode durch Methodenobjekt ersetzen benötigte lokale Variablen als Parameter übergeben Kompilieren - Testen Ersetzen des extrahierten Codes durch Aufruf neuer Methode Kompilieren

8 Methode extrahieren Vorgehen mit Eclipse zu extrahierenden Codeblock markieren im Kontextmenü Methode extrahieren wählen (bzw. Shift+Alt+M) drücken Im folgenden Dialog Namen eingeben kompilieren - testen

9 Temporäre Variable durch Abfrage ersetzen Ausgangsituation: temporäre Variable speichert Ergebnis eines Ausdrucks Nach Refactoring: - Audruck durch Methode ersetzt - Referenzen der Variable durch Aufruf dieser Methode ersetzt

10 Temporäre Variable durch Abfrage ersetzen - Warum? temporäre Variablen nur lokal benutzbar fördern das Schreiben langer Methoden müssen oft entfernt werden, damit Methode extrahieren angewendet werden kann Abfragemethode kann von gesamter Klasse benutzt werden fördert Enstehung von klarem Code

11 Temporäre Variable durch Abfrage ersetzen - Vorgehen Variable als final deklarieren kompilieren Rechte Seite der Zuweisung in Methode extrahieren Referenzen der Variable durch Methodenaufruf ersetzen kompilieren - testen

12 Temporäre Variable zerlegen Ausgangsituation: temporärer Variable wird mehrfach etwas zugewiesen ist aber weder Schleifenvariable noch Ergebnis sammelnd Nach Refactoring: für jede Zuweisung eigene temporäre Variable

13 Temporäre Variable zerlegen - Warum? Klare Zuordnung Variable / Verantwortlichkeit Erhöht Lesbarkeit Vereinfacht späteres Zerlegen

14 Temporäre Variable zerlegen - Vorgehen Namen der Variablen bei Deklaration und erster Zuweisung ändern Neue Variable als final deklarieren Referenzen bis zur zweiten Zuweisung ändern Dort ursprüngliche Deklaration einfügen Für jede weitere Zuweisung wiederholen Kompilieren - Testen

15 Methode durch Methodenobjekt ersetzen Ausgangsituation: lange Methode mit mehreren lokalen Variablen, die verhindern, daß Methode extrahieren angewandt werden kann Nach Refactoring: - Methode wird eigene Klasse - lokale Variablen Felder dieser Klasse - Neue Klasse hat Verweis auf Ausgangsklasse

16 Methode durch Methodenobjekt ersetzen - Warum? Zerlegen von Methoden wird durch lokale Variablen erschwert Manchmal reicht temporäre Variable durch Abfrage ersetzen nicht aus Auf der neuen Klasse kann einfach Methode extrahieren angewandt werden

17 Methode durch Methodenobjekt ersetzen - Vorgehen Neue Klasse erstellen - nach Methode benennen in alter Methode nur noch: - neues Objekt erstellen - compute Aufrufen finales Feld für Ursprungsobjekt einfügen kompilieren Felder für alle temporären Variablen und Parameter einfügen Rumpf von Orginalmethode nach compute Konstruktor einfügen mit Ausgangsobjekt und Parametern Methode compute hinzufügen

18 Bedingte Ausdrücke vereinfachen Bedingte Ausdrücke konsolidieren komplizierter, verschachtelter Bedingungsblock Geschachtelte Bedingungen durch Wächterbedingungen ersetzen verschiedene Bedingungen mit gleichen Ergebnis? übersichtlicher Bedingungsblock Bedingung zerlegen komplizierter Bedingungsblock Verzweigung abhängig von Objekttyp Bedingten Ausdruck durch Polymorphismus ersetzen Kein expliziter Bedingungsblock mehr

19 Geschachtelte Bedingungen durch Wächterbedingungen ersetzen Ausgangsituation: verschachtelter Bedingungsblock, der normalen Ablauf nicht leicht erkennen läßt Nach Refactoring: Sonderfälle vorgelagert durch Wächterbedingungen Bewachen den eigentlichen Block vor Ausnahmen

20 Geschachtelte Bedingung durch Wächterbedingung ersetzen - Beispiel double getpayamount() { double result; if (isdead) result=deadamount(); else { if (isseparated) result=seperatedamount(); else { if (isretired) result=retiredamount(); else result=normalpayamount(); } } return result; } double getpayamount() { if (isdead) return deadamount(); if (isseperated) return seperatedamount(); if (isretired) return retiredamount(); return normalpayamount(); }

21 Geschachtelte Bedingung durch Wächterbedingung ersetzen - Beispiel double getpayamount() { double result; if (isdead) result=deadamount(); else { if (isseparated) result=seperatedamount(); Ablauf klarer else { Auftrittswahrscheinlichkeit betonter Code kürzer } if (isretired) result=retiredamount(); else result=normalpayamount(); } } return result; double getpayamount() { if (isdead) return deadamount(); if (isseperated) return seperatedamount(); if (isretired) return retiredamount(); return normalpayamount(); }

22 Geschachtelte Bedingung durch Wächterbedingung ersetzen - Vorgehen Für jede Prüfung Wächterbedinung einrichten Wächterbedingung führt entweder zu return oder wirft Exception Nach jeder Ersetzung kompilieren und testen

23 Bedingte Ausdrücke konsolidieren Ausgangsituation: Folge von Bedingungen mit gleichen Ergebnis Nach Refactoring: Bedingungen kombiniert und in eigene Methode extrahiert

24 Bedingte Ausdrücke konsolidieren - Warum? Prüfung wird übersichtlicher Zusammengehörigkeit von verschiedenen Prüfungen wird deutlich Oft wird Methode extrahieren möglich

25 Bedingte Ausdrücke konsolidieren - Warum? Prüfung wird übersichtlicher Zusammengehörigkeit von verschiedenen Prüfungen wird deutlich Diese Refaktorisierung nicht durchführen, wenn: Oft wird Methode extrahieren möglich - Bedingungen stehen nur zufällig nebeneinander - logisch nicht verknüpft

26 Bedingte Ausdrücke konsolidieren - Vorgehen Ja Hat eine der Bedingungen Seiteneffekte? Nein Refaktorisierung kann nicht eingesetzt werden Bedingungen mittels & zu einer zusammenfassen evtl. Abfrage von Veränderung trennen kompilieren testen evtl. Methode extrahieren auf Bedingung andwenden

27 Bedingung zerlegen Ausgangsituation: komplizierte if-then-else-bedingung Nach Refactoring: extrahierte Methode für: - die Bedingung - den then-zweig - den else-zweig

28 Bedingung zerlegen Gleiche Motivation wie bei Methode extrahieren Genauso das Vorgehen. Je einmal Methode extrahieren für: Bedigung Then-Block Else-Block

29 Bedingten Ausdruck durch Polymorphismus ersetzen Ausgangsituation: Bedingung wählt unterschiedliches Verhalten aus - abhängig vom Typ eines Objekts Nach Refactoring: - Jeder Bedingungszweig in überschreibender Methode einer Unterklasse - ursprüngliche Methode abstrakt

30 Bedingten Ausdruck durch Polymorphismus ersetzen Entsprechende Vererbungsstruktur muß Ausgangsituation: vorhanden sein oder erstellt werden: Bedingung wählt unterschiedliches Verhalten aus - - Typenschlüssel abhängig durch vom Unterklassen Typ eines Objekts ersetzen - Typenschlüssel durch Zustand/Strategie ersetzen Nach Refactoring: - Jeder Bedingungszweig in überschreibender Methode einer Unterklasse - ursprüngliche Methode abstrakt

31 Bedingten Ausdruck durch Polymorphismus ersetzen - Warum? Explizite Bedingungen werden überflüssig Hinzufügen eines neuen Typs erfordert nur noch Erstellung neuer Unterklasse Abhängigkeiten werden verringert

32 Bedingten Ausdruck durch Polymorphismus ersetzen - Vorgehen Bedingungsteil mit Methode extrahieren auslagern gegebenenfalls Methode an Spitze der Vererbungsstruktur bringen In Unterklasse Methode mit dem bedingten Ausdruck überschreiben Methode in Oberklasse als abstrakt deklarieren Zweige übrig? entsprechenden Zweig in Unterklasse kopieren kompilieren testen falls nötig Felder von private auf protected ändern kopierten Zweig aus Bedingungsblock entfernen kompilieren testen

33 Methodenaufrufe vereinfachen Methode mit langer Parameterliste Parameter durch Methode ersetzen Parameterobjekt einführen schlecht benannte Methode Methode umbennen Code leichter lesbar, einfacher weiter zu refaktorisieren Abfragemethode mit Seiteneffekt Abfrage von Veränderung trennen

34 Methode umbenennen Ausgangsituation: Methode hat Namen, der ihre Aufgabe nicht klar macht Nach Refactoring: Methode hat einen guten Namen :-)

35 Methode umbennen Warum? Viele kleine Methoden (siehe Methode extrahieren) sind gewünscht Bringen vollen Nutzen aber nur bei guter Bezeichnung sind für schnelles Verständnis des Codes unerlässlich

36 Methode umbenennen Vorgehen in Eclipse Cursor auf beliebiges Vorkommen des Methodennamen Entweder: Shift+Alt+R drücken oder Im Kontextmenü Refactor/Rename auswählen Im folgenden Dialog neuen Namen eingeben

37 Abfrage von Veränderung trennen Ausgangsituation: eine Methode gibt einen Wert zurück, ändert aber auch den Zustand des Objekts Nach Refactoring: - eine Methode für die Abfrage - eine Methode für die Änderung

38 Abfrage von Veränderung trennen Warum? Methode ohne Seiteneffekte kann beliebig oft aufgerufen werden Aufrufe können einfach innerhalb der Methode verschoben werden

39 Abfrage von Veränderung trennen Wann? nur bei erkennbaren Seiteneffekten z.b. Verwendung von Pufferfeldern in Abfrage nicht erkennbar Da jede Abfragefolge ergibt gleiche Ergebnisse

40 Abfrage von Veränderung trennen - Vorgehen Abfrage erstellen, die gleichen Wert wie Originalmethode zurückgibt Rückgaben der Originalmethode auf Aufrufe der neuen Query ändern Kompilieren Testen Kompilieren Testen Davor Aufruf der Originalmethode setzen Aufruf der Originalmethode durch Aufruf der Abfrage ersetzen Für jeden Aufruf wiederholen Originalmethode als void deklarieren - returns entfernen

41 Parameter durch Methode ersetzen Ausgangsituation: Methode A wird aufgerufen und mit Ergebnis als Parameter wird Methode B aufgerufen. B könnte A aber auch selber aufrufen. Nach Refactoring: - gebenenfalls neue Abfragemethode für die Berechnung des Parameters - Parameter entfernt

42 Parameter durch Methode ersetzen Motivation : kürzere Parameterlisten sind leichter zu verstehen Kann nicht durchgeführt werden, wenn Berechnung einen Parameter der aufrufenden Methode verwendet

43 Parameter durch Methode ersetzen Vorgehen Falls notwendig, Berechnung des Parameters extrahieren Referenzen des Parameters durch Referenzen auf Methode ersetzen kompilieren testen Mit Eclipse durch Refactor/Change Signature Parameter entfernen

44 Parameterobjekt einführen Ausgangsituation: Gruppe von Parametern, die auf natürliche Weise zusammengehören Nach Refactoring: - Klasse fasst Gruppe zusammen - ein Objekt dieser Klasse wird als Parameter übergeben

45 Parameterobjekt einführen Warum? Parameterliste wird kürzer Sinneinheit deutlicher Verhalten kann eventuell in die neue Klasse verschoben werden

46 Parameterobjekt einführen Vorgehen Klasse erstellen, die Parametergruppe repräsentiert kompilieren Mit Eclipse Objekt der neuen Klasse zur Signatur hinzufügen kompilieren testen Noch weitere Parameter übrig? Parameter entfernen, Aufrufer und Methode neues Objekt verwenden lassen Prüfen ob Verhalten in das Parameterobjekt verschoben werden kann