{"id":777,"date":"2014-02-25T15:55:36","date_gmt":"2014-02-25T13:55:36","guid":{"rendered":"http:\/\/www.lafabriquedecode.com\/blog\/?p=777"},"modified":"2014-02-25T15:55:36","modified_gmt":"2014-02-25T13:55:36","slug":"php-le-design-pattern-adaptateur","status":"publish","type":"post","link":"http:\/\/www.lafabriquedecode.com\/blog\/2014\/02\/php-le-design-pattern-adaptateur\/","title":{"rendered":"PHP : le design pattern Adaptateur"},"content":{"rendered":"

Chez Auto Load, tout est permis !<\/h1>\n

Pour illustrer notre exemple du design pattern<\/em> Adaptateur, nous allons cette fois nous prendre pour des inspecteurs du permis de conduire ! Chez AUTO LOAD, nous nous vantons d’obtenir un taux de r\u00e9ussite de 99% \u00e0 l’examen du permis de conduire et ce sans soudoyer de quelque mani\u00e8re que ce soit nos candidats ! Voyons sans tarder les principales classes qui composent notre exemple. Tout d’abord, la classe InspecteurPermisConduire<\/strong>, qui est notre classe cliente. C’est elle qui va faire usage de nos autres classes.<\/p>\n

\r\nclass InspecteurPermisConduire {\r\n    private $_candidat;\r\n\t\r\n    public function __construct(ConducteurInterface $conducteur)\r\n    {\r\n        $this->_candidat = $conducteur;\r\n    }\r\n    public function changerCandidat(ConducteurInterface $conducteur)\r\n    {\r\n        $this->_candidat = $conducteur;\r\n    }\r\n    public function fairePasserExamen()\r\n    {\r\n        $this->_candidat->demarrer();\r\n        $this->_candidat->accelerer();\r\n        $this->_candidat->tournerDroite();\r\n        $this->_candidat->accelerer();\r\n        $this->_candidat->tournerGauche();\r\n        $this->_candidat->ralentir();\r\n        $this->_candidat->reculer();\r\n        $this->_candidat->immobiliser();\r\n    }\r\n}\r\n<\/pre>\n
Une instance donn\u00e9e d’InspecteurPermisConduire prend en composition tout objet se conformant \u00e0 l’interface ConducteurInterface<\/strong> : tout d’abord, elle l’exige dans son constructeur, c’est \u00e0 dire qu’aucune instance d’InspecteurPermisConduire ne peut exister sans un objet qui impl\u00e9mente en totalit\u00e9 ConducteurInterface. Ensuite, nous nous r\u00e9servons la possibilit\u00e9 de changer de type de candidat \u00e0 l’ex\u00e9cution (runtime<\/em>) gr\u00e2ce \u00e0 un setter<\/em>. Enfin, la valeur ajout\u00e9e de notre classe r\u00e9side dans sa m\u00e9thode fairePasserExamen<\/strong>, qui fait effectuer \u00e0 tout conducteur les man\u0153uvres de base, indispensables pour d\u00e9crocher le pr\u00e9cieux s\u00e9same !<\/p>\n
Voici justement notre Automobiliste :<\/p>\n
\r\ninterface ConducteurInterface {\r\n\tpublic function demarrer();\r\n\tpublic function tournerGauche();\r\n\tpublic function tournerDroite();\r\n\tpublic function accelerer();\r\n\tpublic function ralentir();\r\n\tpublic function reculer();\r\n\tpublic function immobiliser();\r\n}\r\n\r\nclass Automobiliste implements ConducteurInterface {\r\n\tpublic function demarrer() {\r\n\t\techo "tourner la cl\u00e9 de contact ou mettre la carte";\r\n\t}\r\n\tpublic function tournerGauche() {\r\n\t\techo "tourner le volant vers la gauche";\r\n\t}\r\n\tpublic function tournerDroite() {\r\n\t\techo "tourner le volant vers la droite";\r\n\t}\r\n\tpublic function accelerer() {\r\n\t\techo "appuyer sur la p\u00e9dale d'acc\u00e9l\u00e9ration";\r\n\t}\r\n\tpublic function ralentir() {\r\n\t\techo "rel\u00e2cher la p\u00e9dale d'acc\u00e9l\u00e9ration et\/ou", \r\n                      "appuyer sur la p\u00e9dale de frein";\r\n\t}\r\n\tpublic function reculer() {\r\n\t\techo "passer la marche arri\u00e8re et acc\u00e9l\u00e9rer";\r\n\t}\r\n\tpublic function immobiliser() {\r\n\t\techo "mettre le frein \u00e0 main";\r\n\t}\r\n}\r\n<\/pre>\n
Notre classe concr\u00e8te Automobiliste<\/strong> impl\u00e9mente les fonctions impos\u00e9es par l’interface ConducteurInterface<\/strong>. Cette interface recense les principales manoeuvres dont la ma\u00eetrise est exig\u00e9e de tout conducteur de v\u00e9hicule qui se respecte : d\u00e9marrer et arr\u00eater le v\u00e9hicule, avancer, reculer, tourner, acc\u00e9l\u00e9rer et ralentir. Attention cependant, certains v\u00e9hicules – comme un v\u00e9lo – ne se d\u00e9marrent pas, il va falloir prendre en compte cet aspect l\u00e0…<\/p>\n
Bref, \u00e0 ce stade l\u00e0, tout est pour le mieux dans le meilleur des mondes ! [Candide]<\/p>\n
\"Sch\u00e9ma<\/a><\/p>\n
D\u00e8s que le vent soufflera, je recodera… (air bien connu)<\/h1>\n
Jusqu’au jour o\u00f9 Otto Hekohl, le propri\u00e9taire de notre \u00e9cole de conduite, vient nous annoncer qu’\u00e9tant donn\u00e9 que nous sommes situ\u00e9s en bord de mer, il serait plut\u00f4t judicieux – en plus d’\u00eatre diablement b\u00e9n\u00e9fique pour notre chiffre d’affaire – que nous puissions faire passer le permis bateau \u00e0 des candidats qui sont de plus en plus nombreux et demandeurs…<\/p>\n
\"Photos<\/a>
Elle est parfois dure la vie \u00e0 bord d’un fr\u00eale esquif !<\/p><\/div>\n
Avant de se faire cong\u00e9dier par notre patron pour avoir regard\u00e9 trop de vid\u00e9os de chatons montant sur le dos de tortues durant ses heures de travail, Jojo Dingo, le deuxi\u00e8me programmeur de l’entreprise, avait envisag\u00e9 d’int\u00e9grer ce changement de notre strat\u00e9gie commerciale. Voici la structure logicielle dont nous h\u00e9ritons, maintenant que Jojo a toutes ses journ\u00e9es de libre pour s’adonner \u00e0 sa f\u00e9linophilie maladive :<\/p>\n
\r\ninterface NavigateurInterface {\r\n\tpublic function demarrer();\r\n\tpublic function reculer();\r\n\tpublic function tournerBabord();\r\n\tpublic function tournerTribord();\r\n\tpublic function accelerer();\r\n\tpublic function ralentir();\r\n\tpublic function jeterAncre();\r\n}\r\n\r\nabstract class Marin implements NavigateurInterface {\r\n\tpublic function jeterAncre() {\r\n\t\techo "jeter l'ancre \u00e0 la mer";\r\n\t}\r\n}\r\n\r\nclass UnsupportedMethodException extends Exception {}\r\n\r\nclass MarinVoile extends Marin {\r\n\tpublic function demarrer() {\r\n\t\tthrow new UnsupportedMethodException\r\n                     ("Cette fonctionnalit\u00e9 n'est pas disponible");\r\n\t}\r\n\tpublic function tournerBabord() {\r\n\t\techo "diriger les voiles et la barre pour aller \u00e0 babord";\r\n\t}\r\n\tpublic function tournerTribord() {\r\n\t\techo "diriger les voiles et la barre pour aller \u00e0 tribord";\r\n\t}\r\n\tpublic function accelerer() {\r\n\t\techo "positionner les voiles et d\u00e9terminer l'allure";\r\n\t}\r\n\tpublic function ralentir() {\r\n\t\techo "positionner les voiles et d\u00e9terminer l'allure";\r\n\t}\r\n\tpublic function reculer() {\r\n\t\techo "positionner les voiles et man\u0153uvrer pour reculer";\r\n\t}\r\n}\r\n\r\nclass MarinMoteur extends Marin {\r\n\tpublic function demarrer() {\r\n\t\techo "d\u00e9marrer le moteur";\r\n\t}\r\n\tpublic function tournerBabord() {\r\n\t\techo "manoeuvrer la barre ou le volant pour aller \u00e0 babord";\r\n\t}\r\n\tpublic function tournerTribord() {\r\n\t\techo "manoeuvrer la barre ou le volant pour aller \u00e0 tribord";\r\n\t}\r\n\tpublic function accelerer() {\r\n\t\techo "augmenter la vitesse du moteur";\r\n\t}\r\n\tpublic function ralentir() {\r\n\t\techo "dimininuer la vitesse du moteur ou le couper";\r\n\t}\r\n\tpublic function reculer() {\r\n\t\techo "passer la marche arri\u00e8re";\r\n\t}\r\n}\r\n<\/pre>\n
Jojo a bien compris qu’il nous fallait des classes qui nous permettent de g\u00e9rer les gens qui s’adonnent \u00e0 la navigation de plaisance motoris\u00e9e ou \u00e0 voile et qu’un bateau ne se man\u0153uvrait pas comme une voiture.<\/p>\n
Attardons-nous sur la structure de ces classes : nous avons une classe abstraite Marin<\/strong> qui impl\u00e9mente une interface NavigateurInterface<\/strong> et dont les deux filles concr\u00e8tes MarinVoile<\/strong> et MarinMoteur<\/strong> r\u00e9alisent la majeure partie des fonctions.<\/p>\n
\"Sch\u00e9ma<\/a><\/p>\n
Marin est abstraite car trop g\u00e9n\u00e9rique, elle r\u00e9alise cependant l’impl\u00e9mentation de jeterAncre<\/strong>, qui est commune \u00e0 toute forme de navigation (bon, c’est vrai, les Optimist n’ont pas d’ancre). Jojo a choisi de cr\u00e9er une exception pour g\u00e9rer le cas o\u00f9 la fonction d\u00e9marrer n’est pas prise en charge, plut\u00f4t que de l’isoler dans une interface NavigateurMoteurInterface d\u00e9di\u00e9e aux bateaux qui ont ce mode de propulsion. C’est un choix de conception, qui a le m\u00e9rite de favoriser la g\u00e9n\u00e9ricit\u00e9, inutile de faire une v\u00e9rification de la pr\u00e9sence de cette m\u00e9thode en utilisant par exemple method_exists<\/em> dans la classe client InspecteurPermisConduire. C’est la classe concr\u00e8te qui g\u00e8re l’absence de cette m\u00e9thode en levant une exception correctement typ\u00e9e.<\/p>\n
Comment ne pas se faire mener en bateau ?<\/h1>\n
Adeptes de longue date de la programmation orient\u00e9e objet, nous souhaitons minimiser l’impact de ce changement d’architecture logicielle dans nos classes existantes. C’est l\u00e0 o\u00f9 l’adaptateur entre en jeu !<\/p>\n
L’adaptateur fonctionne exactement sur le m\u00eame principe que l’adaptateur de votre s\u00e8che-cheveux quand vous allez, en Irlande, par exemple ! Il prend en entr\u00e9e la prise fran\u00e7aise de votre s\u00e8che-cheveux favori et l’adapte aux prises \u00e0 trois broches que vous trouvez sur l’\u00eele \u00c9meraude ! Vous n’avez pas eu \u00e0 d\u00e9nuder les fils de votre appareil pour y fixer une prise irlandaise, et heureusement : l’adaptateur fait le travail pour vous ! Et vous n’y avez vu que du bleu !<\/p>\n
S’adapter…au changement<\/h1>\n
L’adaptateur a pour but de faire collaborer des interfaces de prime abord incompatibles, comme ConducteurInterface<\/strong> et NavigateurInterface<\/strong>. C’est un interm\u00e9diaire pr\u00e9cieux (et r\u00e9utilisable, ce qui nous met en joie !) qui va nous \u00e9viter de d\u00e9stabiliser notre code base<\/i> et qui va d\u00e9coupler le client (notre inspecteur du permis de conduire) de notre adapt\u00e9 (ici, nos marins). Plus le couplage est l\u00e2che, mieux c’est, je ne vous apprends rien !<\/p>\n
L’adaptateur prend en composition l’adapt\u00e9, et il sera charg\u00e9 d’effectuer la translation entre les demandes \u00e0 destination de l’interface originelle (ConducteurInterface<\/i>) et la nouvelle interface cible (NavigateurInterface<\/i>).<\/p>\n
Pour que cette translation s’effectue de mani\u00e8re transparente pour le syst\u00e8me, il faut naturellement que l’adaptateur impl\u00e9mente l’interface originelle. Regardez donc :<\/p>\n
\r\nclass AdaptateurMarin implements ConducteurInterface {\r\n\tprivate $_marin;\r\n\t\r\n\tpublic function __construct(Marin $marin) {\r\n\t\t$this->_marin = $marin;\r\n\t}\r\n\tpublic function demarrer() {\r\n\t\t$this->_marin->demarrer();\r\n\t}\r\n\tpublic function tournerGauche() {\r\n\t\t$this->_marin->tournerBabord();\r\n\t}\r\n\tpublic function tournerDroite() {\r\n\t\t$this->_marin->tournerTribord();\r\n\t}\r\n\tpublic function accelerer() {\r\n\t\t$this->_marin->accelerer();\r\n\t}\r\n\tpublic function ralentir() {\r\n\t\t$this->_marin->ralentir();\r\n\t}\r\n\tpublic function reculer() {\r\n\t\t$this->_marin->reculer();\r\n\t}\r\n\tpublic function immobiliser() {\r\n\t\t$this->_marin->jeterAncre();\r\n\t}\r\n}\r\n<\/pre>\n
Le polymorphisme avant tout ! Notre adaptateur prend en charge des objets de la classe Marin, c’est \u00e0 dire potentiellement toutes les sous-classes qui en d\u00e9rivent. Tant mieux car nous en avons deux : MarinVoile et MarinMoteur !<\/p>\n
Nous n’avons pas du tout modifi\u00e9 notre classe existante, nous avons isol\u00e9 la nouveaut\u00e9 dans une nouvelle classe, autonome, avec des responsabilit\u00e9s clairement identifi\u00e9es.<\/p>\n
Les comportements que vous isolez dans des unit\u00e9s de code ind\u00e9pendantes sont r\u00e9utilisables, ceux que vous enfermez dans des classes ne le sont pas forc\u00e9ment !<\/p><\/blockquote>\n
Pour que le syst\u00e8me prenne en compte cette nouvelle possibilit\u00e9 (\u00e0 nous l’argent facile !), il nous faudra juste modifier le code appelant. Notre client avait d\u00e9j\u00e0 un modificateur d’impl\u00e9ment\u00e9, \u00e0 la bonne heure, servons nous en donc !<\/p>\n
\r\n$adaptateur = new AdaptateurMarin(new MarinMoteur());\r\n$inspecteur->changerCandidat($adaptateur);\r\n$inspecteur->fairePasserExamen();\r\n<\/pre>\n
La m\u00e9thode changerCandidat<\/strong> exige en param\u00e8tre une impl\u00e9mentation de la classe ConducteurInterface, \u00e7a tombe bien c’est pr\u00e9cis\u00e9ment ce qu’est Marin<\/strong> et ses filles concr\u00e8tes.<\/p>\n
Souvenez vous toutefois qu’une exception est lev\u00e9e dans notre adaptateur MarinVoile<\/strong>, il faut donc en r\u00e9alit\u00e9 modifier quelque peu le code appelant, qui va devoir les intercepter et les traiter le cas \u00e9ch\u00e9ant. N’allons pas chercher midi \u00e0 quatorze heures, nous nous contenterons d’en afficher le message. \u00ab\u00a0KISS\u00a0\u00bb is the law !<\/p>\n
\r\ntry {\r\n\t$inspecteur->fairePasserExamen();\r\n} catch (UnsupportedMethodException $exception) {\r\n\techo $exception->getMessage();\r\n}\r\n<\/pre>\n
Voici maintenant l’architecture de notre code, avec l’adaptateur qui est venu s’intercaler entre l’existant et nos nouvelles fonctionnalit\u00e9s, qui vont nous permettre de g\u00e9rer marins d’eau douce, flibustiers, jeunes loups de mer, moules \u00e0 gaufres et autres ectoplasmes !<\/p>\n
\"schema2\"<\/a><\/p>\n
Pour lire cet article dans des conditions optimales, il est fortement conseill\u00e9 d’\u00e9couter autant de fois que n\u00e9cessaire ce titre (en plus d’aller les voir en concert en mai 2014<\/a>) :<\/p>\n