{"id":6381,"date":"2022-04-01T16:15:42","date_gmt":"2022-04-01T14:15:42","guid":{"rendered":"https:\/\/www.luklagroup.com\/sem-categoria\/le-design-pattern-strategy-et-le-compiler-pass-de-symfony\/"},"modified":"2022-04-01T16:15:42","modified_gmt":"2022-04-01T14:15:42","slug":"le-design-pattern-strategy-et-le-compiler-pass-de-symfony","status":"publish","type":"post","link":"https:\/\/www.luklagroup.com\/pt-pt\/apps-data-pt-pt\/le-design-pattern-strategy-et-le-compiler-pass-de-symfony\/","title":{"rendered":"Comment optimiser un code existant gr\u00e2ce au Design Pattern Strategy et Compiler Pass de Symfony ?"},"content":{"rendered":"\n

Lors du d\u00e9veloppement d’un projet, on voit souvent une collection de if les uns \u00e0 la suite des autres, ou encore un \u00e9norme switch \/ case permettant d\u2019ex\u00e9cuter du code en fonction d’un \u00e9tat. Ce code est bien souvent illisible et difficilement maintenable.<\/em><\/strong><\/p>\n\n\n\n

Mais savez-vous qu’il existe un patron de conception permettant d’\u00e9viter \u00e7a ? Et \u00e7a tombe bien, Symfony nous permet de l’int\u00e9grer facilement.<\/em><\/strong><\/p>\n\n\n\n

Pourquoi nous utilisons un Design Pattern Strategy ?<\/h2>\n\n\n\n

Lors du d\u00e9veloppement d’une application dans le domaine de l’immobilier, nous avions \u00e0 impl\u00e9menter une fonctionnalit\u00e9 permettant d’obtenir et d’afficher les consommations de son logement<\/strong>. <\/p>\n\n\n\n

Au d\u00e9part, il n’\u00e9tait possible que de saisir manuellement le relev\u00e9 de son compteur (\u00e9lectrique, gaz ou autre). Les consommations \u00e9taient ensuite calcul\u00e9es selon la saisie de ces relev\u00e9s. <\/p>\n\n\n\n

Nous avons voulu ensuite exploiter les capacit\u00e9s d’interop\u00e9rabilit\u00e9 des fournisseurs d’\u00e9nergie, en r\u00e9cup\u00e9rant automatiquement les consommations depuis les compteurs Linky et Gazpar<\/strong>. Mais comment le faire en minimisant l’impact sur le code d\u00e9j\u00e0 fonctionnel ?<\/p>\n\n\n\n

La solution : Le Design Pattern Strategy<\/strong>.<\/p>\n\n\n\n

D\u00e9finition du Design Pattern Strategy<\/h2>\n\n\n\n

Le Design Pattern Strategy est un patron de conception permettant la s\u00e9lection et l’ex\u00e9cution d’algorithmes selon certaines conditions, le tout en respectant l’un des principes SOLID<\/strong>, le Single Responsability (la responsabilit\u00e9 unique).<\/p>\n\n\n\n

Nous aurons d’abord un service qui sera charg\u00e9 d’ex\u00e9cuter ces diff\u00e9rents algorithmes. Nous nommerons ce service ExternalConsommationProvider<\/em>. Chaque algorithme sera repr\u00e9sent\u00e9 par un service que nous appellerons provider. Un provider aura pour objectif de nous fournir les consommations d’une certaine cat\u00e9gorie.<\/p>\n\n\n\n

Dans notre exemple, nous aurons 2 providers<\/strong> :<\/p>\n\n\n\n

  • EnedisDataConnectProvider<\/code> : Qui nous retournera les consommations de notre compteur Linky.<\/em><\/li>
  • GrdfGazparProvider<\/code> : Qui nous retournera les consommations de notre compteur Gazpar.<\/em><\/li><\/ul>\n\n\n\n

    Voici un sch\u00e9ma pour mieux comprendre :<\/p>\n\n\n\n

    \"\"<\/figure><\/div>\n\n\n\n

    Sur ce diagramme, nous retrouvons notre service ExternalConsommationProvider<\/code> (Le bloc jaune tout en haut). Celui-ci contiendra une liste de providers (la propri\u00e9t\u00e9 visible via le petit carr\u00e9 rouge). Chaque provider sera une instance<\/strong> de ConsommationProviderInterface<\/code> (le bloc jaune au milieu). Ce qui obligera chaque provider \u00e0 d\u00e9velopper 2 m\u00e9thodes<\/strong> (support()<\/code> et findByRange()<\/code>). <\/p>\n\n\n\n

    Enfin, nous retrouvons nos 2 providers EnedisDataConnectProvider<\/code> et GrdfGazparProvider<\/code> (chacun impl\u00e9mentant l’interface en question, symbolis\u00e9e par la fl\u00e8che en pointill\u00e9).<\/p>\n\n\n\n

    L’objectif de notre service ExternalConsommationProvider<\/code> est, via sa m\u00e9thode findByRange<\/code>, de nous retourner les consommations<\/strong>. Sans m\u00eame avoir d\u00e9velopper nos 2 providers, nous pouvons d\u00e9j\u00e0 d\u00e9velopper cette m\u00e9thode :<\/p>\n\n\n\n

    public function findByRange(Logement $logement, DateTime $start, DateTime $end, User $user): array\n{\n    $consommations = [];\n\n    foreach ($this->getProviders() as $provider) {\n        if ($provider->support($logement, $user)) {\n            $consommations = array_merge(\n                $consommations,\n                $provider->findByRange($logement, $start, $end, $user)\n            );\n        }\n    }\n\n    return $consommations;\n}\n<\/code><\/pre>\n\n\n\n
    Voyons ce code : on boucle sur les providers de notre service. Si chaque provider est support\u00e9 (pour r\u00e9sumer, si l’utilisateur souhaite obtenir les consommations depuis ce provider), on ajoute dans notre tableau $consommations<\/code> les consommations r\u00e9cup\u00e9r\u00e9es gr\u00e2ce au provider.<\/p>\n\n\n\n
    En ce qui concerne nos providers, il suffit de d\u00e9velopper les m\u00e9thodes de notre interface :<\/p>\n\n\n\n
    class EnedisDataConnectProvider implements ConsommationProviderInterface\n{\n    public function support(Logement $logement, User $user): bool\n    {\n        \/\/ On v\u00e9rifie si notre logement est bien connect\u00e9 au compteur Linky\n    }\n\n    public function findByRange(Logement $logement, DateTime $start, DateTime $end, User $user): array\n    {\n        \/\/ On retourne les consommations de notre compteur Linky gr\u00e2ce \u00e0 l'API Data Connect d'Enedis\n    }\n}\n<\/code><\/pre>\n\n\n\n
    Maintenant que nous avons impl\u00e9ment\u00e9 notre service ExternalConsommationProvider<\/code> ainsi que nos 2 providers, comment int\u00e9grer ces providers dans notre service ?<\/strong><\/p>\n\n\n\n
    C’est l\u00e0 qu’intervient le Compiler Pass de Symfony<\/strong>.<\/p>\n\n\n\n
    D\u00e9finition du Compiler Pass<\/h2>\n\n\n\n
    Pour ajouter un provider \u00e0 notre service, nous disposons de la m\u00e9thode addProvider()<\/code><\/strong>, qui attends en param\u00e8tre une instance de ConsommationProviderInterface<\/code>.<\/p>\n\n\n\n
    Avec Symfony, nous avons la possibilit\u00e9 de tagger nos services, afin de les identifier plus facilement dans notre application.<\/p>\n\n\n\n
    Nous allons donc ajouter un tag<\/strong> sur tous nos services impl\u00e9mentant l’interface ConsommationProviderInterface<\/code>. Pour cela, il suffit d’ajouter les lignes suivantes dans notre fichier config\/services.yaml<\/code> :<\/p>\n\n\n\n
    _instanceof:\n  App\\Service\\ConsommationProviderInterface:\n    tags: [ app.rt2012.external_consommation_provider ] \n<\/code><\/pre>\n\n\n\n
    Ainsi, nos 2 providers auront le tags app.rt2012.external_consommation_provider<\/code>.<\/p>\n\n\n\n
    Maintenant que nous pouvons identifier nos providers<\/strong>, nous pouvons cr\u00e9er un CompilerPass. Pour cela, Cr\u00e9ons la class ExternalConsommationProviderPass<\/code> comme ceci :<\/p>\n\n\n\n
    class ExternalConsommationProviderPass implements CompilerPassInterface\n{\n    public function process(ContainerBuilder $container)\n    {\n        if (!$container->has(ExternalConsommationProvider::class)) {\n            return;\n        }\n\n        $definition = $container->findDefinition(ExternalConsommationProvider::class);\n\n        $taggedServices = $container->findTaggedServiceIds('app.rt2012.external_consommation_provider');\n\n        foreach ($taggedServices as $id => $tags) {\n            $definition->addMethodCall('addProvider', [new Reference($id)]);\n        }\n    }\n}\n<\/code><\/pre>\n\n\n\n
    Dans notre m\u00e9thode process()<\/code>, nous v\u00e9rifions si le service ExternalConsommationProvider<\/code> existe. Ensuite, nous r\u00e9cup\u00e9rons tous les services tagu\u00e9s sous le nom app.rt2012.external_consommation_provider<\/code>, soit nos 2 providers. Enfin, nous bouclons sur ces services pour les ajouter dans notre service ExternalConsommationProvider<\/code> gr\u00e2ce \u00e0 la m\u00e9thode addProvider()<\/code>.<\/p>\n\n\n\n
    Pour terminer, il faut que notre application prenne en compte ce CompilerPass. Pour cela, il suffit de l’ajouter dans le container, via la m\u00e9thode build<\/code> de la class App\\Kernel<\/code> :<\/p>\n\n\n\n
    class Kernel extends BaseKernel\n{\n    public function build(ContainerBuilder $container)\n    {\n        $container->addCompilerPass(new ExternalConsommationProviderPass());\n    }\n}\n<\/code><\/pre>\n\n\n\n
    L’int\u00e9r\u00eat d’un Design Pattern Strategy<\/h2>\n\n\n\n
    Ce n’est pas la seule et unique fois o\u00f9 nous avons utilis\u00e9 cette technique. Nous avons pu en exploiter ses avantages dans le contexte de simples importations de fichiers<\/strong>. Nous avons d\u00e9velopp\u00e9 un service nomm\u00e9\u00a0FileImporter<\/code>\u00a0permettant d’importer deux types de fichier diff\u00e9rents, comme un fichier\u00a0.xml<\/code>\u00a0et un fichier\u00a0.yaml<\/code>. Ce qui nous donne deux services : XmlFileImporter<\/code>\u00a0et\u00a0YamlFileImporter<\/code>. Chacun contient une m\u00e9thode\u00a0support<\/code>\u00a0permettant de v\u00e9rifier si le fichier est conforme et une m\u00e9thode\u00a0execute<\/code>\u00a0pour importer le fichier. Notre service principal saura d\u00e9terminer lequel choisir en fonction du fichier \u00e0 importer.<\/p>\n\n\n\n
    L’int\u00e9r\u00eat principal du Design Pattern Strategy est de nous permettre d\u2019ex\u00e9cuter diff\u00e9rents algorithme selon un \u00e9tat. <\/strong><\/p>\n\n\n\n
    Imaginons que, demain, nous avions aussi \u00e0 afficher les consommations d’un \u00e9quipement d’autoconsommation solaire, nous n’aurons qu’\u00e0 cr\u00e9er un provider impl\u00e9mentant l’interface\u00a0ConsommationProviderInterface<\/code>. <\/p>\n\n\n\n
    De m\u00eame, si nous devons traiter l’import d’un autre type de fichier (au format\u00a0.json<\/code> par exemple), nous n’aurons qu’a cr\u00e9er un autre service (par exemple\u00a0JsonFileImporter<\/code>). <\/p>\n\n\n\n
    Nous serons donc pr\u00eats pour de futures am\u00e9liorations \ud83d\ude09<\/p>\n","protected":false},"excerpt":{"rendered":"
    Lors du d\u00e9veloppement d’un projet, on voit souvent une collection de if les uns \u00e0 la suite des autres, ou encore un \u00e9norme switch \/ case permettant d\u2019ex\u00e9cuter du code en fonction d’un \u00e9tat. Ce code est bien souvent illisible et difficilement maintenable. Mais savez-vous qu’il existe un patron de conception permettant d’\u00e9viter \u00e7a ? […]<\/p>\n","protected":false},"author":1,"featured_media":6382,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_seopress_robots_primary_cat":"","_seopress_titles_title":"","_seopress_titles_desc":"","_seopress_robots_index":"","footnotes":""},"categories":[183,184],"tags":[220,221,222,223],"class_list":["post-6381","post","type-post","status-publish","format-standard","has-post-thumbnail","category-apps-data-pt-pt","category-change-adopt-pt-pt","tag-compiler-pt-pt","tag-pattern-pt-pt","tag-provider-pt-pt","tag-symfony-pt-pt"],"_links":{"self":[{"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/posts\/6381","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/comments?post=6381"}],"version-history":[{"count":0,"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/posts\/6381\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/media\/6382"}],"wp:attachment":[{"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/media?parent=6381"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/categories?post=6381"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.luklagroup.com\/pt-pt\/wp-json\/wp\/v2\/tags?post=6381"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}