Projektowanie Obiektowe Refactoryzacja. Wykład 11 1

Transkrypt

1 Projektowanie Obiektowe Refactoryzacja 1

2 Refactoryzacja Dokonywanie zmian w kodzie w celu uczynienia go latwiejszym do zrozumienia i wprowadzenia zmian, bez zmiany jego widocznego (zewnetrznego) zachowania. 2

3 Po co refaktoryzować? Refaktoryzacja polepsza projekt/architekture oprogramowania. Refaktoryzacja ulatwia zrozumienie kodu. Refaktoryzacja ulatwia szukanie bledow. Refaktoryzacja przyspiesza programowanie. 3

4 Zanim zrefaktoryzujesz Tests!!! Unit Regression Version Control 4

5 Is design dead? Czy refaktoryzacja umożliwia rezygnację z projektowania? 5

6 Code smells (stinks) Zapachy (smrody) kodu. If it stinks, change it. Grandma Beck Bloaters (Nadymacze) Object Orientation abusers Change preventers Dispensables Couplers 6

7 Bloaters Nadymacze Long Method Large Class Primitive Obsession Long Parameter List Data Clumps

8 Long Method Dlugie metody sa trudniejsze do zrozumienia. Powinny zostac podzielone na mniejsze metody ktorych nazwa adekwatnie oddaje ich funkcje. Dobrze nazwana krotka funkcja jest czytlniejsza niz kod. tmp=a;a=b;b=tmp; //swap(a,b); set[index[i]]=set[last]; index[last]=index[i];last ; Najczestsza refaktoryzacja w tym przypadku jest Extract Method Nowe srodowiska programistyczne ulatwiaja przegladanie takiego kodu umozliwiajac latwe nawigowanie pomiedzy wywolaniem fukcji, a jej kodem.

9 Large Class Rozbudowana klasa, rowniez jest trudna do zrozumienia. Czesto wskazuje na to, ze klasa ma za duzo opowiedzialnosci. Klasa powinna byc odpowidzialna wylacznie za jedno zadanie. Klasa moze miec za duzo zmiennych jak i za duzo metod. Najczestsza refaktoryzacja jest Extract Class.

10 Long Parameter List Podatna na bledy trudnosci z zapamietaniem kolejnosci i znaczenia i na zmiany

11 Data Clumps Kilka zmiennych (danych) ktore zawsze uzywane sa razem.

12 Primitive Obsession Uzywanie typow wbudowanych, zamiast klas dla prostych typow np. Money, Dlugosc it. Kompilator nie moze wykryc blednego przypisania typow. W C/C++ typedef wprowdza tylko alias, a nie nowy typ.

13 Object Orientation abusers Switch Statements Temporary Field Refused Bequest Alternative Classes with Different Interfaces

14 Switch Statements Czesto prowadzi do powielania kodu: ta sama instrukcja uzywana jest w wielu miejscach programu Dodanie nowego warunku wymaga znalezienia i zmiany wszystkich takich instrukcji. Nalezy rozwazyc wykorzystanie polimorfizmu. To moze wymagac utworzenia odpowiednich typow.

15 Temporary Field Przypadek pol, ktore sluza tylko kilku metodom, np. do przekazywania parametrow pomiedzy wywolaniami kilku metod. Zlozone struktury, Bufory itp. Nie odnosza sie do calej klasy.

16 Refused Bequest nie przyjeta darowizna Klasa dziedziczaca, nie wykorzytuje (nie przyjmuje) implementacji klasy nadrzednej, tzn dziedziczymy tylko czesc zachowania/implementacji. Moze to oznaczac zla strukture klas i nawet zlamanie zasady podstawiania Liskov. Klasa dziedziczaca, nie przyjmuje interfejsu klasy nadrzednej, np. dziedziczenie prywatne w C++. Dziedziczymy tylko implementacje.

17 Alternative Classes with Different Interfaces Metody w roznych klasach robia to samo, ale maja rozna sygnature/nazwy write, print etc. Dwie klasy robia podobne rzeczy. Nalezy alboje polaczyc, albo przeniesc wspolne zachowanie do nadklasy.

18 Change preventers Divergent Change Shotgun Surgery Parallel Inheritance Hierarchies

19 Divergent Change Zlamanie zasady pojedynczej odpowiedzialnosci. Klasa jest zmieniana czesto z kilku roznych powodow.

20 Shotgun Surgery Jedna zmiana, wymaga zmiany wielu klasach.

21 Parallel Inheritance Hierarchies Dwie lub wiecej rownoleglych hierarchi klas. Dodanie podklasy, w jednej hierarchi wymaga zmian w drugie. Zasadniczo jest odmiana zapachu Shotgun Surgery. Powstaje naturalnie, nie jest dla mnie jasne jak bardzo to smierdzi:)

22 Dispensables Lazy class Data class Duplicate Code Dead Code Speculative Generality

23 Data class Klasa ktora jest wylacznie opakowaniem na dane. Tzn. zawiera tylko pola oraz metody dostepowe. Wydaje mi sie, ze to kloci sie z zaleceniami dotyczacymi kilku innych zapachow...

24 Lazy class Klasa ktora robi za malo i nie zarabia na siebie.

25 Duplicate Code Straszny smrod! Powielanie tego samego lub bardzo podobnego kodu wielu miejscach. Zwykle wynik copy & paste. Utrudnia wprowadzanie zmian.

26 Dead Code Kod ktory nigdy nie jest wykonywany.

27 Speculative Generality Kod ktory jest pisany na zapas. Kod ogolny jest bardrdziej skomplikowany, a co za tym idzie trudniejszy do zrozumienia i utrzymania.

28 Couplers Feature Envy Inapriopriate Intimacy Message Chains Middle Man

29 Feature Envy Metoda/klasa ktors zbyt czesto korzysta z danych z innej klasy bardziej niz z danych z pol wlasnej klasy.

30 Inapriopriate Intimacy Klas ktora korzysta zby czesto z prywatnych pol innej klasy.

31 Message Chains Dluga sekwencja geterow.

32 Middle Man Naduzycie delegacji Klasa deleguje wiekszosc metod do innej klasy chyba, ze to jest proxy lub dekorator.

33 Inne Comments Incomplete Library Class 33

34 Comments Komentarze moga sluzyc jako dezodorant ktory przykrywa przykre zapachy. Komentarze moga sugerowac ktore czesci kodu sa niezrozumiale i wymagaja refaktoryzacji.

35 Incomplete Library Class Biblioteka ktora musimy dostosowac lub rozszerzyc do naszyhc potrzeb bez dostepu do jej kodu zrodlowego.

36 Refactorings (z Refaktoryzacja M. Fowler) Composing methods Moving Features Between Objects Organizing Data Simplifying Conditional Expression Making Method Calls Simpler Dealing with Generalization Big Refactorings

37 Rename method Extract method Move Method Extract Subclass Hide Delegate Introduce Foreign method Decompose Conditional

38 Rename method Dodaj nowa metode o nowej nazwie. Skopiuj do niej implementacje starej metody. Zamien implementacje startej metody na wywolanie nowej metody. Pozamieniaj w w kodzie wywolania starej nazwey na nowa nazwe. Usun stara metode. Jesli nie mozesz jej usunac bo jest czescia interfejsu, oznacz ja jako deprecated.

39 Extract method Stworz nowa metode o adekwatnej nazwie. Przekopiuj wyciagany kod ze starej metody do nowej. Sprawdz, czy kod zawiera zmienne lokalne (temporary) dla starej metody. Uzyj Split Temporary Variable jesli trzeba. Zmienne ktore wystepuja wylacznie w wyciaganym kodzie, stana sie zmiennymi lokalnymi nowej metody. Zmienne lokalne ktorych kod nie modyfikuje, stana sie parametrami nowej metody.

40 Extract Method modufikowane zmienne lokalne Znajdz zmiene lokalne ktore wyciagniety kod modyfikuje. Jesli jest tylko jedna, to sprobuj przypisac do niej wynik nowej funkcji. Jesli to trudne lub jest ich wiecej to zastosuj Replace Temp with Query. Jesli to nie pomoze, to zrezygnuj z faktoryzacji, lub zastosuj Replace Method with Method Object.

41 Split Temporary Variable FILE *out=fopen( test.cfg, r );... fclose(out); out=fopen( results.dat, w );... fclose(out);

42 Split Temporary Variable FILE *out=fopen( test.cfg, r );... fclose(out); out=fopen( results.dat, w );... fclose(out); const FILE *test_file=fopen( test.cfg, r );... fclose(test_file); const FILE *result_file=fopen( results.dat, w );... fclose(result_file);

43 Replace Temp with Query void some_method() { int total_n_pixels=n_pixels_in_row_*n_pixels_in_row_; for(int i=0;i<total_n_pixels;++i) { }...

44 Replace Temp with Query void some_method() { int total_n_pixels=n_pixels_in_row_*n_pixels_in_row_; for(int i=0;i<total_n_pixels;++i) { }... int total_n_pixels() const { return n_pixels_in_row_*n_pixels_in_row_; } void some_method() { for(int i=0;i<total_n_pixels();++i) { }...

45 Replace Method with Method Object. Jesli jakas metoda zawiera duzo zmiennych lokalnych (temporary) to mozemy ja zamienic w obiekt fukcyjny. Tworzymy nowa klase o takiej samej nazwie jak metoda. W tej klasie tworzymy pole dla obiektu ktory zawiera zamieniana metode oraz dla kazdego parametru i zmiennej lokalnej metody. Dodajemy konstrutor ktory przyjmuje orginalny obiekt i parametry. Tworzymy metode o nazwie np. compute(). Przenosimy do niej kod ze starej metody. Poniewaz zmienne lokalne sa teraz polami nowej klasy mozemy spokojnie podzielic metode na mniejsze

46 class SomeClass { int long_and_complicated_method(int arg) { int tmp1,tmp2,tmp3; return...; } }

47 class SomeClass { int class long_and_complicated_method(int LongAndComplicatedMethod { arg) { int LongAndComplicatedMethod(SomeClass tmp1,tmp2,tmp3; &some_class, int arg) :some_class_(some_class), arg_(arg) {}; int compute() {...} return private:...; } SomeClass &some_class_; int arg_; } int tmp1,tmp2,tmp3; }

48 class SomeClass { int class long_and_complicated_method(int LongAndComplicatedMethod { arg) { int LongAndComplicatedMethod(SomeClass tmp1,tmp2,tmp3; &some_class, int arg) :some_class_(some_class), SomeClass { arg_(arg) {}; int compute() {...} return private: int...; long_and_complicated_method(int arg) { } SomeClass return LongAndComplicatedClass(*this,arg).compute(); &some_class_; int } arg_; } int tmp1,tmp2,tmp3; } }

49 Automatyczna refaktoryzacja Wiekszosc srodowisk programistycznych posiada narzedzia do automatycznej rekatoryzacji. Zwykle jednak tylko kilku i to o okrojonych mozliwosciach. 49