Eine Weiterentwicklung eines Projektes führt natürlicherweise immer dazu, dass vorhandener Code immer unaufgeräumter wird. Ein Refactoring ist ein Umbau dieses unübersichtlichen Codes in übersichtlicheren. Äußerlich betrachtet scheint dies keinen neuen Nutzen zu bringen. Von der Programmierersicht ist ein Refactoring jedoch essentiell. An dieser Stelle seien einige Motivationen für ein Refactoring aufgezeigt:

Gründe für ein Refactoring und damit einen übersichtlichen Quellcode:

  • Programmierer des Teams können den vorhandenen Code besser verstehen und demzufolge mit diesem besser umgehen. Dies hat mehrere Dinge zur Folge:
  1. Eine bessere Verständnis des Codes führt dazu, dass neue Features schneller implementiert werden können. Demzufolge kann man ein Refactoring des Codes als Vorbereiten des Codes für Neuimplementierungen sehen.
  2. Da eine bessere Übersichtlichkeit entsteht, werden weniger Bugs eingebaut, bzw. vorhandene Bugs werden offensichtlich, da der Code verstanden wird.
  3. Auch können Programmierer, die neu dem Team zustoßen, sich in den schon vorhandenen Code besser einarbeiten.
  • Programmieren ist eine geistig anstrengende Arbeit. Zufriedene Programmierer arbeiten besser.
  1. Gibt es immer wieder Verständnissprobleme mit dem Code – wobei das Programm dann teilweise mühsam debuggt werden muss, um dessen Funktionalität zu verstehen – nähert sich der Programmierer seine Frustationsgrenze. Dies kann in ein inneres Aufgeben münden, wo die Software hoffnungslos verloren ist.
  2. Programmieren muss einen gewissen Spaß bereiten. Vor allen Dingen sollte der Programmierer die Frucht seiner Arbeit sehen und nicht in neu auftretenden Bugs ersticken. Ordentlicher Code gibt Programmierern Erfolgserlebnisse, so dass schnell und zügig entwickelt werden kann. Die Agilität der Software ist so hoch.

    Gründe, die gegen ein Refactoring sprechen:

    • Es muss zusätzliche Zeit investiert werden. Für Programmcode, der nicht weiterentwickelt werden soll und in Zukunft ersetzt werden soll, lohnt sich dies nicht. Bei Projekten, die allerdings noch weiterentwickelt werden, entsteht ein Vielfaches an Zeitersparnis am Ende der Implementierungsphase.
    • Ggf. können durch ein Refactoring Fehler dem Code hinzugefügt werden. Hiergegen ist entgegen zu wirken, indem zunächst Tests entwickelt werden, die den vorhandenen Code auf korrekte Arbeitsweise prüfen. Vor und nach dem Refactoring müssen diese Tests erfolgreich laufen. Positiver Nebeneffekt: Der Code der Tests kann behalten werden und auch für nachfolgende Entwicklungsvorhaben weiter verwendet werden.
    • Es entstehen durch bestimmte Refactorings sehr viele Änderungen im Code beispielsweise durch Umbenennen von Methoden. Resultat ist, dass abschließend Branches des Projektes schwer zusammen zu mergen sind.
    • Programmierer sind evtl. gewöhnt immer an der gleichen Stelle zu schauen, um neue Funktionsmerkmale eines Programms zu implementieren. Evlt. werden diese kurzfristig verwirrt, wenn bekannte Strukturen plötzlich verändert sind.

    Zu Weihnachten 1968 sendeten die Astronauten von Apollo 8 diesen Funkspruch aus dem Orbit des Mondes. Als sie die kalte und verkraterte Mondoberfläche betrachteten, merkten sie, wie privilegiert wir auf unserem Planeten sind, in Gottes wunderbarer Schöpfung zu leben und zitierten die ersten Verse der Bibel. Die volle Geschichte ist zum Beispiel unter Wikipedia nachlesbar.

    Ein weiteres Video hierüber:

    Während meiner Studienzeit entstand folgendes Plakat zum Thema Refactoring, welches das Thema auf einer Seite zusammen fasst. Ein Klick auf das Bild zeigt eine Vollansicht:

    Plakat-Refactoring

    Im folgenden sind die Folien des Vortrages wiedergegeben:

    Refactoring01Refactoring02Refactoring03Refactoring04Refactoring05Refactoring06Refactoring07Refactoring08Refactoring09Refactoring10Refactoring11Refactoring12Refactoring13Refactoring14Refactoring15Refactoring16Refactoring17Refactoring18Refactoring19Refactoring20Refactoring21Refactoring22Refactoring23Refactoring24

    Ein Video über den Kern des Evangeliums, welcher mir sehr am Herzen liegt. Entnommen aus dem Adventskalender von Soulsaver. Danke an diejenigen, die mit viel Mühe gegeben haben, künstlerisch diesen Inhalt wiederzugeben.

    Seit nunmehr einigen Jahren betreibt Google ein Produkt namens „Google App Engine“. Dabei handelt es sich um ein PaaS Cloud Produkt (Platform as a Service) in dem gerade in Mode gekommenen Cloud-Bereich. Google bietet hier eine Möglichkeit an, sowohl Python, J2EE wie auch Go-Programme als Webanwendungen zu deployen. Dahinter steht nicht nur ein Container z.B. für Servlets und JSPs, sondern auch die nötige Infrastruktur in der Datenhaltungsschicht, ein MemoryCache, Cronjobs oder entsprechende dauernd laufende Instanzen wie eine Taskqueue werden einem angeboten. Das gute an diesem Service ist, dass Google ein tägliches Start-Quota verschenkt, so dass sich die App Engine ohne Risiko ausprobieren lässt.

    Dasselbe habe ich getan, um Java-Applikationen zu deployen. Google stellt an dieser Stelle ein relativ komforables Plugin für Eclipse bereit, mit welchem sich die Applikationen sowohl lokal testen lassen als auch direkt per Mausklick in die Cloud hochladen lassen. Dies sieht in Eclipse Juno 4.2 so aus (um den Screenshot zu vergrößern, bitte auf das Bild klicken):

    Der Funktionsumfang ist sehr umfangreich. So lassen sich nicht nur JSPs oder Servlets wie standardmäßig entwickeln, sondern es sind sogar JDO oder gar JPA Features vorhanden. Um eine möglichst kleine Applikation zu testen, wurde eine Testapplikation geschrieben, die zunächst nur Dummyeinträge in den lokalen Big-Table-Storage von Google einfügt, von dem Google ein Gigabyte Freivolumen verschenkt.

    Was bei einer Belastung dieser Applikation auffällt, ist, dass das Freivolumen doch nicht so hoch ist, wie eigentlich angenommen, sondern dass relativ schnell einem die Freianfragen an die Big-Table-Datenbank ausgehen. Es bietet sich dann ein Bild wie das folgende in der Quota-Übersicht von Google:

    Auch ein Lesen lässt schnell den Quota auf Null schrumpfen (hier mit einer größeren Datenbank, die über mehrere Wochen angelegt worden ist):

    Interessanterweise tun sich beim Schreiben von Datensätzen sowohl der veraltete Master/Slave-Store wie auch der High Replication Store nicht viel. Beide sind ungefähr zum gleichen Moment Over-Quota. Die Master/Slave-Engine erreicht das Quota in einem Test bei 3179 Datenbankanfragen, die High Replication nach 3189. Selbstverständlich lässt sich hier dem eingeschränkten Quota mit Geld Abhilfe schaffen.

    Abhilfe von dem Bigtable-Problem schafft das Google Cloud SQL Angebot, welches eine SQL-Datenbank für den Entwickler bereit stellt. Auf diese kann direkt aus der Google App Engine zugegriffen werden. Leider ist diese Datenbanklösung auf einen relativ hohen Tagespreis umgestellt worden.

    Man merkt, dass sich die Google Cloud Lösungen für kleinere nicht so häufig besuchte Projekte sehr gut eignen, vor allen Dingen, wenn es wenig Datenbankabfragen gibt. Wird dieses Produkt jedoch für größere Webseiten eingesetzt, so kann dies relativ schnell sehr teurer werden.

    Große Pluspunkte sammelt die Engine in ihrer Stabilität und Standardkonformität ein. Wenn Sie dabei sind, ein Projekt starten zu wollen, so können Sie getrost mit der Google App Engine anfangen und hierauf entwickeln. Sobald die Zeit kommt, wo Sie aus der App Engine heraus wachsen, können Sie sich entscheiden, diese entweder weiter zu nutzen und einen höheren Preis zu bezahlen und dafür jedoch auch ihre Features wie die Lastverteilung und die Einsparung der Serveradministration zu nutzen, oder Sie können auf ein eigenes Serversystem umziehen. Google App Engine ermöglicht es Ihnen sowohl in der Bigtable-Variante wie auch in der Google Cloud SQL-Variante Ihre Daten jederzeit in und aus der Cloud zu portieren.

    Für mich ein sehr gelungenes Produkt für Start-Up-Projekte. Ich werde weiter dabei bleiben.

    Das Projekt befindet sich innerhalb des Workspaces (beispielsweise hier das Projekt AufgabeAP3):

    Mit einem rechten Mausklick auf das Projekt öffnen Sie das Kontextmenü und wählen „Export“:

    Export

    In dem sich nun öffnenden Fenster wählen Sie „Archive-File“:

    Export Eclipse Archive File

    In dem sich nun öffnenden Fenster ist das Projekt schon vorselektiert. Bitte stellen Sie sicher, dass hier das komplette Projekt selektiert ist:

    Export to ZIP Final Screen

    Wählen Sie nun unter Optionen „Save in zip format“ und „Create directory structure for files“ sowie „Compress the contents of the file”. Dies sollte normalerweise schon voreingestellt sein.

    Vergessen Sie nicht unter „To archive file“ die ZIP-Datei anzugeben, in welche das Projekt gespeichert werden soll.

    Nach dem Klick auf „Finish“ befindet sich das gepackte Projekt im entsprechenden Verzeichnis.

     

    Dieses Video zeigt den Export noch einmal (auf YouTube oder Vollbild im Player klicken, um es in Großansicht zu sehen):



    Durch Rechts-Klick auf den leeren Workspace öffnet sich wieder das Kontekt-Menü. Wählen Sie „Import“ -> „Import…

    Import Import Eclipse

    Im folgenden Fenster wählen Sie „General“ -> „Existing Projects into Workspace

    Existing Projects into Workspace

    Wählen Sie in dem folgenden Fenster „Select Archive File“ und wählen Sie über den Browse-Button rechts daneben das entsprechende ZIP-File aus. Unter „Projects“ werden Ihnen die enthaltenen Projekte in diesem ZIP-File angezeigt:

    Select Archive

    Mit einem Klick auf „Finish“ werden die Projekte importiert.

     

    Dieses Video zeigt dieses Vorgehen nochmals im Schnelldurchgang (auf YouTube oder Vollbild im Player klicken, um es in Großansicht zu sehen):



    Im Folgenden möchte ich gerne einige der Refactoring-Funktionalitäten von Eclipse demonstrieren. Für das Refactoring wird ein JUnit-Test, so wie es Ziel der eXtreme-Programming-Methodik ist, benutzt, um zu prüfen, ob die originale Funktionalität noch vorhanden ist. Die Anleitung demonstriert die Fähigkeiten der Eclipse-Entwicklungsumgebung das Rafactoring mit JUnit zu unterstützen, zeigt jedoch im letzten Schritt auch Grenzen auf, so wieder ein händisches Vorgehen vonnöten ist.

    Vielfach wurden die Sourcen der Anleitung erwünscht. Das Projekt zu Beginn befindet sich in vorRefactoring.zip, das Projekt nach allen Refactoringschritten befindet sich in nachRefactoring.zip.

    /**
     * AdressAusgabe.java
     * Klasse zur Ausgabe eines Adressbucheintrages
     * @author Christoph Tornau
     *
     */
    public class AdressAusgabe {
     
    	public String name;
    	public String vorname;
    	public String strasse;
    	public String plz;
    	public String ort;
     
    	public AdressAusgabe(String name, String vorname, String strasse, String plz, String ort  ) {
    		this.name = name;
    		this.vorname = vorname;
    		this.strasse = strasse;
    		this.ort = ort;
    		this.plz = plz;
    	}
     
    	public String toString()
    	{
    		String output = "";
     
    		output += ("***");
    		output += (name);
    		for (int i= name.length() + 3; i<30; i++)
    			output += ("*");
    		output += ("\n");
     
    		output += ("***");
    		output += (vorname);
    		for (int i= vorname.length() + 3; i<30; i++)
    			output +=("*");
    		output += ("\n");
     
    		output += ("***");
    		output += (strasse);
    		for (int i= strasse.length() + 3; i<30; i++)
    			output += ("*");
    		output += ("\n");
     
    		output += ("***");
    		output += (plz);
    		for (int i= plz.length() + 3; i<30; i++)
    			output +=("*");
    		output += ("\n");
     
    		output += ("***");
    		output += (ort);
    		for (int i= ort.length() + 3; i<30; i++)
    			output +=("*");
    		output += ("\n");
     
    		output += ("***");
    		output += ("");
    		for (int i= "".length() + 3; i<30; i++)
    			output +=("*");
    		output += ("\n");
     
    		return output;
    	}
     
    	/**
    	 * Main method
    	 * @param args
    	 */
    	public static void main(String[] args) {
     
    		AdressAusgabe myAdresse1 = new AdressAusgabe ("Maier","Hans",
    				"Musterstrasse 1","11111","Musterstadt");
    		System.out.println(myAdresse1);
     
    		AdressAusgabe myAdresse2 = new AdressAusgabe ("Gustav","Morgan",
    				"Pappelallee 15","53122","Bonn");
    		System.out.println(myAdresse2);
     
    	}
    }

    An der Beispielklasse fallen uns folgende Bad-Smells sofort auf:

    • Der Code für die Ausgabe ist in mehrfacher Ausführung vorhanden.

    • Anscheindend wurde darauf verzichtet in eine extra Datenklasse zu kapseln. Alles ist in einer Klasse geschrieben. Man sollte auf jeden Fall trennen.

    • Felder können von außen gelesen und geschrieben werden. Es gibt keine Getter- und Setter-Methoden.

    Der Code verfügt über einen JUnit-Test, wie folgender Screenshot zeigt:

    Wir führen nun folgende Refactorings nacheinander durch. Nach den einzelenen Schritten führen wir jedesmal einen Test mit JUnit durch. Ds Refactoring kann nur fortgeführt werden, wenn der Balken grün bleibt. Ansonsten haben wir einen Fehler gemacht. Hier der grüne Balken:

    1. Extract Method:

    Nun entsteht eine neue Methode im Code:

    private String printPart(String output) {
    		output += ("***");
    		output += (name);
    		for (int i= name.length() + 3; i<30; i++)
    			output += ("*");
    		output += ("\n");
    		return output;
    	}

    Wir sehen, dass diese Methode als „private“ deklariert ist und den output-String sowohl bekommt als auch wieder ausgibt. Nach dem Extrahieren der Methode können wir die JUnit-Tests ausführen, um zu prüfen, ob die Programmfunktionalität zerstört worden ist.

    2. Ändern des Methoden-Aufrufs

    Wir wollen den String, welcher übergeben wird, in die Ausgabe statt „name“ einbauen. Gleichzeitig wollen wir den Originalstring nicht mehr übergeben:

    Nun gibt es einige Fehlermeldungen:

    Wir ignorieren diese und ändern den Code per Hand um:

    	private String printPart(String stringToPrint) {
     
    		String output = "";
    		output += ("***");
    		output += (stringToPrint);
    		for (int i= stringToPrint.length() + 3; i<30; i++)
    			output += ("*");
    		output += ("\n");
    		return output;
    	}

    Ebenso ändern wir den Methodenaufruf per Hand um in

    output = printPart(name);

    Nun können wir per Hand die hinzugefügte Methode ändern und elimieren so den dupplizierten Code:

    public String toString()
    	{
    		String output = "";
     
    		output += printPart(name);
    		output += printPart(vorname);
    		output += printPart(strasse);
    		output += printPart(plz);
    		output += printPart(ort);
    		output += printPart("");
     
    		return output;
    	}

    Nachdem wir dies durchgeführt haben, müssen wir wiederum die JUnit-Tests ausführen und erhalten als Ergebnis, dass der Code immernoch lauffähig ist.

    3. Neue Klasse erzeugen und Methoden bewegen

    Nun möchten wir gerne eine Datenklasse erzeugen, um die Daten von der Hauptklasse abzutrennen:

    Wir bewegen zunächst die Methode printPart, nachdem wir deren Methoden Signatur etwas geändert haben:

    Unser Code ändert sich automatisch mit

    	public String toString()
    	{
    		String output = "";
     
    		output += Adresse.printPart(name);
    		output += Adresse.printPart(vorname);
    		output += Adresse.printPart(strasse);
    		output += Adresse.printPart(plz);
    		output += Adresse.printPart(ort);
    		output += Adresse.printPart("");
     
    		return output;
    	}

    Leider können wir die restlichen Methoden mit Eclipse nicht automatisch verschieben, weshalb wir sie per Hand verschieben, so dass die neue Klasse wie folgt aussieht:

    public class Adresse {
     
    	public String name;
    	public String vorname;
    	public String strasse;
    	public String plz;
    	public String ort;
     
    	public Adresse(String name, String vorname, String strasse, String plz, String ort  ) {
    		this.name = name;
    		this.vorname = vorname;
    		this.strasse = strasse;
    		this.ort = ort;
    		this.plz = plz;
    	}
     
    	public String toString()
    	{
    		String output = "";
     
    		output += Adresse.printPart(name);
    		output += Adresse.printPart(vorname);
    		output += Adresse.printPart(strasse);
    		output += Adresse.printPart(plz);
    		output += Adresse.printPart(ort);
    		output += Adresse.printPart("");
     
    		return output;
    	}
     
    	public static String printPart(String stringToPrint) {
     
    		String output = "";
    		output += ("***");
    		output += (stringToPrint);
    		for (int i= stringToPrint.length() + 3; i<30; i++)
    			output += ("*");
    		output += ("\n");
    		return output;
    	}
     
    }

    Hier hinkt nun unser JUnit-Test. Der Grund hierfür ist, dass sich der Klassenname der zu prüfenden Klasse geändert hat, da die Funktionalität per Hand verschoben worden ist. In diesem Fall dürfen wir jedoch unseren JUnit-Test anpassen, indem wir dort den Klassennamen ändern.

    Wir setzen die Methode printPart wieder privat.

    Noch immer sind die Felder „public“ Wir wenden Encapsulate Field an.

    Wir führen die JUnit-Tests nochmals durch. Wir sehen, dass der Balken weiter grün ist. Das Refactoring war erfolgreich und wir haben viel schöneren Code erhalten.

    Während meines Studiums habe ich unterschiedliche Zusammenfassungen zur Aufbereitung der Lerninhalte und des persönlichen Verständnisses geschrieben. Diese Zusammenfassungen möchte ich nicht vorenthalten. Die folgende Liste erhebt jedoch keinen Anspruch auf Vollständigkeit.

    SS 2003
    Neuronale Netze PDF

    WS 2002/2003
    Mathematik Zusammenfassung Lineare Algebra. Die letzte Prüfung meines Vordiploms. Die Vordiplomprüfung beinhaltet natürlich auch die Analysis. Diesen Teil und einen Teil der LA habe ich jedoch herausgenommen. HTML

    SS 2002
    Lernzusammenfassung über Anorganische und Organische Chemie PDF

    WS 2001/2002
    Neue Lernzusammenfassung für die Vorlesung Informatik III und Informatik IV zur Vorbereitung der Informatik B-Prüfung PDF

    SS 2001

    Zusammenfassung Vorlesung Stochastik PDF DVI
    Lernzusammenfassung Informatik IV neue Version vom 24.8.2001 PDF

    WS 2000/2001
    Proseminarvortrag: Informationssysteme – B-Bäume Ausarbeitung PDF Folien PPT PDF

    SS 2000
    Lineare Algebra I: Formelsammlung zur Klausur PDF
    Informatik A: Lernsachen zur Vordiplomsklausur PDF