Refactoring. Introductie Verschillende refactoringstappen

Transcriptie

1 Refactoring Introductie Verschillende refactoringstappen

2 Behoort tot de basisvocab van sw. ontwikkelaars. Fowler, Met bijdrage van o.a. Erich Gamma (GOF) en Kent Beck (JUnit) 2

3 Suboptimaal software Complexiteit en flexibiliteit van de componenten van de software niet optimaal. Leidt tot hoger onderhoud (bug fixing, feature aanpassen, feature toevoegen) kosten Onderschat onderhoud niet vaak grote kostenpost! 3

4 Refactoring Refactoring is transformatie op (de code van) een software om de software makkelijker te begrijpen en te onderhouden; de transformatie mag de observeerbaar gedraag van de software niet veranderen. Dus bijvoorbeeld performance is niet de hoofddoel van refactoring. 4

5 Bad smells in software Indicatoren dat refactoring nodig is: Code duplicatie Lange methode, grote klasse Methode met veel parameters Divergent fix, shotgun fix Feature envy Switch Temporary field (tijdelijk attribuut) Commentaar 5

6 Hoe doen we dat? 6 Formele theorie van refactoring? Klassen zijn echter complex (attributen, methoden, toegangmodifiers, statics, inheritence ), zulke theorie wordt snel onpraktisch. We doen refactoring als een serie van kleine stappen. Zoals: Geef een betere naam aan een methode Extractie van een block code tot een methode We leunen op testing om te garanderen dat elke stap de software consistent houdt. (retest na elke stap!) Maar deze zijn toch slechts cosmetische modificaties? niet erg belangrijk? De doel van refactoring is pragmatische onderhoud Refactoring doen we structureel

7 Refactoring doen we structureel Regelmatig In principe kun je je eigen refactoringstappen bedenken. Fowler s cataloog (~50) nuttig als je basis vocabulaire. Je hebt een goede test suite nodig Dekkend Autonoom 7

8 Voorbeeld LeenInfo - aantaldagen * leent Klant - naam - KlantPunten + leen(uitleen) + terug(uitleen) + mkfactuur() film * Film - titel -prijscode : int +$ KINDER +$ STANDAARD +$ NIEUW Hypothetisch nemen we aan dat dit een onderdeel van een groot software getter en setter impliciet bron: Fowler 8

9 Flattening associatieklasse leent * leeninfos LeenInfo - aantaldagen Klant - naam - KlantPunten + leen(uitleen) + terug(uitleen) + mkfactuur() film 1 Film - titel -prijscode : int +$ KINDER +$ STANDAARD +$ NIEUW Omdat Java geen 1 e klass associatieklasse niet heeft Alleen voor uitleg laat ik de assoc. klasse omgezet naar gewone klassen en relaties 9

10 10 mkfactuur() { double totprijs = 0 int punten = 0 println( Factuur voor + naam) for (LeenInfo v : leeninfos) { // bereken de huurprijs van v double v_prijs = 0 switch (v.getfilm().getprijscode()) { case Film.GEWOON : v_prijs = ; break case Film.NIEUW : v_prijs = ; break case Film.KINDER : v_prijs = ; break totprijs += v_prijs // bereken verkregen klantpunten uit v punten++ if (v.getfilm().getprijscode()==film.nieuw) punten++ println( Film + v.getnaam() +, prijs + v_prijs) println( Tot prijs + totprijs) println( Punten verdiend + punten)

11 11 mkfactuur() { double totprijs = 0 int punten = 0 println( Factuur voor + naam) for (LeenInfo v : leeninfos) { // bereken de huurprijs van v double v_prijs = 0 switch (v.getfilm().getprijscode()) { case Film.GEWOON : v_prijs = ; break case Film.NIEUW : v_prijs = ; break case Film.KINDER : v_prijs = ; break totprijs += v_prijs // bereken verkregen klantpunten uit v punten++ if (v.getfilm().getprijscode()==film.nieuw) punten++ println( Film + v.getnaam() +, prijs + v_prijs) println( Tot prijs + totprijs) println( Punten verdiend + punten) extract method : promoveer een groep statement tot een methode commentaar geeft hint neem de context ook mee!

12 Is dit nu makkelijker om te begrijpen of niet?? mkfactuur() { double totprijs = 0 int punten = 0 println( Factuur voor + naam) for (LeenInfo v : leeninfos) { double v_prijs = berekenprijs(v) totprijs += v_prijs punten += berekenpunten(v) println( Film + v.getnaam() +, prijs + v_prijs) println( Tot prijs + totprijs) println( Punten verdiend + punten) Discussiepunt: de tijdelijke lokale variabele 12

13 Maar dit gaat toch ten koste van performance 13 mkfactuur() { double totprijs = 0 int punten = 0 println( Factuur voor + naam) for (LeenInfo v : leeninfos) { berekenprijs(v) double v_prijs = berekenprijs(v) totprijs += v_prijs punten += berekenpunten(v) println( Film + v.getnaam() +, prijs + v_prijs) println( Tot prijs + totprijs) println( Punten verdiend + punten) replace temp with query Fowler s stelling: 90% van de tijd is je software bezig met 10% van je code. Performance optimalisatie is makkelijker na refactoring. (gebruik profiler!)

14 class Klant { berekenprijs(leeninfo v) { double v_prijs = 0 switch (v.getfilm().getprijscode()) { case Film.GEWOON : v_prijs = ; break case Film.NIEUW : v_prijs = ; break case Film.KINDER return v_prijs : v_prijs = ; break Film Film Switch over type vluchtig replace type-code with Strategy GewoneFilm NieuweFilm KinderFilm 14 Werkt helaas niet we willen de prijscode van een film ook dynamisch te kunnen veranderen.

15 Switch switch (expressie) { case 0 : doe iets ; break case 1 : doe iets ; break case 9 : doe iets ; 15

16 Na replace type-code with Strategy LeenInfo aantaldagen 1 Film berekenprijs(v) 1 PrijsStrategie prijs(n) * GewonePrijs 16 Klant mkfactuur () mkfactuur() { double totprijs = 0 v.getfilm().berekenprijs(v) int punten = 0 println( Factuur voor + naam) for (LeenInfo v : leeninfos) { totprijs += berekenprijs(v) punten += berekenpunten(v) println( Film + v.getnaam() +, prijs + berekenprijs(v)) println( Tot prijs + totprijs) println( Punten verdiend + punten) NieuwePrijs KinderPrijs

17 LeenInfo aantaldagen 1 Film berekenprijs() prijs 1 PrijsStrategie prijs(n) * KinderPrijs Klant mkfactuur () NieuwePrijs GewonePrijs berekenprijs(leeninfo v) { double v_prijs = 0 switch (getprijscode()) { case Film.GEWOON : v_prijs = ; break case Film.NIEUW : v_prijs = ; break case Film.KINDER : v_prijs = ; break prijs(n) { if (n<=2) return 2.0 else (n 2)* 1.5 return v_prijs this.prijs.prijs(v.getaantaldagen()) 17 replace conditional with polymorphism

18 LeenInfo aantaldagen 1 Film berekenprijs() prijs 1 PrijsStrategie prijs(n) * KinderPrijs Klant mkfactuur () NieuwePrijs GewonePrijs berekenprijs(leeninfo v) { double v_prijs = 0 switch (getprijscode()) { case Film.GEWOON : v_prijs = ; break case Film.NIEUW : v_prijs = ; break case Film.KINDER : v_prijs = ; break return v_prijs berekenprijs(leeninfo v) { return prijs.prijs(v.getaantaldagen()) 18 replace conditional with polymorphism

19 Fowler s refactoringset Stroomlijnen van methodes (9) Verplaatsen van features (8) Organisatie van data (16) Vereenvoudiging van conditionele statements (8) Vereenvoudiging van methodeaanroep (15) Generalisatie (12) 19

20 Stroomlijnen van methode Fowler s stelling: lange methodes zijn vaak bronnen van problemen. (Fowler geeft voorkeur aan (veel) korte methodes) hoofdwapen: extract method inverse: inline method als de body net zo duidelijk als de methodenaam. elimineren en introduceren van temp als je een blok B tot een methode uittrekt, moet je ook de context van B mee nemen temp maakt dit lastiger. 20

21 Temp inline temp en introduce explaining variable double verkoopprijs = product.getprijs() * 1.5 return verkoopprijs > 10.0 expressie is te complex return product.getprijs() * 1.5 > 10.0 replace temp with query return verkoopprijs() > 10.0 je kunt niet alle temp elimineren loopteller, accumulatie var. 21

22 Als je parameterlijst te lang is Introduce parameter object datumprofiel datum opendag prijs(datum, leeftijd, islid, actiekaart, isopendag) persoonsprofiel leeftijd lidmaatschap actiekaart prijs(persoonsprofiel, datumprofiel) 22

23 Features verplaatsen Verdeel het werk (welke klasse doet wat). Een klasse die te veel doet is ook moeilijker om te begrijpen. hoofdwapen: move method/field (heb je al gezien) splitsen en samenvoegen van klassen introduceren en elimineren van delegatie 23

24 Splitsen en samenvoegen Extract class: een klasse C doet te veel. Herken een deel van C die je tot een eigen klasse D kan groeperen. Persoon naam leeftijd straat huisnr postcode printadres() Persoon naam leeftijd 1 1 Adres straat huisnr postcode printadres() De inverse is inline class. 24

25 Delegatie Hide delegate Persoon adres.getpostcode().getstad() Persoon adres. getstad() Adres Postcode getstad() Adres getstad() Postcode getstad() getstad() { return postcode.getstad() 25 remove middle man als Adres te veel delegatie doet ipv echt werk

26 Stroomlijnen van conditionele stmt Complexe domeinlogics vertalen zich naar complexe conditionele statements, die vaak moeilijk te begrijpen en dus foutgevoelig is. 26 Hoofdwapen: extract methode op condities decompose conditional, consolidate conditional, Vereenvoudiging op de structuur remove control flag replace conditional with polymorphism (heb je al gezien) replace nested conditional with guard clauses

27 Extract methode op conditionele stmt Decompose conditional if (datum.voor(zomer_begin) datum.na(zomer_eind) ) prijs = 0.8 * prijs if if (???... (nietzommer(datum (datum ) ) prijs ) ) prijs = 0.8 = 0.8 * prijs * prijs Consolidate conditional expression 27 prijs(persoon) { if (leeftijd 10) if (persoon.islid if (persoon.isjarig()) return 0 ; return normaleprijs(persoon) prijs(persoon) { if (isgratis(persoon)) return 0 return normaleprijs(persoon)

28 Vereenvoudiging van structuur remove control flag gevonden = false product = null for (iter = V.iterator() ; iter.hasnext() &&!gevonden ; ) { product = iter.next() gevonden = product.prijs() <= 10.0 for (Product p : V) { product = p if (product.prijs() <= 10.0) break 28

29 Vereenvoudiging van structuur Soms kun je replace nested conditional with guarded clauses doen. If-else voor normale flow met meerdere varianten prijs() { if (dag.isweekend()) return 40.0 else return 30.0 Soms heb je normale flow met alternatieven die je liever ziet als afwijkende flows minder expliciet in if-else 29 prijs (persoon) { normaleprijs = 30 ; if (persoon.leeftijd 4) return 0 else if (!dag.isweekend ()) return normaleprijs+10 ; else return normaleprijs ;

30 30 Vereenvoudiging van structuur Soms heb je normale flow met een of meer afwijkende flows minder expliciet in if-else prijs (persoon) { normaleprijs = 30 ; if (persoon.leeftijd 4) return 0 else if (!dag.isweekend ()) return normaleprijs+10 ; else return normaleprijs ; prijs (persoon) { normaleprijs = 30 if (persoon.leeftijd 4) return 0 if (datum.isopendag()) normaleprijs += 10 return normaleprijs

31 Generalisatie Optimaliseer je inheritence structuur. Verplaatsen van features binnen een hiërarchie. Splitsen en samenvoegen Vervangen van inheritence met delegatie, of andersom 31

32 Pull up / pull down Product naam pull up Product naam korting() Appel korting() Koffie korting() Appel Koffie Product naam pull down Product naam korting() Appel korting() Koffie Appel Koffie 32 als korting() eigenlijk alleen relevant is voor appel

33 Extract sub/super class Product naam korting() extract subclass Product naam korting wordt alleen door sommige instanties gebruikt KortingProduct korting() 33 Product naam prijs geticoon () seticoon(i) reseticoon() Persoon naam geticoon () seticoon(i) reseticoon() Klassen met een subset van dezelfde features extract superclass Product naam prijs Persoon naam ItemMetIcoon geticoon () seticoon(i) reseticoon()

34 Extract interface WebShop Factuur meerdere klantklassen die dezelfde subset van methodes van Product gebruiken Product naam getprijs() getactie() getkorting() PrijsItem getprijs() getactie() getkorting() Product naam 34

35 Collapse hierarchy Appel Appel GroenAppel ze blijken niet veel van elkaar verschillen. 35

36 replace delegation with inheritence, en omgekeerd Product naam prijs ItemMetIcoon geticoon () seticoon(i) reseticoon() als Product blijkt slechts een relatief klein deel van ItemMetIcoon gebruikt als Product blijkt veel werk naar ItemMetIcoon delegeert Product naam prijs ItemMetIcoon geticoon () seticoon(i) reseticoon() 36

37 Tools Liever laat je refactoringstappen geautomatiseerd door een tool veel sneller dan handmatig kans om fout te maken is veel kleiner. maar sommige refactoringstappen zijn moeilijk te automatiseren (zoals replace cond with polymorhpism) Ondersteunt door IDEs, maar ondersteuning varieert Eclipse, Netbeans, IntelliJ Elimineer de noodzaak van testing niet. 37