Strategie zmiany Legacy Code

Transcript

1. Strategie pracy z Legacy Code PHPers Summit 2016, Poznań, 20.08.2016 r. Tomasz Gramza mail: to@g.pl twitter: @tomaszgramza linkedin: @tomaszgramza github: @to-masz zmiany
3. 3 source: Aled Lewis CAN’T TOUCH THIS
5. Agenda 5 Legacy Code praca z Strategie zmiana 1. 2. 3. Co to? Skąd się bierze? Po co? Przykłady … Potrzeba zmiany Dobra zmiana :)
9. 9 Legacy code - każdy kod, który jako programista odziedziczasz po kimś innym.
11. 11 Legacy code - każdy kod, który jako programista odziedziczasz po kimś innym. … i po sobie.
12. 12 image: www.freeimages.co.uk
13. 13 image: http://cooking.stackexchange.com/questions/54802/
14. Legacy Code - skojarzenia Nieprzejrzysta, splątana struktura 14 Brak testów Niezrozumiały Muszę z nim pracować, a nie mam ochoty Tydzień walki z dodaniem funkcjonalności, której zrobienie powinno zająć tylko chwilę
16. 16 Legacy code - kod, z którego nie jesteśmy już zadowoleni - kod, który nam ciąży - kod, o którym chcielibyśmy zapomnieć
17. 17 Skąd sie bierze Legacy Code?
19. error_reporting = E_ALL & ~E_NOTICE & ~E_WARNING 19
20. 20 iteracja
21. 21 Problem Rozwiazanie Szybko, ale bałaganiarsko Dokladnie, ale wolno
22. 22 ID_LOKALIZACJA WOJEWÓDZTWO MIASTO DZIELNICA 1 WIELKOPOLSKIE POZNAŃ GRUNWALD 2 WIELKOPOLSKIE POZNAŃ NOWE MIASTO ID_LOKALIZACJA ID_WOJEWÓDZTWO ID_MIASTO ID_DZIELNICA 1 14 220 34 2 14 220 35 WOJEWÓDZTWA MIASTA DZIELNICE Co jesli dwa miasta o tej samej nazwie?
23. 23 Dziedzictwo Szybka praca Efektywna praca
24. 24 Dziedzictwo Szybka praca Efektywna praca A. B. Refaktoryzacja
25. Ile Legacy Code mamy w projekcie? •  Zduplikowany kod •  Naruszenia reguł •  Nieudokumentowane publicze metody •  Pokrycie złożoności kodu testami poniżej 80% •  Nadmierna złożoność metod/klas 25 https://hub.docker.com/_/sonarqube/
30. Powody zmiany oprogramowania •  Dodanie funkcjonalności •  Naprawa błędu •  Refaktoryzacja •  Optymalizacja 30
32. 32 1.  Jakie zmiany musimy wprowadzic? 2.  Skad bedziemy wiedziec, ze dokonalismy poprawnych zmian? 3.  Skad bedziemy wiedziec, ze nic nie popsulismy?
33. Algorytmy zmiany kodu 1.  Znajdź miejsca zmiany 2.  Znajdź miejsca do przetestowania 3. Spraw aby kod był testowalny 4. Napisz testy 5. Dokonaj zmiany 33 1.  Dokonaj zmiany 2.  Módl się vs. 1.  Jakie zmiany musimy wprowadzic? 2.  Skad bedziemy wiedziec, ze dokonalismy poprawnych zmian? 3.  Skad bedziemy wiedziec, ze nic nie popsulismy?
34. + Dobra zmiana 34 Do it right the second time •  Dodanie funkcjonalności •  Naprawa błędu Refaktoryzacja
35. Refaktoryzacja - Przybornik •  VCS •  PHP 7 •  IDE •  Wytyczne do formatowania kodu: PSR 1/2 + php-cs-fixer •  Composer (autoloader) 35
36. Refaktoryzacja - Brak globalnych zależności •  Brak zmiennych globalnych global $user; •  Brak super globalnych zmiennych $_GET, $_SESSION, $COOKIE 36
37. class Foo { public function __construct() { } public function getBar() { global $user; return $user[‘name’]; } } 37 class Foo { private $user; public function __construct($user) { $this->user = $user; } public function getBar() { return $this->user[‘name’]; } }
38. class Foo { public function __construct() { } public function getBar() { return $_COOKIE[‘user’]; } } 38 class Foo { private $request; public function __construct( ServerRequestInterface $request ) { $this->request = $request; } public function getBar() { return $this->request ->getCookieParams()[‘user’]; } }
39. Refaktoryzacja - Odwrócenie sterowania (Dependency Injection) 39 •  Usługi •  Fabryki Obiekt może tworzyć inne obiekty albo operować na nich. Nigdy jedno i drugie na raz!
40. class Foo { public function __construct() { } public function bar() { $stats = new Statistics(); $stats->process(); } } 40 class Foo { private $statistics; public function __construct( Statistics $stats ) { $this->statistics = $stats; } public function bar() { return $this->statistics ->process(); } }
41. class Foo { public function __construct() { } public function bar($data) { $collection = []; foreach ($data as $row) { $collection[] = new Item($row); } return $collection; } } 41 class Foo { private $factory; public function __construct( ItemFactory $factory ) { $this->factory = $factory; } public function bar($data) { $collection = []; foreach ($data as $row) { $collection[] = $this->factory ->newInstance($row); } return $collection; } }
42. Refaktoryzacja - automatyzacja testów 42 •  Jeśli możesz napisać test, który sprawdza tylko wynik działania metody, powinieneś to zrobić •  Jeśli możesz napisać test funkcjonalny albo integracyjny, który oddziałuje na baze danych, połączyenie sieciowe, czy system plików, powinieneś to zrobić •  Jeśli możesz napisać luźny test jednostkowy, który testuje konkretne klasy (bez pełnej izolacji), powinieneś to zrobić •  Jeśli możesz napisać prawidłowy test, który wykorzystuje imitacje testowe (test doubles), żeby w pełni odizolować testowaną klasę, powinieneś to zrobić An imperfect test today is better than a perfect test someday.
43. Refaktoryzacja - Separacja danych •  Gateways 43
44. class Foo { private $db; public function __construct( Db $db ) { $this->db = $db; } public function getBar($id) { $sql = “SELECT * FROM bar WHERE id = :id”: return $db->fetchRow($sql, [‘:id’ => $id]); } } 44 class Foo { private $gateway; public function __construct( BarGateway $gateway ) { $this->gateway = $gateway; } public function getBar($id) { return $this->gateway ->findById($id); } } ...
45. class Foo { private $db; public function __construct( Db $db ) { $this->db = $db; } public function getBar($id) { $sql = “SELECT * FROM bar WHERE id = :id”: return $db->fetchRow($sql, [‘:id’ => $id]); } } 45 ... class BarGateway { private $db; public function __construct( Db $db ) { $this->db = $db; } public function findById($id) { $sql = “SELECT * FROM bar WHERE id = :id”: return $db->fetchRow($sql, [‘:id’ => $id]); } }
46. Refaktoryzacja - Separacja prezentacji 46 •  Prezenters
47. <?php if($location- >hasDistrict()): ?> <?=$location->getCityName()?>. <?=$location->getDistrictName()?> <?php else: ?> <?=$location->getCityName()?> <?php endif; ?> 47 class StandardLocationPresenter { private $location; public function __construct( Location $location ) { $this->location = $location; } public function getName(): string { ... } } ... <?=$locationPresenter->getName()?>
48. Refaktoryzacja - Architektura 48
50. Strategia Refaktoryzuj do Open-Closed 50 Robot +fire() +getWeapon(): Cannon ... $robot = new Robot(); $robot->fire();
51. Strategia Refaktoryzuj do Open-Closed 51 Robot +fire() +getWeapon(): Cannon ... RobotWithBfg +fire() +getWeapon(): BFG9000 ... $robot = new RobotWithBfg(); $robot->fire();
52. Strategia Refaktoryzuj do Open-Closed 52 Robot +fire() +getWeapon(): Cannon ... RobotWithBfg +fire() +getWeapon(): BFG9000 ... $robot = new RobotWithBfg(); $robot->fire();
53. Strategia Refaktoryzuj do Open-Closed 53 Robot +fire() ... Cannon +fire() +getWeapon(): Cannon ... $robot = new Robot(); $robot->fire();
54. Strategia Refaktoryzuj do Open-Closed 54 Robot +fire() ... Cannon +fire() ... $robot = new Robot(); $robot->fire(); Weapon +fire() +getWeapon(): Weapon ...
55. Strategia Refaktoryzuj do Open-Closed 55 Robot +fire() ... Cannon +fire() ... $robot = new Robot(); $robot->fire(); Weapon +fire() +getWeapon(): Weapon ... BFG900 +fire() ...
56. Strategia Refaktoryzuj do Open-Closed 56 Robot +fire() ... Cannon +fire() ... $weapon = new BFG9000(); $robot = new Robot($weapon); $robot->fire(); Weapon +fire() +getWeapon(): Weapon ... BFG900 +fire() ...
57. Strategia Duszenie systemu 57 BookingService +book() ... $service = new BookingService(); $service>book();
58. Strategia Duszenie systemu 58 BookingService +book() ... $service = new BookingService(); $service>book(); BookingServiceV2 +bookItem() +cancelItemBooking() ...
59. Strategia Duszenie systemu 59 BookingService +book() ... $service = new BookingService(); $service>book(); $service = new BookingServiceV2( new BookingService(); ); $service>bookItem(); class BookingServiceV2 { ... public function bookItem() { $this->legacyService->book(); } } BookingServiceV2 +bookItem() +cancelItemBooking() ...
60. Strategia Duszenie systemu 60 BookingService +book() ... $service = new BookingServiceV2(); $service>bookItem(); class BookingServiceV2 { ... public function bookItem() { // new implementation } } BookingServiceV2 +bookItem() +cancelItemBooking() ...
61. Strategia Duszenie systemu 61 $service = new BookingServiceV2(); $service>bookItem(); class BookingServiceV2 { ... public function bookItem() { // new implementation } } BookingServiceV2 +bookItem() +cancelItemBooking() ...
62. Strategia Flaga funkcjonalności 62 BookingService +book() ... $service = new BookingService(); $service>book();
63. Strategia Flaga funkcjonalności 63 BookingService +book() ... $isNewBookingFeatureActive; $service = new BookingService( $isNewBookingFeatureActive ); $service>book(); class BookingService { ... public function book() { if ($this ->isNewBookingFeatureActive) { return ... } ... } }
64. Legacy Code praca z Strategie Podsumowanie 64 Da się z nim żyć! Nie działaj chaotycznie! - Korzystaj ze strategii Do it right the second time! - jesli dostarczasz zbyt szybko - zaplanuj refaktoryzację! zmiana 1. 2. 3.
65. 65 Q & A