Importing Configuration with imports

По умолчанию, конфигурация сервиса живёт в app/config/services.yml. Но если этот файл становится большим, вы можете спокойно реорганизовать его в несколько файлов. Представьте, что вы решили переместить какую-то часть конфигурации в новый файл:

1
2
3
4
5
6

# app/config/services/mailer.yml
parameters:
    # ... некоторые параметры

services:
    # ... некоторые сервисы

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

<!-- config/services/mailer.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">

    <parameters>
        <!-- ... некоторые параметры -->
    </parameters>

    <services>
        <!-- ... некоторые параметры -->
    </services>
</container>

1
2
3
4

// config/services/mailer.php

// ... некоторые параметры
// ... некоторые сервисы

Для того, чтобы импортировать этот файл, используйте ключ imports из файла, который загружается:

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

# config/services.yaml
imports:
    - { resource: services/mailer.yaml }
    # Если вы хотите импортировать весь каталог:
    - { resource: services/ }
services:
    _defaults:
        autowire: true
        autoconfigure: true

    App\:
        resource: '../src/*'
        exclude: '../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}'

    # ...

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

<!-- 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">

    <imports>
        <import resource="services/mailer.xml"/>
        <!-- Если вы хотите импортировать весь каталог: -->
        <import resource="services/"/>
    </imports>

    <services>
        <defaults autowire="true" autoconfigure="true"/>

        <prototype namespace="App\" resource="../src/*"
            exclude="../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}"/>

        <!-- ... -->
    </services>
</container>

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

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

return function(ContainerConfigurator $containerConfigurator) {
    $containerConfigurator->import('services/mailer.php');
    // Если вы хотите импортировать весь каталог:
    $containerConfigurator->import('services/');

    $services = $containerConfigurator->services()
        ->defaults()
            ->autowire()
            ->autoconfigure()
    ;

    $services->load('App\\', '../src/*')
        ->exclude('../src/{DependencyInjection,Entity,Migrations,Tests,Kernel.php}');
};

При загрузке файла конфигурации, Symfony сначала загружает импортированные файлы, а затем обрабатывает параметры и сервисы, определенные в файле. Если вы используете конфигурацию services.yaml по умолчанию как в приведенном выше примере, определение App\ создает сервисы для классов, найденных в ../src/*. Если ваш импортированный файл определяет сервисы для этих классов, то они будут переопределены.

Возможным решением этой проблемы является добавление классов и/или каталогов импортированных файлов в опцию exclude определения App\. Еще одно решение - не использовать импорт и добавить определения сервисов в тот же файл, но после определения App\, чтобы переопределить его.

Дата обновления перевода 2023-08-21

1
2
3

# config/services.yaml
imports:
    - { resource: '%kernel.project_dir%/somefile.yaml' }

1
2
3
4
5
6
7
8
9
10
11

<!-- 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"
>
    <imports>
        <import resource="%kernel.project_dir%/somefile.yaml"/>
    </imports>
</container>

1
2
3
4
5
6

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

return static function (ContainerConfigurator $container): void {
    $container->import('%kernel.project_dir%/somefile.yaml');
};

Импорт конфигурации через расширения контейнера

Конфигурация контейнера сторонних пакетов, включая базовые сервисы Symfony, обычно загружается с использованием другого метода: расширения контейнера.

Внутренне, каждый пакет определяет свои сервисы в файлах, как вы уже видели. Однако, эти файлы не испортируются, используя директиву import. Вместо этого, пакеты используют расширение внедрения зависимости, чтобы загружать файлы автоматически. Как только вы включаете пакет, вызывается его расширение, которое может загрузить файлы конфигурации сервиса.

На самом деле, каждый блок конфигурации в config.yml - например, framework или twig- передаётся расширению для этого пакета - например. FrameworkBundle или TwigBundle - и используется для дальнейшей конфигурации этих сервисов.