Refactoring C# Legacy Code

Transkript

1 Refactoring C# Legacy Code Stefan

2 Houston, we ve had a problem.

3 Wandelbarkeit

4 Funktionale Anforderungen Investitionsschutz = Wandelbarkeit Nicht-funktionale Anforderungen

5 Das Problem besteht aus drei Teilen: Lesbarkeit/Verständlichkeit ist nicht gegeben Automatisierte Tests fehlen Komplexe Refactorings sind notwendig

6 Das Dilemma: Um Tests zu ergänzen, => muss refactored werden. Um zu refactoren, => müssen Tests ergänzt werden.

7 KISS - Keep It Simple Stupid Einfach in Bezug auf Schreiben / Erstellen? Lesen / Modifizieren!

8 Ein Sicherheitsnetz spannen: Versionskontrolle Continuous Integration Code Reviews Automatisierte Tests

9 Begründung für Refactorings: NICHT: Clean Code Developer, Prinzipien, Werte, Craftsmen, Sondern Kundennutzen: Neues Feature Bugfix

10 Es gibt zwei Arten von Refactorings: einfache und komplexe.

11 Einfache Refactorings Vollständig werkzeuggestützt durchführbar Rename Extract Method Introduce Variable Introduce Parameter etc.

12 Komplexe Refactorings Nicht mehr ausschließlich werkzeuggestützt durchführbar

13 Einfache Refactorings Lesbarkeit herstellen. Erkenntnisse über den Code im Code sichern.

14 public double Endpreis(int anzahl, double netto) { } return (anzahl * netto) * 1.19; Introduce Variable public double Endpreis(int anzahl, double netto) { var nettopreis = anzahl * netto; return nettopreis * 1.19; } Introduce Variable public double Endpreis(int anzahl, double netto) { var nettopreis = anzahl * netto; var bruttopreis = nettopreis * 1.19; return bruttopreis; }

15 public double Endpreis(int anzahl, double netto) { var nettopreis = anzahl * netto; var bruttopreis = nettopreis * 1.19; return bruttopreis; } Nicht mehr nur toolgestützt! public double Endpreis(int anzahl, double netto) { const double mwst = 0.19; var nettopreis = anzahl * netto; var steuer = nettopreis * mwst; var bruttopreis = nettopreis + steuer; } return bruttopreis;

16 "a=1;b=2;c=3" => {{"a", "1"},{"b", "2"}, {"c", "3"}} public IDictionary<string, string> ToDictionary(string configuration) { return InsertIntoDictionary(SplitIntoKeyValuePairs( SplitIntoSettings(configuration))); }

17 public IDictionary<string, string> ToDictionary(string configuration) { return InsertIntoDictionary(SplitIntoKeyValuePairs( SplitIntoSettings(configuration))); } Introduce Variable public IDictionary<string, string> ToDictionary(string configuration) { var settings = SplitIntoSettings(configuration); var pairs = SplitIntoKeyValuePairs(settings); var result = InsertIntoDictionary(pairs); } return result;

18 public IDictionary<string, string> ToDictionary(string configuration) { // Split configuration into settings var settings = configuration.split(';'); // Split settings into key/value pairs var pairs = new List<KeyValuePair<string, string>>(); foreach (var setting in settings) { var keyandvalue = setting.split('='); pairs.add(new KeyValuePair<string, string>(keyandvalue[0], keyandvalue[1])); } // Insert pairs into dictionary var result = new Dictionary<string, string>(); foreach (var pair in pairs) { result.add(pair.key, pair.value); } Extract Method } return result;

19 public IDictionary<string, string> ToDictionary(string configuration) { var settings = SplitIntoSettings(configuration); var pairs = SplitIntoPairs(settings); var result = InsertIntoDictionary(pairs); return result; }

20 foreach (var setting in settings) { var key_and_value = setting.split('='); result.add(key_and_value[0], key_and_value[1]); } Extract Method foreach (var setting in settings) { } AddSettingToResult(setting, result); private static void AddSettingToResult(string setting, Dictionary<string, string> result) { var key_and_value = setting.split('='); result.add(key_and_value[0], key_and_value[1]); }

21 if (DateTime.Now >= weckzeit) { using (var soundplayer = new SoundPlayer(@"chimes.wav")) { soundplayer.play(); } timer.stopp(); Extract Method } if (WeckzeitErreicht()) { using (var soundplayer = new SoundPlayer(@"chimes.wav")) { soundplayer.play(); } timer.stopp(); } private bool WeckzeitErreicht() { } return DateTime.Now >= weckzeit;

22 if (WeckzeitErreicht()) { using (var soundplayer = new SoundPlayer(@"chimes.wav")) { soundplayer.play(); } timer.stopp(); } private bool WeckzeitErreicht() { return DateTime.Now >= weckzeit; Extract Method } if (WeckzeitErreicht()) { } Wecken();

23 public string Format(string vorname, string nachname, string strasse, string hn, string plz, string ort) { return $"{vorname} {nachname}, {strasse} {hn}, {plz} {ort}"; } public string Format(Adresse adresse, string vorname, string nachname) { return $"{vorname} {nachname}, {adresse.strasse} {adresse.hn}, {adresse.plz} {adresse.ort}"; } Extract Class from Parameters

24 public class Adresse { private string strasse; private string hn; private string plz; private string ort; public Adresse(string strasse, string hn, string plz, string ort) { this.strasse = strasse; this.hn = hn; this.plz = plz; this.ort = ort; } public string Strasse { get { return strasse; } }... }

25 public string[] CsvTabellieren(string[] csvzeilen) { _csvzeilen = csvzeilen; RecordsErstellen(); int[] breiten = SpaltenbreitenErmitteln(); TabelleErstellen(breiten); } return _tabelle; public string[] CsvTabellieren(string[] csvzeilen) { var records = RecordsErstellen(csvZeilen); int[] breiten = SpaltenbreitenErmitteln(records); var tabelle = TabelleErstellen(breiten, records); } return tabelle;

26 Automatisierte Tests ergänzen

27 Herausforderungen beim Ergänzen von Tests: Abhängigkeiten Aspekte nicht getrennt Ressourcenzugriffe Sichtbarkeit Globaler Zustand

28 Lösungen: Zunächst vermehrt Integrationstests, dann Refactoring und Unit Tests ergänzen. Mock Frameworks wie TypeMock Isolator oder Telerik JustMock einsetzen.

29 Viele Integrationstests Wenige Integrationstests Viele Unittests Wenige Unittests

30 using System.Collections.Generic; using System.IO; namespace ressourcen { public class CsvReader { public IEnumerable<string[]> Read(string filename) { var lines = File.ReadAllLines(filename); foreach (var line in lines) { var fields = line.split(';'); yield return fields; } } } } Integrierter Ressourcenzugriff

31 [Test, Isolated] public void Isolated_logic_test() { var sut = new CsvReader(); Isolate.WhenCalled(() => File.ReadAllLines("")).WillReturn(new[] { "a;b;c", "1;2;3" }); Verhalten der Attrappe beschreiben var records = sut.read("egal.csv").toarray(); } Assert.That(records[0], Is.EqualTo(new[] { "a", "b", "c" })); Assert.That(records[1], Is.EqualTo(new[] { "1", "2", "3" }));

32 public class PrivatesZeugs { private void SaveToDatabase(string data) { Console.WriteLine("Ressourcenzugriff..." + data); throw new Exception(); } } public void DoSomething() { Console.WriteLine("DoSomething..."); SaveToDatabase("daten daten daten..."); }

33 [TestFixture] public class PrivateMethoden { [Test] public void Private_Methode_nicht_ausführen() { var sut = new PrivatesZeugs(); Isolate.NonPublic.WhenCalled(sut, "SaveToDatabase").IgnoreCall(); } } sut.dosomething(); Verhalten der Attrappe beschreiben

34 Komplexe Refactorings Mikado Methode

35 Change

36 Change

37 Change

38 Change

39 Change

40 Change

41 Change

42 Change

43 Change

44 Hm ist das wirklich clever?

45 Change

46 Change Cha

47 Change Cha

48 B Change Cha

49 Revert! B Change Cha

50 B Change Cha

51 B C D Change Cha

52 Revert! B C D Change Cha

53 B C D Change Cha

54 B C D Change Cha

55 E B C D Change Cha

56 Revert! E B C D Change Cha

57 E B C D Change Cha

58 E B C D Change Cha

59 E B C F D Change Cha

60 Revert! E C B F D Change Cha

61 E B C F D Change Cha

62 E B C F D Change Cha

63 E A B C F D Change Cha

64 Revert! E C B A F D Change Cha

65 Change

66 Change

67 Change

68 Change

69 Change

70 Change

71 Change

72 Change

73 Change

74 Change

75 Change

76 Change

77 Change

78 Change

79 Hurra!

80 A B Change C D E F

81 A n a l y s e E C B A F R e f a c t o r i n g D Change

82 Start Das Mikado Ziel notieren Das Ziel bzw. die aktuelle Vorbedingung naiv implementieren Ergibt die Änderung Sinn? Ja Nein Gibt es ein Problem? Nein Commit der Änderungen in die Versionskontrolle Ja Nach Lösungen suchen Ist das Mikado Ziel erreicht? Nein Die Lösungen als Vorbedingungen im Mikado Graph notieren Fertig! Ja Verwerfen aller Änderungen mit Hilfe der Versionskontrolle Nächste Vorbedingung auswählen, um damit zu arbeiten

83 Änderung naiv ausführen. Herausfinden, was kaputt gegangen ist. Dies sind die Vorbedingungen für die Änderung. Visualisieren: zum Mikado Graph hinzufügen REVERT!!! Wiederholen, bis nichts mehr kaputt geht.

84 Demo

85 Uhrzeit wird fortlaufend angezeigt

86 Uhrzeit wird fortlaufend angezeigt Eigene Timerklasse erstellen

87 Uhrzeit wird fortlaufend angezeigt Eigene Timerklasse integrieren Eigene Timerklasse erstellen

88 Uhrzeit wird fortlaufend angezeigt Anzeigen der Uhrzeit auf eigenem Event Eigene Timerklasse integrieren Eigene Timerklasse erstellen

89 Uhrzeit wird fortlaufend angezeigt Anzeigen der Uhrzeit auf eigenem Event Anzeigen von Uhrzeit und REstzeit trennen Eigene Timerklasse integrieren Eigene Timerklasse erstellen

90 Unterziel A n a l y s e Unterziel Unterziel Unterziel Unterziel Unterziel Unterziel R e f a c t o r i n g Ziel

91 Vorteile der Mikado Methode Immer auslieferbar Nur auf dem Trunk, kein Branching Fokus auf das Ziel; nur das Nötigste tun Visualisierung

92 Fazit Einfache Refactorings: Lesbarkeit Automatisierte Tests: Korrektheit Komplexe Refactorings: Wandelbarkeit

93 Onlinekurs Automatisiertes Testen von.net Anwendungen zur Zeit kostenlos

94 Fragen?

95