conteneur de service

Ce chapitre parle d'un objet PHP spécial dans Symfony, qui vous aide à instancier, organiser et récupérer de nombreux objets dans votre programme. Cet objet, appelé « conteneur de services », permet de standardiser et de centraliser l'organisation des objets dans votre programme. Les conteneurs simplifient les choses, ils sont très rapides et mettent l’accent sur l’amélioration architecturale de la réutilisabilité du code tout en réduisant le couplage. Puisque toutes les classes Symfony utilisent des conteneurs, vous apprendrez comment étendre, configurer et utiliser des objets dans Symfony. D'un point de vue général, les conteneurs de services sont le principal contributeur à la vitesse et à l'évolutivité de Symfony.

Enfin, la configuration et l'utilisation des conteneurs de services sont simples. Après avoir étudié ce chapitre, vous pouvez facilement créer vos propres objets via le conteneur de services, et vous pouvez également personnaliser n'importe quel objet du bundle tiers. Vous commencerez à écrire du code réutilisable, testable et faiblement couplé, car les conteneurs de services facilitent l'écriture de bon code.

Qu'est-ce qu'un service ¶

En termes simples, un service (Service) peut être n'importe quel objet qui effectue des tâches "globales". C'est un nom propre en informatique, utilisé pour décrire un objet créé « pour accomplir une certaine tâche (comme l'envoi d'un e-mail) ». Dans un programme, lorsque vous avez besoin d'une fonction spécifique fournie par un service, vous pouvez accéder à ce service à tout moment. Vous n'avez rien de spécial à faire lors de la création d'un service : écrivez simplement une classe PHP qui exécute une tâche. Félicitations, vous avez créé un service !

Qu'est-ce que cela signifie ? L'avantage de considérer le problème du point de vue du « service » est que vous souhaitez déjà séparer chaque fonction du programme en une série de services. Étant donné que chaque service ne fait qu'une seule chose, vous pouvez facilement y accéder quand vous en avez besoin. Tester et configurer chaque service devient plus facile car ils sont séparés des autres fonctionnalités de votre application. Cette idée s'appelle Architecture Orientée Service et n'est pas exclusive à Symfony ou PHP. « Structurer » votre programme à travers un ensemble de classes de services indépendantes est une bonne pratique éprouvée et bien connue en programmation orientée objet. Cette compétence est la clé pour devenir un bon développeur dans n’importe quelle langue.

Qu'est-ce qu'un conteneur de services ? ¶

Un conteneur de services (Service Container/dependency injection containers) est un objet PHP qui gère l'instanciation de services (c'est-à-dire d'objets).

Par exemple, supposons que vous ayez une classe simple pour envoyer des e-mails. Sans conteneur de services, vous devrez créer manuellement des objets en cas de besoin.

use Acme\HelloBundle\Mailer;
 $mailer = new Mailer('sendmail');
$mailer->send('ryan@example.com', ...);

C'est facile. Une classe de service de messagerie Mailer fictive qui vous permet de configurer la méthode d'envoi du courrier (telle que sendmail, ou smtp, etc.). Mais que se passe-t-il si vous souhaitez utiliser votre service de messagerie ailleurs ? Vous ne souhaitez certainement pas reconfigurer l'objet Mailer à chaque fois. Que se passe-t-il si vous souhaitez modifier la façon dont le courrier est transmis et remplacer tous les sendmail de l'ensemble du programme par smtp ? Vous devez trouver tous les endroits où Mailer est créé et le mettre à jour manuellement. Mailer 邮件服务类，允许你配置邮件的发送方法（比如 sendmail ，或 smtp ，等等）。但如果你想在其他地方使用邮件服务怎么办？你当然不希望每次都重新配置 Mailer 对象。如果你想改变邮件的传输方式，把整个程序中所有的 sendmail 改成 smtp 怎么办？你不得不找到所有创建了 Mailer 的地方，手动去更新。

在容器中创建和配置服务 ¶

上面问题的最佳答案，是让服务容器来为你创建Mailer对象。为了让容器正常工作，你先要教会它如何创建Mailer服务。这是通过配置来实现的，配置方式有YAML，XML或PHP:

PHP:// app/config/services.phpuse Symfony\Component\DependencyInjection\Definition; $container->setDefinition('app.mailer', new Definition(
    'AppBundle\Mailer',
    array('sendmail')));

XML:<!-- app/config/services.xml --><?xml version="1.0" encoding="UTF-8" ?><container xmlns="http://symfony.com/schema/dic/services"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://symfony.com/schema/dic/services        http://symfony.com/schema/dic/services/services-1.0.xsd">     <services>
        <service id="app.mailer" class="AppBundle\Mailer">
            <argument>sendmail</argument>
        </service>
    </services></container>

YAML:# app/config/services.ymlservices:
    app.mailer:
        class:        AppBundle\Mailer
        arguments:    [sendmail]

class HelloController extends Controller{
    // ...     public function sendEmailAction()
    {
        // ...
        $mailer = $this->get('app.mailer');
        $mailer->send('ryan@foobar.net', ...);
    }}

PHP:// app/config/services.phpuse Symfony\Component\DependencyInjection\Definition; $container->setParameter('app.mailer.transport', 'sendmail'); $container->setDefinition('app.mailer', new Definition(
    'AppBundle\Mailer',
    array('%app.mailer.transport%')));

XML:<!-- app/config/services.xml --><?xml version="1.0" encoding="UTF-8" ?><container xmlns="http://symfony.com/schema/dic/services"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://symfony.com/schema/dic/services        http://symfony.com/schema/dic/services/services-1.0.xsd">     <parameters>
        <parameter key="app.mailer.transport">sendmail</parameter>
    </parameters>     <services>
        <service id="app.mailer" class="AppBundle\Mailer">
            <argument>%app.mailer.transport%</argument>
        </service>
    </services></container>

YAML:# app/config/services.ymlparameters:
    app.mailer.transport:  sendmailservices:
    app.mailer:
        class:        AppBundle\Mailer
        arguments:    ['%app.mailer.transport%']

# app/config/parameters.ymlparameters:    # This will be parsed as string '@securepass'
    mailer_password: '@@securepass'

1

<argument type="string">http://symfony.com/?foo=%%s&bar=%%d</argument>

// src/Acme/HelloBundle/Newsletter/NewsletterManager.phpnamespace Acme\HelloBundle\Newsletter; use Acme\HelloBundle\Mailer; class NewsletterManager{
    protected $mailer;     public function __construct(Mailer $mailer)
    {
        $this->mailer = $mailer;
    }     // ...}

use Acme\HelloBundle\Newsletter\NewsletterManager; // ... public function sendNewsletterAction(){
    $mailer = $this->get('app.mailer');
    $newsletter = new NewsletterManager($mailer);
    // ...}

PHP:// app/config/services.phpuse Symfony\Component\DependencyInjection\Definition;use Symfony\Component\DependencyInjection\Reference; $container->setDefinition('app.mailer', ...); $container->setDefinition('app.newsletter_manager', new Definition(
    'AppBundle\Newsletter\NewsletterManager',
    array(new Reference('app.mailer'))));

XML:<!-- app/config/services.xml --><?xml version="1.0" encoding="UTF-8" ?><container xmlns="http://symfony.com/schema/dic/services"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://symfony.com/schema/dic/services        http://symfony.com/schema/dic/services/services-1.0.xsd">     <services>
        <service id="app.mailer">
        <!-- ... -->
        </service>         <service id="app.newsletter_manager" class="AppBundle\Newsletter\NewsletterManager">
            <argument type="service" id="app.mailer"/>
        </service>
    </services></container>

YAML:# app/config/services.ymlservices:
    app.mailer:        # ...
    app.newsletter_manager:
        class:     AppBundle\Newsletter\NewsletterManager
        arguments: ['@app.mailer']

namespace AppBundle\Newsletter; use AppBundle\Mailer; class NewsletterManager{
    protected $mailer;     public function setMailer(Mailer $mailer)
    {
        $this->mailer = $mailer;
    }     // ...}

PHP:// app/config/services.phpuse Symfony\Component\DependencyInjection\Definition;use Symfony\Component\DependencyInjection\Reference; $container->setDefinition('app.mailer', ...); $container->setDefinition('app.newsletter_manager', new Definition(
    'AppBundle\Newsletter\NewsletterManager'))->addMethodCall('setMailer', array(
    new Reference('app.mailer'),));

XML:<!-- app/config/services.xml --><?xml version="1.0" encoding="UTF-8" ?><container xmlns="http://symfony.com/schema/dic/services"    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"    xsi:schemaLocation="http://symfony.com/schema/dic/services        http://symfony.com/schema/dic/services/services-1.0.xsd">     <services>
        <service id="app.mailer">
        <!-- ... -->
        </service>         <service id="app.newsletter_manager" class="AppBundle\Newsletter\NewsletterManager">
            <call method="setMailer">
                <argument type="service" id="app.mailer" />
            </call>
        </service>
    </services></container>

YAML:# app/config/services.ymlservices:
    app.mailer:        # ...
    app.newsletter_manager:
        class:     AppBundle\Newsletter\NewsletterManager
        calls:            - [setMailer, ['@app.mailer']]