Refactoring. PG Reclipse Seminar: Refactoring Jan-Christopher Bals (1/30)

Transkript

1 Refactoring PG Reclipse Seminar: Refactoring Jan-Christopher Bals (1/30)

2 Gliederung des Vortrags Definition Hintergrund und Motivation Refactoring am Beispiel Refactoring-Katalog Unterstützung durch Tools Zusammenfassung PG Reclipse Seminar: Refactoring Jan-Christopher Bals (2/30)

3 Definition Refactoring: Veränderung der Struktur von Software bei Erhaltung des extern beobachtbaren Verhalten Wie lässt sich der Erhalt des Verhaltens von Software definieren? Erster Ansatz: Input / Output Real-time Systems (CPU Zeit)? Embedded Systems (Speicherressourcen)? Sicherheitskritische Systeme? Besserer Ansatz: Softwarespezifikation Wie kann sichergestellt werden, dass Refactoring das Verhalten erhält? Einhaltung der Spezifikation nach dem Refactoring Vordefinierte Testfälle identisch absolvieren PG Reclipse Seminar: Refactoring Jan-Christopher Bals (3/30)

4 Hintergrund und Motivation Änderungen an der internen Struktur von Programmen werden seit jeher vorgenommen Beispiele: Namen von Methoden ändern Doppelten Code durch Methodenaufruf ersetzen Methoden durch Änderung der Signatur erweitern Änderungen der Programmstruktur in objektorientierten Sprachen gehen darüber hinaus und werden als Refactoring bezeichnet. Erste Untersuchung und Anwendung an Smalltalk und C++ PG Reclipse Seminar: Refactoring Jan-Christopher Bals (4/30)

5 Hintergrund und Motivation Hohe Kosten der Softwareentwicklung motivierten: Wiederverwendung von Software Weiterentwicklung bestehender Software Probleme: Software muss angepasst werden Softwarekomponenten müssen identifiziert und verstanden werden Lösung: Restrukturierung der Software durch Refactoring Software ist besser zu lesen Änderungen und Erweiterungen können leichter eingebracht werden Dadurch sinkt die Fehleranfälligkeit der Programmierung Softwarewartung Idealerweise Refactorings während der Wartung durchführen PG Reclipse Seminar: Refactoring Jan-Christopher Bals (5/30)

6 Refactoring am Beispiel Abrechnungssystem eines Videoverleihs Movie +CHILDRENS : int = 2 +REGULAR : int = 0 +NEW_RELEASE : int = 1 -title : string -pricecode : int +getpricecode() : int +setpricecode() +gettitle() : string Rental -movie : Movie -daysrented : int 1 * +getdaysrented() : int * 1 +getmovie() : Movie Customer -name : string -rentals : Vector +statement() : string +addrental() +getname() : string PG Reclipse Seminar: Refactoring Jan-Christopher Bals (6/30)

7 Refactoring am Beispiel statement() public String statement(){ double totalamount = 0; int frequentrenterpoints = 0; Enumeration rentals = this.rentals.elements(); String result = "Rental Record for "+ getname() + "\n"; while (rentals.hasmoreelements()){ double thisamount = 0; Rental each = (Rental)rentals.nextElement(); //determine amounts for each line switch (each.getmovie().getpricecode()){ case Movie.REGULAR: thisamount += 2; if(each.getdaysrented() > 2) thisamount += (each.getdaysrented() - 2)*1.5; break; case Movie.NEW_RELEASE: thisamount += each.getdaysrented() * 3; break; case Movie.CHILDRENS: thisamount += 1.5; if(each.getdaysrented() > 3) thisamount += (each.getdaysrented() - 3) * 1.5; break; } } //add frequent renter points frequentrenterpoints++; //add bonus for a two day new release rental if((each.getmovie().getpricecode() == Movie.NEW_RELEASE) &&(each.getdaysrented() > 1)) frequentrenterpoints++; //show figures for this rental result += "\t" + each.getmovie().gettitle() + "\t" + String.valueOf(thisAmount) + "\n"; totalamount += thisamount; } //add footer lines result += "Amount owed is "+ String.valueOf(totalAmount) + "\n"; result += "You earned " + String.valueOf(frequentRenterPoints) + " frequent renter points"; return result; PG Reclipse Seminar: Refactoring Jan-Christopher Bals (7/30)

8 Refactoring am Beispiel statement(){...} public String statement(){ double totalamount = 0; int frequentrenterpoints = 0; Enumeration rentals = this.rentals.elements(); String result = "Rental Record for "+ getname() + "\n"; while (rentals.hasmoreelements()){ //determine amount for this rental //add frequent renter points } //add footer lines result += "Amount owed is "+ String.valueOf(totalAmount) + "\n"; result += "You earned " + String.valueOf(frequentRenterPoints) + " frequent renter points"; return result; } PG Reclipse Seminar: Refactoring Jan-Christopher Bals (8/30)

9 Refactoring am Beispiel statement(){... while{...}... } while (rentals.hasmoreelements()){ //determine amount for this rental double thisamount = 0; Rental each = (Rental)rentals.nextElement(); switch (each.getmovie().getpricecode()){ case Movie.REGULAR: thisamount += 2; if(each.getdaysrented() > 2) thisamount += (each.getdaysrented() - 2)*1.5; break; case Movie.NEW_RELEASE: thisamount += each.getdaysrented() * 3; break; case Movie.CHILDRENS: thisamount += 1.5; if(each.getdaysrented() > 3) thisamount += (each.getdaysrented() - 3) * 1.5; break;} //add frequent renter points} PG Reclipse Seminar: Refactoring Jan-Christopher Bals (9/30)

10 Refactoring am Beispiel statement(){... while{...}... }...while (rentals.hasmoreelements()){ //determine amount for this rental //add frequent renter points frequentrenterpoints++; //add bonus for a two day new release rental if((each.getmovie().getpricecode() == Movie.NEW_RELEASE)&&(each.getDaysRented() > 1)) frequentrenterpoints++; //show figures for this rental result += "\t" + each.getmovie().gettitle() + "\t" + String.valueOf(thisAmount) + "\n"; totalamount += thisamount; }... PG Reclipse Seminar: Refactoring Jan-Christopher Bals (10/30)

11 Refactoring am Beispiel c:customer r:rental m:movie statement() for all rentals getmovie() Determine amounts getpricecode getdaysrented() getmovie() Add Frequent Renter Points getpricecode getdaysrented() PG Reclipse Seminar: Refactoring Jan-Christopher Bals (11/30)

12 Refactoring am Beispiel Methoden extrahieren ( Extract Method ) class Customer public String statement(){... while (rentals.hasmoreelements()){ Rental each = (Rental)rentals.nextElement(); double thisamount = getcharge(each); frequentrenterpoints += getfrequentrenterpoints(each); }...} private int getfrequentrenterpoints(rental arental) { } if((arental.getmovie().getpricecode() == Movie.NEW_RELEASE) &&(arental.getdaysrented() > 1)) return 2; else private double getcharge(rental arental) { return 1; double thisamount = 0; } switch(arental.getmovie().getpricecode()){...} return thisamount; PG Reclipse Seminar: Refactoring Jan-Christopher Bals (12/30)

13 Refactoring am Beispiel Methoden verschieben ( Move Method ) class Customer public String statement(){... while (rentals.hasmoreelements()){ Rental each = (Rental)rentals.nextElement(); double thisamount = each.getcharge(); frequentrenterpoints += each.getfrequentrenterpoints(); }...} class Rental private int getfrequentrenterpoints() { } if((getmovie().getpricecode() == Movie.NEW_RELEASE) &&(getdaysrented() > 1)) return 2; else private double getcharge() { return 1; double thisamount = 0; } switch(getmovie().getpricecode()){...} return thisamount; PG Reclipse Seminar: Refactoring Jan-Christopher Bals (13/30)

14 Refactoring am Beispiel Bedingte Ausdrücke durch Polymorphie ersetzen ( Replace Conditonal With Polymorphism ) Movie -name : string -pricecode : Price +getcharge() : double +getfrequentrenterpoints() : int * 1 Price +getcharge() +getfrequentrenterpoints() getcharge() { return pricecode.getcharge(); } Regular Price +getcharge() Childrens Price +getcharge() New Release Price +getcharge() +getfrequentrenterpoints() getfrequentrenterpoints() { return pricecode.getfrequentrenterpoints(); } PG Reclipse Seminar: Refactoring Jan-Christopher Bals (14/30)

15 Refactoring am Beispiel public class Rental { private Movie movie; private int daysrented;... public int getfrequentrenterpoints() { return movie.getfrequentrenterpoints(daysrented)}; } public double getcharge() { return movie.getcharge(daysrented)}; public class Movie { private String title; private Price pricecode;... public double getcharge(int daysrented){ return pricecode.getcharge(daysrented)}; } public int getfrequentrenterpoints(int daysrented){ return pricecode.getfrequentrenterpoints(daysrented)}; PG Reclipse Seminar: Refactoring Jan-Christopher Bals (15/30)

16 Refactoring am Beispiel Auswirkungen auf das Design (statisch) vorher: Movie +CHILDRENS : int = 2 +REGULAR : int = 0 +NEW_RELEASE : int = 1 -title : string -pricecode : int +getpricecode() : int +setpricecode() +gettitle() : string Rental -movie : Movie -daysrented : int 1 * +getdaysrented() : int +getmovie() : Movie * 1 Customer -name : string -rentals : Vector +statement() : string +addrental() +getname() : string nachher: Movie -title : string -pricecode : Price +getcharge() : double +getpricecode() : Price +setpricecode() +gettitle() : string +getfrequentrenterpoints() : int * Regular Price 1 Price +getcharge() : double +getfrequentrenterpoints() : int Childrens Price New Release Price 1 * +getcharge() : double +getcharge() : double +getcharge() : double +getfrequentrenterpoints() : int Rental -daysrented : int +getcharge() : double +getfrequentrenterpoints() : int +getdaysrented() : int * 1 Customer -name : string +statement() : string +addrental() +getname() : string PG Reclipse Seminar: Refactoring Jan-Christopher Bals (16/30)

17 Refactoring am Beispiel Auswirkungen auf das Design (dynamisch) vorher: statement() c:customer r:rental m:movie for all rentals getmovie() Determine amounts getpricecode getdaysrented() getmovie() Add Frequent Renter Points getpricecode getdaysrented() PG Reclipse Seminar: Refactoring Jan-Christopher Bals (17/30)

18 Refactoring am Beispiel Auswirkungen auf das Design (dynamisch) nachher: c:customer r:rental m:movie p:price statement() for all rentals getcharge getcharge getcharge getfrequentrenterpoints getfrequentrenterpoints getfrequentrenterpoints PG Reclipse Seminar: Refactoring Jan-Christopher Bals (18/30)

19 Refactoring Katalog Analyse bestehender OO-Software und deren Refaktorisierung ergab grundlegende Refactorings Zusammenstellung in einem Katalog hilft bei der Anwendung Semiautomatisches Refactoring durch Toolunterstützung Einteilung des Katalogs I. Methoden einführen II. Funktionalitäten zwischen Objekten verschieben III. Daten organisieren IV. Vereinfachung bedingter Ausdrücke V. Methodenaufrufe vereinfachen VI. Vererbung PG Reclipse Seminar: Refactoring Jan-Christopher Bals (19/30)

20 Refactoring Katalog I. Methoden Einführen Zu lange Codeblöcke sind unübersichtlich und erhöhen die Fehleranfälligkeit Einteilung in passende Methodenaufrufe erhöht die Lesbarkeit Unterstützenden Refactorings: Extract Method Inline Methode Replace Temp with Query... PG Reclipse Seminar: Refactoring Jan-Christopher Bals (20/30)

21 Refactoring Katalog II. Funktionalitäten zwischen Objekten verschieben Wo soll Programmlogik platziert werden? Unterstützenden Refactorings: Move Method Move Field Extract Class Introduce Local Extension... PG Reclipse Seminar: Refactoring Jan-Christopher Bals (21/30)

22 Refactoring Katalog III. Daten organisieren Umgang mit Daten kann vereinfacht werden bsp. Einführung neuer Datentypen Unterstützende Refactorings: Replace Data Value With Object Encapsulate Field Replace Typed Code With Class / Subclass... PG Reclipse Seminar: Refactoring Jan-Christopher Bals (22/30)

23 Refactoring Katalog IV. Vereinfachung bedingter Ausdrücke Bedingte Ausdrücke oft komplex Unterstützende Refactorings: Decompose Conditional Remove Control Flag Replace Conditional With Polymorphism... PG Reclipse Seminar: Refactoring Jan-Christopher Bals (23/30)

24 Refactoring Katalog V. Methodenaufrufe vereinfachen Namen und Struktur tragen wesentlich zum Programmverständnis bei Unterstützende Refactorings: Rename Method Add / Remove A Parameter Parameterize Method Introduce Parameter Object... PG Reclipse Seminar: Refactoring Jan-Christopher Bals (24/30)

25 Refactoring Katalog VI. Vererbung Wiederverwendbare Komponenten identifizieren Unterstützende Refactorings: Pull Up Field / Method / Constructor Body Push Down Field / Method Extract Superclass / Subclass Collapse Hierarchie... PG Reclipse Seminar: Refactoring Jan-Christopher Bals (25/30)

26 Unterstützung durch Tools Vollautomatisches Refactoring nicht möglich Beobachtbares Verhalten muss erhalten bleiben Tools können in gewissem Umfang den Erhalt dieses Verhaltens garantieren Semiautomatisches Refactoring sinnvoll PG Reclipse Seminar: Refactoring Jan-Christopher Bals (26/30)

27 Unterstützung durch Tools Programme müssen folgende Eigenschaften erfüllen: (durch Tools generierte Refactorings müssen diese erhalten) Eindeutige Oberklasse Eindeutige Namensbezeichnung für Klassen in ihrem Namensraum Eindeutige Namensbezeichnung für Methoden / Variablen innerhalb der Klassen Vererbte Variablen dürfen in Unterklassen nicht neu definiert werden Kompatible Signaturen für vererbte Methoden Typsichere Zuweisungen Semantisch äquivalente Referenzen und Operationen PG Reclipse Seminar: Refactoring Jan-Christopher Bals (27/30)

28 Unterstützung durch Tools Vergleich der Funktionalitäten ausgewählter Tools Tool RefactorIt Developer IDEA Eclipse JBuilder Jrefactory Hersteller RefactorIt IntelliJ IBM,... Borland Freeware Refactoring Encapsulate Field x x x Extract Method x x x x x Inline Method x x x Add / Remove Parameter x x x Pull Down Method x x x x x Push Up Method x x x x x Move method x x x x x Rename x x x x x PG Reclipse Seminar: Refactoring Jan-Christopher Bals (28/30)

29 Zusammenfassung Definition extern beobachtbares Verhalten erhalten Beispiel - iteratives, inkrementelles Vorgehen Unterstützung durch Katalog und Tools Nachteile nicht immer anwendbar (Datenbanken, öffentliche Schnittstellen) in Firmen schwer zu verkaufen PG Reclipse Seminar: Refactoring Jan-Christopher Bals (29/30)

30 Vielen Dank fürs Zuhören!...Fragen? PG Reclipse Seminar: Refactoring Jan-Christopher Bals (30/30)