Отмечание сервисов приватными / публичными

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

1
2

// таким образом можно получить доступ только к публичным сервисам
$doctrine = $container->get('doctrine');

Но обычно, доступ к сервисам получают, используя внедрение зависимости . И в этом случае, эти сервисы не должны быть публичными.

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

Вы также можете контролировать опцию public на основании каждого сервиса:

1
2
3
4
5
6

# config/services.yaml
services:
    # ...

    App\Service\Foo:
        public: true

1
2
3
4
5
6
7
8
9
10

<!-- 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 https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="App\Service\Foo" public="true"/>
    </services>
</container>

1
2
3
4
5
6
7
8
9
10
11

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\Service\Foo;

return function(ContainerConfigurator $configurator) {
    $services = $configurator->services();

    $services->set(Foo::class)
        ->public();
};

Приватные сервисы особенные, потому что они позволяют контейнеру оптимизировать то, как они будут инстанциированы, и нужно ли это вообще. Это повышает производительность контейнера. А также предоставляет вам лучшие сообщения об ошибках: если вы попробуете сослаться на несуществующий сервис, то вы получите чёткую ошибку при обновлении любой страницы, даже если проблемный код не был запущен на ней.

Теперь, когда сервис приватный, вы не должны вызывать сервис напрямую из контейнера:

1
2
3

use AppBundle\Service\Foo;

$container->get(Foo::class);

Таким образом, сервис может быть отмечен приватным, если вы не хотите получать к нему доступ напрямую из вашего кода. Однако, если сервис был отмечен, как приватный, вы всё ещё можете создать ему псевдоним (смотрите ниже), чтобы получить доступ к этому сервису (через псевдоним).

Псевдонимы

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

1
2
3
4
5
6
7
8
9

# config/services.yaml
services:
    # ...
    App\Mail\PhpMailer:
        public: false

    app.mailer:
        alias: App\Mail\PhpMailer
        public: true

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

<!-- 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
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="App\Mail\PhpMailer" public="false"/>

        <service id="app.mailer" alias="App\Mail\PhpMailer"/>
    </services>
</container>

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

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\Mail\PhpMailer;

return function(ContainerConfigurator $configurator) {
    $services = $configurator->services();

    $services->set(PhpMailer::class)
        ->private();

    $services->alias('app.mailer', PhpMailer::class);
};

Это означает, что при использовании контейнера напрямую, вы можете получить доступ к сервису PhpMailer, запросив сервис app.mailer таким образом:

1

$container->get('app.mailer'); // Вернет экземпляр PhpMailer

1
2
3
4

# config/services.yaml
services:
    # ...
    app.mailer: '@App\Mail\PhpMailer'

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

app.mailer:
    alias: 'App\Mail\PhpMailer'

    # это выводит следующее общее сообщение об устаревании:
    # Начиная с acme/package 1.2: Псевдоним сервиса "app.mailer" устарел. Вы должны перестать его использовать, так как он будет удален в будущем
    deprecated:
        package: 'acme/package'
        version: '1.2'

    # вы также можете определить пользовательское сообщение об устаревании (доступен заполнитель %alias_id%)
    deprecated:
        package: 'acme/package'
        version: '1.2'
        message: 'The "%alias_id%" alias is deprecated. Do not use it anymore.'

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

<?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 https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="app.mailer" alias="App\Mail\PhpMailer">
            <!-- это выводит следующее общее сообщение об устаревании:
                 Начиная с acme/package 1.2: Псевдоним сервиса "app.mailer" устарел. Вы должны перестать его использовать, так как он будет удален в будущем -->
            <deprecated package="acme/package" version="1.2"/>

            <!-- вы также можете определить пользовательское сообщение об устаревании (доступен заполнитель %alias_id%) -->
            <deprecated package="acme/package" version="1.2">
                The "%alias_id%" service alias is deprecated. Don't use it anymore.
            </deprecated>
        </service>
    </services>
</container>

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

$container
    ->setAlias('app.mailer', 'App\Mail\PhpMailer')

    // это выводит следующее общее сообщение об устаревании:
    // Начиная с acme/package 1.2: Псевдоним сервиса "app.mailer" устарел. Вы должны перестать его использовать, так как он будет удален в будущем
    ->setDeprecated('acme/package', '1.2')

    // вы также можете определить пользовательское сообщение об устаревании (доступен заполнитель %alias_id%)
    ->setDeprecated(
        'acme/package',
        '1.2',
        'The "%alias_id%" service alias is deprecated. Don\'t use it anymore.'
    )
;

Анонимные сервисы

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

Следующий пример отображает, как внедрить анонимные сервис в другой сервис:

1
2
3
4
5
6

# config/services.yaml
services:
    App\Foo:
        arguments:
            - !service
                class: App\AnonymousBar

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

<!-- 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
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="foo" class="App\Foo">
            <argument type="service">
                <service class="App\AnonymousBar"/>
            </argument>
        </service>
    </services>
</container>

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

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\AnonymousBar;
use App\Foo;

return function(ContainerConfigurator $configurator) {
    $services = $configurator->services();

    $services->set(Foo::class)
        ->args([inline_service(AnonymousBar::class)]);
};

Использование анонимного сервиса в качестве фабрики выглядит так:

1
2
3
4

# config/services.yaml
services:
    App\Foo:
        factory: [ !service { class: App\FooFactory }, 'constructFoo' ]

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

<!-- 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
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="foo" class="App\Foo">
            <factory method="constructFoo">
                <service class="App\FooFactory"/>
            </factory>
        </service>
    </services>
</container>

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

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\AnonymousBar;
use App\Foo;

return function(ContainerConfigurator $configurator) {
    $services = $configurator->services();

    $services->set(Foo::class)
        ->factory([inline_service(AnonymousBar::class), 'constructFoo']);
};

Устаревание сервисов

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

1
2
3
4
5
6

# config/services.yaml
App\Service\OldService:
    deprecated:
        package: 'vendor-name/package-name'
        version: '2.8'
        message: Сервис "%service_id%" устарел, начиная с vendor-name/package-name 2.8 и будет удален в 3.0.

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

<!-- 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 https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="App\Service\OldService">
            <deprecated package="vendor-name/package-name" version="2.8">Сервис "%service_id%" устарел, начиная с vendor-name/package-name 2.8 и будет удален в 3.0.</deprecated>
        </service>
    </services>
</container>

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

// config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\Service\OldService;

return function(ContainerConfigurator $configurator) {
    $services = $configurator->services();

    $services->set(OldService::class)
        ->deprecate(
            'vendor-name/package-name',
            '2.8',
            'Сервис "%service_id%" устарел, начиная с vendor-name/package-name 2.8 и будет удален в 3.0.'
        );
};

Теперь, каждый раз, когда сервис используется, запускается предупреждение об устаревании, советующее вам прекратить или изменить использование этого сервиса.

Сообщение на самом деле является шаблоном сообщения, которое заменяет появления заполнителя %service_id% на id сервиса. Вы должны иметь как минимум одно появление заполнителя %service_id% в вашем шаблоне.

Для декораторов сервиса (см. Как декорировать сервисы), если определение не изменяет статус устаревания, он унаследует статус из определения, которое декорируется.