Wzorce projektowe w praktyce

Zastosowanie wybranych wzorców projektowych w praktyce na przykładzie działającej aplikacji oraz wybranych frameworków PHP

1. Wzorce projektowe w praktyce

2. Marek Keżel Kierownik projektu autorskiego systemu ERP do zarządzania produkcją mebli tapicerowanych Programista PHP, JS, Python Linux, CCNA R&S, CCNA Sec O mnie

3. Agenda Czym jest wzorzec projektowy ? Singleton - nikt go nie lubi Simple Factory - tworzyć, prosto Adapter - dopasowywać Facade - upraszczać Observer - powiadamiać Dependency Injection - wstrzykiwać zależności

4. CZYM JEST wzorZEC projektowY ?

5. In software engineering, a software design pattern is a general, reusable solution to a commonly occurring problem within a given context in software design. It is not a finished design that can be transformed directly into source or machine code. Rather, it is a description or template for how to solve a problem that can be used in many different situations. Wikipedia

6. CZYM JEST WZORZEC PROJEKTOWY Ogólnym rozwiązaniem często spotykanego problemu projektowego. Szablonem rozwiązania problemu Sformalizowanym elementem najlepszych praktyk programistycznych

7. CZYM NIE JEST WZORZEC PROJEKTOWY Gotową implementacją rozwiązania problemu którą możemy skopiować do naszego projektu Szablonem rozwiązania w konkretnym języku*

8. UWAGA! Stosowanie wzorców projektowych “na siłę” jest anty wzorcem. Jeżeli jest problem z dobraniem wzorca może lepiej odpuścić sobie stosowanie jakiekolwiek w tym kontekście. Kod bez wzorców projektowych będzie działał*

9. WZORCE PROJEKTOWE WG “BANDY CZWORGA”

10. Wzorce projektowe wg bandy czworga - Kreacyjne Abstract Factory Builder Factory Method Prototype Singleton

11. Wzorce projektowe wg bandy czworga - STRUKTURALNE Adapter Bridge Composite Decorator Facade Flyweight Proxy

12. Wzorce projektowe wg bandy czworga - CZYNNOŚCIOWE Chain of Responsibility Command Interpreter Iterator Mediator Memento Observer State Strategy Template Method Visitor

13. SINGLETON

14. In software engineering, the singleton pattern is a software design pattern that restricts the instantiation of a class to one "single" instance. This is useful when exactly one object is needed to coordinate actions across the system. Wikipedia

15. W czym MOŻE pomóC? Jedna instancja klasy podczas działania aplikacji Globalny dostęp do w/w instancji* Ulepszona wersja zmiennej globalnej

16. <?php class Logger { protected static $instance ; private function __construct () {} private function __clone () {} private function __wakeup () {} public static function getInstance () { if ( is_null ( static :: $instance)) { static :: $instance = new static; } return static :: $instance ; } public function info ( $message , $category ) { //zapisać do bazy danych } } PrzykładowA IMPLEMENTACJA

17. <?php class Trello { protected static $instance ; private function __construct () {} private function __clone () {} private function __wakeup () {} public static function getInstance () { if ( is_null ( static :: $instance)) { static :: $instance = new static; } return static :: $instance ; } public function dodajKarte ( $lista , $parametry ) { //połączyć się z trello i dodać kartę do listy } } PrzykładowA IMPLEMENTACJA

18. Jakie ma wady ? ANTYWZORZEC ? Silne wiązania między kodem wykorzystującym singletona a nim samym poprzez dostęp globalny (wiązanie z kontekstem) Ukrywanie zależności Naruszenie zasad SOLID: Dependency Inversion Principle, Single Responsibility Principle Testowanie, jak podmienić singletona na potrzeby testów. Testy mogą zacząć być zależne od siebie. Jeżeli jeden test zmieni stan obiektu drugi może pracować na zmienionym już stanie a nie na początkowym.

19. <?php class Zgloszenie extends ActiveRecord { public function create () { if ($this -> save ()) { Logger:: getInstance () -> info ( 'Dodano zlgoszenie' , __METHOD__) ; $this -> wyslijPowiadomienie () ; return true; } return false; } public function wyslijPowiadomienie () { Trello:: getInstance () -> dodajKarte ( 'zgloszenia' , [ 'zrodlo' => $this -> zlodlo , 'temat' => $this -> temat , 'tresc' => $this -> tresc , ] ) ; } } PrzykładOWE UŻYCIE

20. Co zrobić jeżeli POTRZEBNA JEST tylko jednA INSTANCJA KLASY w aplikacji ? Czy na pewno potrzebna jest tylko jedna instancja? Użyć Dependency Injection Użyć Service Locator* Użyć świadomie singletona z pełną świadomością jego konsekwencji

21. <?php class Zgloszenie extends ActiveRecord { protected $logger ; protected $trello ; public function __construct (LoggerInterface $logger , TrelloInterface $trello ) { $this -> logger = $logger ; $this -> trello = $trello ; } public function create () { if ($this -> save ()) { $this -> logger -> info ( 'Dodano zlgoszenie' , __METHOD__) ; $this -> wyslijPowiadomienie () ; return true; } return false; } public function wyslijPowiadomienie () { $this -> trello -> dodajKarte ( 'zgloszenia' , [ 'zrodlo' => $this -> zlodlo , 'temat' => $this -> temat , 'tresc' => $this -> tresc , ] ) ; } } PRZYKŁADOWE UŻYCIE - ZAMIAST SINGLETONA - DI

22. <?php $container = new \yii\di\Container ; $container -> setSingleton ( 'LoggerInterface' , 'Logger' ) ; $container -> setSingleton ( 'TrelloInterface' , 'Trello' ) ; $zgloszenie = $container -> get ( 'Zgloszenie' ) ; PRZYKŁADOWE UŻYCIE - ZAMIAST SINGLETONA - DI

23. DOSTEP GLOBALNY PRZYKŁADY Yii2 - logger, komponenty, DI (Yii::error(), Yii::$app->user) Laravel - helpery, facady (config(), view(), Cache::get())

24. SIMPLE Factory

25. In object-oriented programming (OOP), a factory is an object for creating other objects – formally a factory is a function or method that returns objects of a varying prototype or class from some method call, which is assumed to be "new". Wikipedia

26. W czym MOŻE pomóC? Tworzenie obiektów z rodziny klas ze wspólnym interfejsem na podstawie parametru Enkapsulacja procesu tworzenia obiektów - nie pokazujemy logiki procesu tworzenia Uniknięcie warunkowych procesów tworzenia obiektów Centralna lokalizacja tworzenia obiektów - łatwo zareagujemy np na zmiany wymaganych parametrów konstruktora DRY

27. <?php class ArtykulConverterFactory { public function createConverter ( int $typ ): ArtykulConverterInterface { switch ($typ) { case ZamowieniePozycje:: TYP_LOZKO : return new LozkoConverter () ; case ZamowieniePozycje:: TYP_SZAFKA : return new SzafkaConverter () ; case ZamowieniePozycje:: TYP_PUFA : return new PufaConverter () ; default : throw new IndeksException ( "Błędny typ artykułu" ) ; } } } Przykładowa IMPLEMENTACJA

28. class IndeksFacade { protected $typ ; protected $konwerterFactory ; protected $service ; public function __construct ( int $typ , ArtykulConverterFactoryInterface $konwerterFactory , IndeksServiceInterface $service ) { $this -> typ = $typ ; $this -> konwerterFactory = $konwerterFactory ; $this -> service = $service ; } public function utworzZKreatora ( $konfiguracjaZKreatora ): Indeks { $konfiguracja = $this -> getKonwerter () -> zKreatora ($konfiguracjaZKreatora) ; return $this -> service -> utworz ($konfiguracja) ; } public function utworzZPozycji (AbstractPozycja $pozycja ): Indeks { $konfiguracja = $this -> getKonwerter () -> zPozycji ($pozycja) ; return $this -> service -> utworz ($konfiguracja) ; } public function getKonwerter (): ArtykulConverterInterface { return $this -> konwerterFactory -> createConverter ($this -> typ) ; } } PrzykładowE UŻYCIE

29. Jakie ma wady ? Większa złożoność kodu Większa ilość klas Wersja simple factory łamię zasadę Open Close Principle (SOLID).

30. <?php class ArtykulConverterFactory { public function createConverter ( int $typ ): ArtykulConverterInterface { $mapa = Yii:: $app -> params [ 'mapaArtykulow' ] ; if ( !array_key_exists ($typ , $mapa)) { throw new IndeksException ( "Błędny typ artykułu" ) ; } $converterFQN = $mapa [ $typ ] . 'Converter' ; return new $converterFQN ; } } Przykładowa IMPLEMENTACJA

31. ADAPTER

32. In software engineering, the adapter pattern is a software design pattern (also known as wrapper, an alternative naming shared with the decorator pattern) that allows the interface of an existing class to be used as another interface. It is often used to make existing classes work with others without modifying their source code. Wikipedia

33. W czym MOŻE pomóC? Dopasowanie dwóch niekompatybilnych interfejsów Przykrycie zewnętrznego kodu własnym interfejsem w celu jeszcze większego rozluźnienia zależności Praca ze starym kodem i przystosowanie go do nowego interfejsu

34. UWAGA! Dwa typy Adaptera: klasowy oraz obiektowy Adapter dwukierunkowy - każda z klas może pełnić funkcję zarówno klienta jak adaptowanej klasy Kod kliencki nie wie czy pracuje z klasą docelową bezpośrednio czy za pośrednictwem adaptera z klasą z niekompatybilnym interfejsem

35. <?php use Trello\Client ; $client = new Client() ; $client -> authenticate ( Yii:: $app -> params [ 'trello_api_key' ] , Yii:: $app -> params [ 'trello_token' ] , Client:: AUTH_URL_CLIENT_ID ) ; $client -> cards () -> create ( array_merge ($parametry , [ 'idList' => $listaID ] ) ) ; WYWOŁANIE BEZPOŚREDNIE KODU BIBLIOTEKI

36. <?php class Trello extends Component implements TrelloInterface { public $apiKey ; public $token ; /** @var Client $client */ protected $client ; public function __construct (Client $client , $config = []) { $this -> client = $client ; parent :: __construct ($config) ; } public function init () { parent :: init () ; $this -> polacz () ; } public function dodajKarteDoListy ( string $listaID , array $parametry ) { return $this -> client -> cards () -> create ( array_merge ($parametry , [ 'idList' => $listaID ] ) ) ; } protected function polacz () { $this -> client -> authenticate ($this -> apiKey , $this -> token , Client:: AUTH_URL_CLIENT_ID) ; } } Przykładowa IMPLEMENTACJA

37. Yii:: createObject ( Trello:: class ) -> dodajKarteDoListy ( $listaID , $parametry ) ; PrzykładowE UŻYCIE

38. Jakie ma wady ? Większe skomplikowanie kodu Zbyt częste tworzenie adapterów nawet jeśli nie jest to wymagane

39. FACADE

40. The facade pattern is a software-design pattern commonly used in object-oriented programming. Analogous to a facade in architecture, a facade is an object that serves as a front-facing interface masking more complex underlying or structural code. Wikipedia

41. W czym MOŻE pomóC? Ułatwienie korzystania z rozbudowanego, skomplikowanego interfejsu biblioteki, komponentu Podział na warstwy Czytelniejszy kod klienta Niezależny rozwój złożonego systemu schowanego za fasadą - klient ma stały interfejs fasady.

42. $konwerter = ( new ArtykulConverterFactory ()) -> createConverter ( $typArtykulu ) ; $konfiguracja = $konwerter -> zKreatora ( $konfiguracjaZKreatora ) ; $service = new IndeksService( $this -> typ , new IndeksArtykulModelFactory () ) ; $indeks = $this -> service -> utworz ( $konfiguracja ) ; …… $konwerter = ( new ArtykulConverterFactory ()) -> createConverter ( $pozycja -> typ ) ; $konfiguracja = $konwerter -> zZamowieniePozycje ( $pozycja ) ; $service = new IndeksService( $this -> typ , new IndeksArtykulModelFactory () ) ; $indeks = $this -> service -> utworz ( $konfiguracja ) ; PRZYKŁADOWY PROCES GENEROWANIA INDEKSU ARTYKULU

43. class IndeksFacade { protected $typ ; protected $konwerterFactory ; protected $service ; public function __construct ( int $typ , ArtykulConverterFactoryInterface $konwerterFactory , IndeksServiceInterface $service ) { $this -> typ = $typ ; $this -> konwerterFactory = $konwerterFactory ; $this -> service = $service ; } public function utworzZKreatora ( $konfiguracjaZKreatora ): Indeks { $konfiguracja = $this -> getKonwerter () -> zKreatora ($konfiguracjaZKreatora) ; return $this -> service -> utworz ($konfiguracja) ; } public function utworzZPozycji (AbstractPozycja $pozycja ): Indeks { $konfiguracja = $this -> getKonwerter () -> zPozycji ($pozycja) ; return $this -> service -> utworz ($konfiguracja) ; } public function getKonwerter (): ArtykulConverterInterface { return $this -> konwerterFactory -> createConverter ($this -> typ) ; } } Przykładowa IMPLEMENTACJA

44. Yii:: createObject ( IndeksFacade:: class, [ $typ ] ) -> utworzZKreatora ( $konfiguracjaZKreatora ) ; Yii:: createObject ( IndeksFacade:: class, [ $typ ] ) -> utworzZPozycji ( $pozycja ) ; PrzykładowE UŻYCIE

45. Laravel FASADY Illuminate\Support\Facades\ Route::get() Illuminate\Support\Facades\ View::make() Illuminate\Support\Facades\ Validator::make() …

46. Jakie ma wady ? Może się stać klasą-bogiem - posiadać silne powiązanie z bardzo dużą ilością innych klas aplikacji

47. OBSERVER

48. The observer pattern is a software design pattern in which an object, called the subject, maintains a list of its dependents, called observers, and notifies them automatically of any state changes, usually by calling one of their methods. Wikipedia

49. W czym MOŻE pomóC? Powiadomienie zainteresowanych obiektów o zmianie stanu innego obiektu Implementacja powiadomień (events)

50. class ObserverA implements SplObserver { public function update (SplSubject $subject ) { echo 'Aktualizacja ' . __CLASS__ . PHP_EOL ; } } class ObserverB implements SplObserver { public function update (SplSubject $subject ) { echo 'Aktualizacja ' . __CLASS__ . PHP_EOL ; } } class Subject implements SplSubject { protected $observers = []; public function attach (SplObserver $observer ) { $this -> observers [spl_object_hash ($observer) ] = $observer ; } public function detach (SplObserver $observer ) { unset ($this -> observers [spl_object_hash ($observer) ] ) ; } public function notify () { foreach ($this -> observers as $observer) { $observer -> update ($this) ; } } } Przykładowa IMPLEMENTACJA

51. $subject = new Subject() ; $observerA = new ObserverA() ; $observerB = new ObserverB() ; $subject -> attach ( $observerA ) ; $subject -> attach ( $observerB ) ; $subject -> notify () ; // Aktualizacja ObserverA // Aktualizacja ObserverB PrzykładowE UŻYCIE

52. <?php class TrelloNotyfikatorHandler implements NotyfikatorHandlerInterface { public function wyslij (MessageEvent $event ) { Yii:: createObject ( Trello:: class ) -> dodajKarteDoListy ( 'zgloszenia' , $event -> message) ; } } class Zgloszenie extends ActiveRecord { const NOWE_ZGLOSZENIE_EVENT = 'noweZgloszenie' ; public function create () { if ($this -> save ()) { $this -> trigger ( self :: NOWE_ZGLOSZENIE_EVENT , new MessageEvent ( [ 'message' => 'Nowe zgłoszenie o treści: ' . $this -> tresc ] )) ; return true; } return false; } } Przykładowa IMPLEMENTACJA - YII2

53. class ZgloszenieController extends \yii\web\Controller { protected $notyfikator ; public function __construct ( $id , $module , $config = [] , NotyfikatorHandlerInterface $notyfikator ) { $this -> notyfikator = $notyfikator ; parent :: __construct ($id , $module , $config) ; } public function actionCreate () { $model = new Zgloszenie () ; $model -> on ( Zgloszenie:: NOWE_ZGLOSZENIE_EVENT , [ $this -> notyfikator , 'wyslij' ] ) ; $model -> create () ; } } PrzykładowE UŻYCIE - YII2

54. <?php return [ Watek:: class . '@' . Watek:: EVENT_NOWY_WATEK_DO_ADMINA => [ TrelloNotyfikatorHandler:: class, EmailNotyfikatorHandler:: class, PushNotyfikatorHandler:: class, ] , Zlecenie:: class . '@' . Zlecenie:: EVENT_AFTER_INSERT => [ NoweZlecenieHandler:: class, ] , Zlecenie:: class . '@' . Zlecenie:: EVENT_AFTER_PRZYJECIE => [ PrzyjecieZleceniaHandler:: class, ] , ] ; … \yii\base\Event:: on (Watek:: class, Watek:: EVENT_NOWY_WATEK_DO_ADMINA , [ TrelloNotyfikatorHandler:: class, 'handle' ]) ; DEFINICJA OBSERWATORÓW NA POZIOMIE KLAS

55. $foo = new Foo() ; // this handler is a global function $foo -> on (Foo:: EVENT_HELLO , 'function_name' ) ; // this handler is an object method $foo -> on (Foo:: EVENT_HELLO , [ $object , 'methodName' ]) ; // this handler is a static class method $foo -> on (Foo:: EVENT_HELLO , [ 'app\components\Bar' , 'methodName' ]) ; // this handler is an anonymous function $foo -> on (Foo:: EVENT_HELLO , function ( $event ) { // event handling logic }) ; YII2 events dokumentacja - przykład rejestracji obserwatorów

56. Jakie ma wady ? Obserwatorzy nie znają innych obserwatorów Kolejność powiadamiania jest niezależna

57. DEPENDENCY INJECTION

58. In software engineering, dependency injection is a technique whereby one object supplies the dependencies of another object. A "dependency" is an object that can be used, for example as a service. Instead of a client specifying which service it will use, something tells the client what service to use. Wikipedia

59. W czym MOŻE pomóC? Usunięcie sztywnych odwołań z kodu klas Rozluźnienie powiązań miedzy klasami. SOLID: Dependency Inversion Principle Oddzielenie procesu tworzenia obiektu od jego użycia Ułatwienie testowanie kodu, podmiana zależności Konfiguracja interfejsów programu za pomocą plików konfiguracyjnych

60. Uwaga! Dependency Injection jest jednym ze sposób implementacji Inversion of Control poprzez wstrzykiwanie zależności z poziomu: konstruktora, settera lub metody IoC jest paradygmatem programowania polegającym na odwróceniu kontroli. Zamiast samemu kontrolować kod frameworka, oddajemy kontrolę naszego kodu dla tego właśnie frameworka (w tym przypadku kontrolę nad tworzeniem obiektów) Dependency Injection Container jest biblioteką dostarczają funkcjonalność DI, która implementuje np. Tworzenie map zależności między interfejsami a ich konkretnymi implementacjami, odczytywanie zależności poprzez użycie Refleksji

61. ImplemENTACJE W PHP Symfony Dependency Injection Component Laravel Service Container Yii2 Dependency Injection Container PHP-DI ( php-di.org )

62. <?php class MadService extends BaseObject { protected $api ; public function __construct ( $config = []) { $this -> api = new MadApi () ; parent :: __construct ($config) ; } public function zamowieniaDoDostawcow () { return $this -> api -> zamowieniaDoDostawcow () ; } } Przykładowa IMPLEMENTACJA

63. <?php class MadService extends BaseObject { protected $api ; public function __construct (MadApiInterface $api , $config = []) { $this -> api = $api ; parent :: __construct ($config) ; } public function zamowieniaDoDostawcow () { return $this -> api -> zamowieniaDoDostawcow () ; } } Przykładowa IMPLEMENTACJA

64. <?php interface MadApiInterface { public function zamowieniaDoDostawcow (): array; } Przykładowa IMPLEMENTACJA

65. <?php class MadApi implements MadApiInterface { const SOAP_SERVER_LOGIN = ‘’ ; protected $client ; public function zamowieniaDoDostawcow (): array { $result = $this -> client -> ZdDocListGet ( [ 'ZdDocListGetData' => [ 'ClientCode' => self :: SOAP_SERVER_LOGIN , ] , ] ) ; if ($result -> ArrayZdDocListGetResult -> Status !== 1 ) { return [ 'status' => 'error' , 'massage' => $result -> ArrayZdDocListGetResult -> ErrorMessage , ] ; } return [ 'status' => 'success' , 'massage' => $result -> ArrayZdDocListGetResult -> ZdDocListGetResult , ] ; } } Przykładowa IMPLEMENTACJA

66. <?php class MadApiStub implements MadApiInterface { public function zamowieniaDoDostawcow (): array { \Yii:: debug ( 'Pobieram dane z API MAD' , __METHOD__) ; return [ 'status' => 'success' , 'massage' => [] , ] ; } } Przykładowa IMPLEMENTACJA

67. <?php //config-prod $config[ 'container' ] [ 'definitions' ] = [ 'components\MadApiInterface' => 'interfaces\MadApi' ] ; //config-dev $config[ 'container' ] [ 'definitions' ] = [ 'components\MadApiInterface' => 'interfaces\MadApiStub' ] ; class MadZamowienia extends \yii\web\Controller { public function actionIndex () { /** @var MadService $mad */ $mad = \Yii:: createObject ( MadService:: class ) ; $zamowienia = $mad -> zamowieniaDoDostawcow () ; … } } PrzykładowE UŻYCIE - YII2

68. <?php //config-prod return [ MadApiInterface:: class => DI\create(MadApi:: class ) ] ; //config-dev return [ MadApiInterface:: class => DI\create(MadApiStub:: class ) ] ; //definicja kontenera np w bootstrapie aplikacji i integracja z frameworkiem $container = ( new DI\ContainerBuilder ()) -> addDefinitions ( 'config.php' ) -> build () ; class MadZamowienia extends Controller { public function actionIndex () { /** @var MadService $mad */ $mad = $container -> get ( 'MadService' ) ; $zamowienia = $mad -> zamowieniaDoDostawcow () ; … } } PrzykładowE UŻYCIE - PHP-DI

69. Jakie ma wady ? Ciężej zrozumieć jak działa klasa i skąd bierze zależności - w szczególności dla młodych developerów Obiekty są tworzone na początku działania aplikacji - możliwe problemy z wydajnością*

70. ŹRóDŁA, LITERATURA https://wikipedia.org https://stackoverflow.com/ Design Patterns: Elements of Reusable Object-Oriented Software. The "Gang of Four": Erich Gamma, Richard Helm, Ralph Johnson, John Vlissides PHP Objects, Patterns and Practise, 5th Edition. Matt Zandstra Clean Code. Martin Robert C.

71. DZĘKUJE SMJS