Сервис-контейнер¶

Извлечение и использование сервисов¶

В тот момент, когда вы запускаете приложение Symfony, ваш контейнер уже содержит много сервисов. Они очень похожи на инструменты: ждут, пока вы восползуетесь ими. В вашем контроллере, вы можете “запросить” сервис из контейнера, путем типизирования аргумента с классом сервиса или именем интерфейса. Хотите записать лог чего-то? Не проблема:

// src/Controller/ProductController.php
namespace App\Controller;

use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class ProductController
{
    /**
     * @Route("/products")
     */
    public function list(LoggerInterface $logger): Response
    {
        $logger->info('Look, I just used a service!');

        // ...
    }
}

Какие еще сервисы существуют? Узнайте, запустив:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

$ php bin/console debug:autowiring

  # это только *маленький* пример вывода...

  Describes a logger instance.
  Psr\Log\LoggerInterface (monolog.logger)

  Request stack that controls the lifecycle of requests.
  Symfony\Component\HttpFoundation\RequestStack (request_stack)

  RouterInterface is the interface that all Router classes must implement.
  Symfony\Component\Routing\RouterInterface (router.default)

  [...]

Когда вы используете эти подсказки в своих методах контроллера или внутри вашеих собственных сервисов, Symfony будет автоматически передавать вам объект сервиса, соответствующий этому типу.

Читая документы, вы увидите как использовать множество разных сервисов, которые живет в контейнере.

Создание/конфигурация сервисов в контейнере¶

Вы также можете организовать собственный код в сервисах. Например, представьте, что вам нужно показать вашим пользователям случайное счастливое сообщене. Если вы вставите этот код в ваш контроллер, он не сможет быть использован повторно. Вместо этого, вы решаете создать новый класс:

// src/Service/MessageGenerator.php
namespace App\Service;

class MessageGenerator
{
    public function getHappyMessage(): string
    {
        $messages = [
            'You did it! You updated the system! Amazing!',
            'That was one of the coolest updates I\'ve seen all day!',
            'Great work! Keep going!',
        ];

        $index = array_rand($messages);

        return $messages[$index];
    }
}

Поздравляем! Вы только что создали ваш первый класс сервисов! Вы можете использовать его сразу же в вашем контроллере:

// src/Controller/ProductController.php
use App\Service\MessageGenerator;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

/**
 * @Route("/products/new")
 */
public function new(MessageGenerator $messageGenerator): Response
{
    // благодаря типизированию, контейнер вызовет
    // новый и передаст его вам!
    // ...

    $message = $messageGenerator->getHappyMessage();
    $this->addFlash('success', $message);
    // ...
}

Когда вы запросите сервис MessageGenerator, контейнер создаст новый объект MessageGenerator и вернет его (смотрите объяснение ниже). Но если вы никогда не запросите этот сервис, он никогда не будет создан: экономия памяти и скорости. В качестве бонуса, сервис MessageGenerator создается только единожды: каждый раз, когда вы запрашиваете его, вам возващается один и тот же экземпляр.

Внедрение сервисов/конфигурации в сервис¶

Что, если вам нужно получить доступ к сервису logger из MessageGenerator? Не проблема! Cоздайте метод __construct() с аргументом $logger, который имеет типизирование LoggerInterface. Установите это d новом свойстве $logger и используйте его позже:

// src/Service/MessageGenerator.php
namespace App\Service;

use Psr\Log\LoggerInterface;

class MessageGenerator
{
    private $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }

    public function getHappyMessage(): string
    {
        $this->logger->info('About to find a happy message!');
        // ...
    }
}

Вот и все! Контейнер автоматически будет знать, что ему надо передать сервис logger при загруке MessageGenerator. Откуда он это знает? Autowiring. Ключом является титпизирование LoggerInterface в вашем методе __construct() и конфигурация autowire: true в services.yml. Когда вы типизируете аргумент, контейнер будет автоматически искать соответствующий сервис. Если это не удастся, вы увидите явное исключение с предложением помощи.

Кстати, этот метод дрбавления зависимостей в ваш метод __construct(), называется внедрением зависимостей.

Как вам знать, что стоит использовать LoggerInterface для типизирования? Вы можете либо прочитать документы для той функции, что вы используете, или получить список автоматического типизирования, вызвав:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

$ php bin/console debug:autowiring

  # это только *маленький* пример вывода...

  Describes a logger instance.
  Psr\Log\LoggerInterface (monolog.logger)

  Request stack that controls the lifecycle of requests.
  Symfony\Component\HttpFoundation\RequestStack (request_stack)

  RouterInterface is the interface that all Router classes must implement.
  Symfony\Component\Routing\RouterInterface (router.default)

  [...]

// src/Service/SiteUpdateManager.php
namespace App\Service;

use App\Service\MessageGenerator;
use Symfony\Component\Mailer\MailerInterface;
use Symfony\Component\Mime\Email;

class SiteUpdateManager
{
    private $messageGenerator;
    private $mailer;

    public function __construct(MessageGenerator $messageGenerator, MailerInterface $mailer)
    {
        $this->messageGenerator = $messageGenerator;
        $this->mailer = $mailer;
    }

    public function notifyOfSiteUpdate(): bool
    {
        $happyMessage = $this->messageGenerator->getHappyMessage();

        $email = (new Email())
            ->from('[email protected]')
            ->to('[email protected]')
            ->subject('Site update just happened!')
            ->text('Someone just updated the site. We told them: '.$happyMessage);

        $this->mailer->send($email);

        // ...

        return true;
    }
}

// src/Controller/SiteController.php
namespace App\Controller;

use App\Service\SiteUpdateManager;
// ...

class SiteController extends AbstractController
{
    public function new(SiteUpdateManager $siteUpdateManager)
    {
        // ...

        if ($siteUpdateManager->notifyOfSiteUpdate()) {
            $this->addFlash('success', 'Notification mail was sent successfully.');
        }

        // ...
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

  // src/Service/SiteUpdateManager.php
  // ...

  class SiteUpdateManager
  {
      // ...
+    private $adminEmail;

-    public function __construct(MessageGenerator $messageGenerator, MailerInterface $mailer)
+    public function __construct(MessageGenerator $messageGenerator, MailerInterface $mailer, string $adminEmail)
      {
          // ...
+        $this->adminEmail = $adminEmail;
      }

      public function notifyOfSiteUpdate(): bool
      {
          // ...

          $email = (new Email())
              // ...
-            ->to('[email protected]')
+            ->to($this->adminEmail)
              // ...
          ;
          // ...
      }
  }

Параметры сервиса¶

В дополнение к объектам сервиса, контейнер также содержит конфигурацию, под названием параметры. Основная статья о конфигурации Symfony детально объясняет параметры конфигурации и показывает все их типы (параметры строки, булевого значения, массива, бинарного значения и PHP-констант).

Однако, существует другой тип параметра, связанный с сервисами. В конфигурации YAML, любая строка, начинающаяся с @ считается ID сервиса, а не обычной строкой. В конфигурации XML используйте тип type="service" для параметра, а в конфигурации PHP - функцию service():

Работа с параметрами контейнера прямая при использовании методов доступа контейнера для параметров:

// проверяет, определен ли параметр (имена параметров чувствительны к регистру)
$container->hasParameter('mailer.transport');

// получает значение параметра
$container->getParameter('mailer.transport');

// добавляет новый параметр
$container->setParameter('mailer.transport', 'sendmail');

Выбор конкретного сервиса¶

Сервис MessageGenerator, созданные ранее, требует аргумент LoggerInterface:

// src/AppBundle/Service/MessageGenerator.php
// ...

use Psr\Log\LoggerInterface;

class MessageGenerator
{
    private $logger;

    public function __construct(LoggerInterface $logger)
    {
        $this->logger = $logger;
    }
    // ...
}

Однако, существует множество сервисов в контейнере, которые имплементируют LoggerInterface, например, logger, monolog.logger.request, monolog.logger.php, и др. Как контейнер знает, какие использовать?

В таких ситуациях, контейнер обычно сконфигурирован так, чтобы автоматически выбирать один из сервисов - в этом случае logger (узнайте больше, почему в Использование псведонимов для включения автомонтирования). Но,вы можете контролировать это и передать другой logger:

Это сообщает контейнеру, что аргумент $logger для __construct должен использовать сервис, id которого monolog.logger.request.

Чтобы увидеть полный список всех возможных сервисов в контейнере, выполните:

1

$ php bin/console debug:container

Связывание аргументов по имени или типу¶

Вы также можете использовать ключевое слово bind, чтобы связать конкретные аргументы по имени или типу:

Поместив ключ bind под _defaults, вы можете указать значение любого аргумента для любого сервиса, определенного в этом файле! Вы можете связать аргументы по имени (например, $adminEmail), по типу (например, Psr\Log\LoggerInterface) или и по тому, и по тому (например, Psr\Log\LoggerInterface $requestLogger).

Конфигурация bind также может быть применена к конкретным сервисам или при загрузке множества сервисов одновременно (т.e. Importing Many Services at once with resource).

Опция автомонтирования¶

Выше, файл services.yml имеет autowire: true в разделе _defaults,так что это относится ко всем сервисам, определенным в этом файле. С этой настройкой, вы можете типизировать аргументы в методе __construct() ваших сервисов и контейнер автоматически будет передавать вам правильные аргументы. Эта вся запись была написана без автомонтирования.

Чтобы узнать больше об автомонтировании, см Defining Services Dependencies Automatically (Autowiring).

Опция автоконфигурации¶

Выше, файл services.yml имеет autoconfigure: true в секции _defaults, так что это относится ко всем сервисам, определенным в этом файле. С этой настройкой, контейнер будет автоматически применять определенную конфигурацию к вашим сервисам, основываясь на классе вашего сервиса. Это чаще всего используется для авто-тегирования ваших сервисов.

Например, чтобы создать расширение Twig, вам нужно создать класс, зарегистрировать его в качестве сервиса, и тегировать его twig.extension:

Однако с autoconfigure: true, вам не нужен тег. На самом деле, если вы используете конфигурацию Symfony Standard Edition services.yml, вам не нужно ничего делать: сервис будет загружен автоматически. Потом, autoconfigure добавит тег twig.extension за вас, так как вас класс имплементирует Twig_ExtensionInterface. И благодаря``autowire``, вы даже можете добавить аргументы-конструкторы без какой-либо конфигурации.

Проверка соблюдения стандартов кодирования определений сервиса¶

Команда lint:container проверяет, чтобы аргументы, внедренные в сервисы, соответствовали их типам объявлений. Полезно выполнять ее до развертывания вашего приложения в производство (например, в вашем постоянном сервере интеграции):

1

$ php bin/console lint:container

Проверка всех типов всех аргументов сервиса каждый раз при компиляции контейнера может навредить производительности. Поэтому такая проверка реализуется в пропуске компилятора под названием CheckTypeDeclarationsPass, который отключен по умолчанию, и включается только при выполнении команды lint:container. Если вас не пугает потеря производительности, включите пропуск копилятора в вашем приложении.

Публичные сервисы против приватных¶

Каждый сервис определен приватным по умолчанию. Когда сервис приватный, вы не можете получить к нему доступ напрямую из контейнера, используя $container->get(). Лучшей практикой будет создание только приватных сервисов, и вам стоит извлекать сервисы используя внедрение зависимостей, а не $container->get().

Если вам нужно извлекать сервисы лениво, вместо использования публичных сервисов, вам стоит рассмотреть использование локатора сервисов.

Но если вам нужно сделать сервис публичным, переопределите настройку public:

Одномоментный импорт множества сервисов с помощью источника¶

Вы уже видели, что вы можете импортировать множество сервисов одновременно, используя ключ resource. Например, конфигурация Symfony по умолчанию, содержит следующее:

Это может быть использовано для того, чтобы быстро сделать много классов доступными в качестве сервисов, и применить какую-то конфигурацию по умолчанию. Id каждого сервиса - это его полностью квалифицированное имя класса. Вы можете переписать любой сервис, который был испортирован, используя его id (имя класса) ниже (например, см. Подключение аргументов вручную). Если вы перепишите сервис, никакие из опций (например, public) не будут унаследованы из импорта (но переписанный сервис наследует из _defaults).

Вы также можете exclude (исключить) определенные пути. Это не обязательно, но слегка увеличит производительность окружения dev: исключенные пути не отслеживаются, так что их изменение не приведет к перестройке контейнера.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

# config/services.yaml
services:
    command_handlers:
        namespace: App\Domain\
        resource: '../src/Domain/*/CommandHandler'
        tags: [command_handler]

    event_subscribers:
        namespace: App\Domain\
        resource: '../src/Domain/*/EventSubscriber'
        tags: [event_subscriber]

Ясная конфигурация сервисов и аргументов¶

До появления Symfony 3.3, все сервисы и (обычно) аргументы, были ясно сконфигурированы: было невозможно загрузить сервисы автоматически и автомонтирование было намного менее распространено.

Обе эти функции не обязательны. И даже если вы используете их, могут быть некоторые случае, когда вы захотите вручную подключить сервис. Например, представьте, что вы хотите зарегистрировать 2 сервиса для класса SiteUpdateManager - каждый с разным email админа. В этом случае, каждый должен иметь уникальный id сервиса:

В этом случае, зарегистрированы два сервиса: site_update_manager.superadmin и site_update_manager.normal_users. Благодаря союзнику, если вы типизируете SiteUpdateManager будет передано первое (site_update_manager.superadmin). Если вы хотите передать второе, то вам нужно вручную подключить сервис.

Узнайте больше¶