Legacy Code meistern in x einfachen Schritten

Transkript

1 Legacy Code meistern in x einfachen Schritten Version: 1.0 Orientation in Objects GmbH Weinheimer Str Mannheim info@oio.de Abstract In einer idealen Welt würden wir nur "neuen" Code schreiben, der natürlich perfekt und wunderschön ist. Wir müssten nie wieder unseren Code anschauen, geschweige denn 10 Jahre alte Projekte warten. Ende des Tagtraums... Leider ist unsere Welt nicht so ideal, unser Code von gestern ist heute schon Legacy. Diesen im Nachhinein zu verstehen, zu erweitern oder darin Fehler zu beheben, ist immer eine Herausforderung, insbesondere wenn Tests fehlen. Trotzdem gibt es einfache Möglichkeiten, wie man die Qualität von Legacy-Code verbessern kann. Das Wichtigste ist das Einziehen von Fangnetzen, sodass man trotz fehlender Tests guten Gewissens Änderungen durchführen kann. Wer Golden Master, Subclass to Test und Extract Pure Functions an konkreten Beispielen kennenlernen möchte, ist in dieser Session genau richtig Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 2 1

2 Über mich Falk Sippach Trainer, Berater, Entwickler Co-Organisator Schwerpunkte Architektur Agile Softwareentwicklung Codequalität 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 3 Java, XML und Open Source seit 1998 ) Software Factory ) Schlüsselfertige Realisierung von Java Software Individualsoftware Pilot- und Migrationsprojekte Sanierung von Software Software Wartung ) Object Rangers ) Unterstützung laufender Java Projekte Perfect Match Rent-a-team Coaching on the project Inhouse Outsourcing ) Competence Center) Schulungen, Coaching, Weiterbildungsberatung, Train & Solve-Programme Methoden, Standards und Tools für die Entwicklung von offenen, unternehmensweiten Systemen 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 4 2

3 Legacy Code meistern in x einfachen Schritten Nur heute, nicht 1, nicht 2, 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 5 Unser Thema heute: Refactoring Legacy Code Disclaimer: KEIN Projekterfahrungsbericht 6 3

4 Live-Coding Foto von StockSnap: (CC0 Public Domain Lizenz) 7 Vermächtnis Erbe LEGACY Altlast Hinterlassenschaft Foto von smpcas, CC0 Public Domain Lizenz, 8 4

5 Legacy Code Somebody else's code Jeder kennt ihn Keiner mag ihn Was ist mit unserem eigenen Code? 9 Refactoring Legacy Code Warum? Verstehen Erweitern Bugfixing Optimierung Grafik von ClkerFreeVectorImages: (CC0 Public Domain Lizenz) 10 5

6 Refactoring Legacy Code Annahmen Es gibt automatisierte Tests Quellcode ist schon testbar 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 11 Refactoring Legacy Code Code Smells Temporary Field Long Method Feature Envy Code Comments

7 "Gimme Google, Stack Overflow, and this keyboard, and I'll program you anything. " Duplicated Code 13 Refactoring Legacy Code Code without tests 14 7

8 Code without tests is bad code. Michael Feathers 15 Legacy code is valuable code that we feel afraid to change. J. B. Rainsberger Foto von PublicDomainPictures, CC0 Public Domain Lizenz,

9 Es ist egal, wie gut geschrieben der Code ist schön der Code ist objektorientiert der Code ist entkoppelt der Code ist Tests lassen unser Verhalten schnell und verifizierbar ändern Ohne Tests wissen wir nicht, ob der Code besser oder schlechter wird 17 Die gute Nachricht Keine Wissenschaft Gesunder Menschenverstand Foto von Engel62: (CC0 Public Domain Lizenz) 18 9

10 Was macht es dann schwierig? Hello World vs LOC Disziplin (kleine Schritte, ) Aussagekräftige Testabdeckung 19 Legacy zu Clean Code? Clean Code ist NICHT das Ziel Hauptfokus: testbarer Code 20 10

11 Dann schreiben wir halt Tests viel zu teuer Code meist kaum/nicht testbar starke Kopplung, geringe Kohäsion 21 um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten Die Katze müßtebeißt man refactoren, sich um zu refactoren könnte man Tests schreiben, in um den Tests Schwanz! zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refactoren, um zu refactoren könnte man Tests schreiben, um Tests zu schreiben muß der Code testbar sein, um testbaren Code zu erhalten müßte man refact 22 11

12 refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu Henne-Eiverstehen könnte man Code refactoren, um Code zu refactoren bräuchte Problem man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu verstehen, um Code zu verstehen könnte man Code refactoren, um Code zu refactoren bräuchte man Tests, Tests würden helfen, Code zu 23 Vorgehen 1. Identify what to change 2. Identify what to test 3. Break dependencies 4. Write the tests 5. Modify and refactoring 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 24 12

13 No Silver Bullet Jedes Projekt individuell Vorsicht beim Beheben von offensichtlichen Fehlern Foto von stevepb: (CC0 Public Domain Lizenz) 25 Dann mal her mit den x einfachen Schritten! 26 13

14 A Sicherheitsnetz + Tests Foto von bella67: (CC0 Public Domain Lizenz) 27 B Sanierung Foto von KlausHausmann: (CC0 Public Domain Lizenz) 28 14

15 1 Golden Master gegenwärtiges Verhalten dokumentieren und erhalten Foto von istara: (CC0 Public Domain Lizenz)

16 Konsolenausgaben abprüfen 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 31 Was mache ich bei GUI-Anwendungen? public static void main(string... args) throws Exception { WebDriver driver = new FirefoxDriver(); driver.get(" while (true) { List<WebElement> links = driver.findelements(by.tagname("a")); links.get(random.nextint(links.size())).click(); Thread.sleep(500); List<WebElement> fields = driver.findelements(by.xpath("//input[@type='text']")); WebElement field = fields.get(random.nextint(fields.size())); field.sendkeys(randomstring()); Thread.sleep(500); } } Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 32 16

17 Live-Coding Foto von StockSnap: (CC0 Public Domain Lizenz) 33 1 Golden Master Vorsicht bei Zufallsgeneratoren Festlegen von Seeds (Pseudo-Random) 34 17

18 2 Subclass To Test Foto von chrisli8020: (CC0 Public Domain Lizenz) 35 2 Subclass To Test Seam (Nahtstelle) Ein Seam ist eine Stelle, an der man das Verhalten editieren kann, ohne direkt an dieser Stelle zu ändern. Aufbrechen stark gekoppelter Abhängigkeiten aka Extract and Override 36 18

19 3 Extract Pure Functions Foto von PublicDomainPictures: (CC0 Public Domain Lizenz) 37 3 Extract Pure Functions seiteneffektfrei keine Statusänderung "It's a classic, we call it a Klassiker" 38 19

20 3 Extract Pure Functions "pure function".substring(5); UrlEncoder.encode("pure function"); Math.max(x, y); System.out.println("unpure"); list.add(3); Collections.sort(list); 39 3 Extract Pure Functions Codestellen isolieren Ziele Separat testbar Duplikation reduzieren 40 20

21 4 Remove Duplication Don't Repeat Yourself Beachte: Rule of Three Foto von AdinaVoicu: (CC0 Public Domain Lizenz) 41 5 Extract Class Large class SRP verletzt Ziele Unabhängiges Testen einzelner Teile Sauberes OO-Design Foto von blickpixel: (CC0 Public Domain Lizenz) 42 21

22 6 Dependency Inversion 7 Dependency Inversion Test non-public member Dependency Inversion 8 Mocking Framework 43 Zusammenfassung 44 22

23 Golden Master Subclass To Test Extract Pure Functions Remove Duplication Extract Class Dependency Inversion Test non-public member Mocking Framework 45 1 Golden Master 46 23

24 Subclass To Test Extract Pure Functions Extract Class Dependency Inversion Test non-public member Mocking Framework Extract Pure Functions Remove Duplication Extract Class 48 24

25 Tools Code Coverage Approval Tests Infinitest Eclipse Metrics 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 49 Legacy Code Retreat Foto von Jmabel: (CC BY-SA 3.0 Lizenz) 50 25

26 Links Code-Beispiel der Live-Demo anderes Code-Beispiel für Legacy Code Blog: Techniken zu Legacy Code-Retreat Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 51 Literaturhinweise Refactoring Sprache: Englisch Gebunden Seiten - Addison Wesely Erscheinungsdatum: 1. Juni 1999 ISBN: Working Effectively with Legacy Code Sprache: Englisch Gebunden 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 52 26

27 ?? Fragen??? Orientation Objects GmbH Weinheimer Str Mannheim Vielen Dank für ihre Aufmerksamkeit! Orientation in Objects GmbH Weinheimer Str Mannheim 27

28 Zusatzmaterial 6 Dependency Inversion 7 Dependency Inversion Test non-public member Dependency Inversion 8 Mocking Framework 2017 Orientation in Objects GmbH Legacy Code meistern in x einfachen Schritten 55 6 Dependency Inversion Entkoppeln durch explizites Setzen der Abhängigkeiten Foto von tatlin: (CC0 Public Domain Lizenz) 56 28

29 7 Test non-public member Wirklich? Gute Alternative bei Legacy Code! Foto von Guian Bolisay: (CC BY-SA 2.0) 57 8 Mocking Subclass To Test on Steorids! Interaktion mit Umgebung testen Erwartete Parameter und Aufrufreihenfolge Foto von tatlin: (CC0 Public Domain Lizenz) 58 29