Как создать приложение Symfony с несколькими ядрами¶

Добавление нового ядра в приложение¶

Создание нового ядра в приложении - это процесс, состоящий из трёх шагов:

1. Создайте новый фронт контроллер для загрузки нового ядра;
2. Создайте новый класс ядра;
3. Определите конфигурацию, загружаемую новым ядром.

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

// public/api.php
// ...
$kernel = new ApiKernel(
    $_SERVER['APP_ENV'] ?? 'dev',
    $_SERVER['APP_DEBUG'] ?? ('prod' !== ($_SERVER['APP_ENV'] ?? 'dev'))
);
// ...

// src/ApiKernel.php
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
use Symfony\Component\HttpKernel\Kernel as BaseKernel;
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

class ApiKernel extends Kernel
{
    use MicroKernelTrait;

    public function getProjectDir(): string
    {
        return \dirname(__DIR__);
    }

    public function getCacheDir(): string
    {
        return $this->getProjectDir().'/var/cache/api/'.$this->environment;
    }

    public function getLogDir(): string
    {
        return $this->getProjectDir().'/var/log/api';
    }

    protected function configureContainer(ContainerConfigurator $container): void
    {
        $container->import('../config/api/{packages}/*.yaml');
        $container->import('../config/api/{packages}/'.$this->environment.'/*.yaml');

        if (is_file(\dirname(__DIR__).'/config/api/services.yaml')) {
            $container->import('../config/api/services.yaml');
            $container->import('../config/api/{services}_'.$this->environment.'.yaml');
        } else {
            $container->import('../config/api/{services}.php');
        }
    }

    protected function configureRoutes(RoutingConfigurator $routes): void
    {
        $routes->import('../config/api/{routes}/'.$this->environment.'/*.yaml');
        $routes->import('../config/api/{routes}/*.yaml');
        // ... загружать только, если маршруты конфигурации нужны для API
    }

    // Если вам нужно выполнить некоторую логику, чтобы решить, какие пакеты загружать,
    // вы можете захотеть использовать вместо этого метод registerBundles()
    private function getBundlesPath(): string
    {
        // load only the bundles strictly needed for the API
        return $this->getProjectDir().'/config/api_bundles.php';
    }
}

Выполнение команд с другим ядром¶

Скрипт bin/console, используемый для запуска команд Symfony всегда использует класс по умолчанию Kernel, чтобы построить приложение и загрузить команды. Если вам нужно выполнить консольные команды, используя новое ядро, дублируйте скрипт bin/console и переименуйте его (например, bin/api).

Далее, замените инстанциирование Kernel вашим собственным инстанциированием ядра (например, ApiKernel) и теперь вы можете выполнять команды, используя новое ядро (например, php bin/api cache:clear). Тепеоь вы можете выполнять команды, используя новое ядро.

Отображение шаблонов, определённых в другом ядре¶

Если вы следуете Лучшим практикам Symfony, то шаблоны нового ядра будут храниться в templates/. Попытка отобразить эти шаблоны в другом ядре, приведут к ошибки Не существует зарегистрированных путей для пространста имён “__main__”.

Чтобы решить эту проблему, добавьте следующую конфигурацию к вашему ядру:

1
2
3
4
5

# config/api/twig.yaml
twig:
    paths:
        # позволяет использовать api/templates/ dir в ApiKernel
        "%kernel.project_dir%/api/templates": ~

Выполнение тестов, используя другое ядро¶

В приложениях Symfony функциональные тесты по умолчанию расширяются из класса WebTestCase. Внутри этого класса, метод под названием getKernelClass() пытается найти класс ядра, для запуска приложения во время тестирования. Логика этого метода не поддерживает приложения с несколькими ядрами, так что ваши тесты не будут использовать правильное ядро.

Решением будет создать пользовательский базовый класс для функциональных тестов, расширяющийся из класса WebTestCase и переопределяющий метод getKernelClass(), чтобы возвращать полное имя класса ядра для использования:

use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

// тесты, которым нужно, чтобы ApiKernel работал, теперь должны расширять этот
// класс ApiTestCase вместо класса WebTestCase по умолчанию
class ApiTestCase extends WebTestCase
{
    protected static function getKernelClass()
    {
        return 'App\ApiKernel';
    }

    // это нужно, так как класс KernelTestCase содержит ссылку на созданное
    // ранее ядро и его статичное свойство $kernel. Следовательно, если ваши
    // функциональные тесты не запускают изолированный процесс, позднейший запуск
    // теста для другого ядра будет повторно использовать созданный ранее экземпляр,
    // указывающий на другое ядро
    protected function tearDown()
    {
        parent::tearDown();

        static::$class = null;
    }
}

Добавление большего количества ядер в приложение¶

Если ваше приложеиие очень сложное и вы создаёте несколько ядер, то лучше хранить их в собственных каталогах, вместо того, чтобы путаться с кучей файлов в каталоге src/ по умолчанию:

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

project/
├─ src/
│  ├─ ...
│  └─ Kernel.php
├─ api/
│  ├─ ...
│  └─ ApiKernel.php
├─ ...
└─ public/
    ├─ ...
    ├─ api.php
    └─ index.php