Как освоить и создавать новые окружения¶

Разные окружения, разные файлы конфигурации¶

Типичное приложение Symfony начинается с трёх окружений: dev, prod, и test. Как уже было сказано, каждое окружение представляет собой способ выполнять одну кодовую базу с разными конфигурациям. Поэтому не должно быть сюрпризом, что каждое окружение загружает свой собственные файлы конфигурации. Эти разные файлы упорядочены по окружению:

• для окружения dev: config/packages/dev/
• для окружения prod: config/packages/prod/
• для окружения test: config/packages/test/

В действительности, каждое окружение лишь слегка отличается от других. Это означает, что все окружения имеют общую большую базу конфигураций. Эта конфигурация размещается в файлах напрямую в каталоге config/packages/.

Расположение этих файлов определяется ядром приложения:

// src/Kernel.php

// ...
class Kernel extends BaseKernel
{
    // ...

    protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader)
    {
        // ...
        $confDir = $this->getProjectDir().'/config';

        // всегда загружать все файлы в /config/packages/
        $loader->load($confDir.'/packages/*'.self::CONFIG_EXTS, 'glob');

        // потом,если возможно, загружать файлы в определённом каталоге окружения
        if (is_dir($confDir.'/packages/'.$this->environment)) {
            $loader->load($confDir.'/packages/'.$this->environment.'/**/*'.self::CONFIG_EXTS, 'glob');
        }

        // загружать специальный services.(yaml/xml/php) и, если возможно, файл services_ENVIRONMENT.(yaml/xml/php)
        $loader->load($confDir.'/services'.self::CONFIG_EXTS, 'glob');
        $loader->load($confDir.'/services_'.$this->environment.self::CONFIG_EXTS, 'glob');
    }
}

Возьмите пакет фреймворка, установленный по умолчанию, в качестве примера:

• Загружается во всех окружениях, config/packages/framework.yaml конфигурирует фреймворк с некоторой установкой secret;
• В окружении prod не будет установлено ничего дополнительного, так как нет каталога config/packages/prod/;
• То же самое применимо к dev, так как нет config/packages/dev/framework.yaml. Однако существуют другие пакеты (например, routing.yaml) со спецальными настройками для dev;
• Наконец, в окружении test, функции теста фреймворка включаются в config/packages/test/framework.yaml.

Выполнение приложения в разных окружениях¶

Чтобы выполнить приложение в каждом окружении, измените переменную окружения APP_ENV. Во время разработки это делается в .env:

1
2
3
4
5

# .env
APP_ENV=dev

# или для теста:
#APP_ENV=test

Перейдите на страницу http://localhost:8000/index.php в вашем веб-браузере, чтобы увидеть ваше приложение в сконфигурированном окружении.

Если вы откроете файл, который вы только что посетили (public/index.php), то вы увидите, что переменная окружения передаётся ядру:

// public/index.php

// ...
$kernel = new Kernel($_SERVER['APP_ENV'] ?? 'dev', $_SERVER['APP_DEBUG'] ?? false);

// ...

Вы также можете заменить $_SERVER['APP_ENV'] ?? 'dev' просто на 'dev', чтобы всегда выполнять приложение в окружении разработки, независимо от переменной APP_ENV.

1
2
3
4
5
6
7
8

# окружение 'dev', отладка включена
$ php bin/console command_name

# окружение 'prod' (отладка всегда отключена для 'prod')
$ php bin/console command_name --env=prod

# окружение 'test', отладка выключена
$ php bin/console command_name --env=test --no-debug

Создание нового окружения¶

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

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

Наилучший способ достичь этого - через новое окружение, названное, например, benchmark. Начните с создания нового каталога и файла конфигурации:

И… вы закончили! Теперь приложение поддерживает новое окружение под названием benchmark.

Измените переменную APP_ENV на benchmark, чтобы иметь доступ к новому окружению в вашем браузере:

1
2

# .env
APP_ENV=benchmark

Окружения и каталог кеша¶

Symfony во многом пользуется преимуществами кеширования: конфигурация приложения, конфигурация маршрутизации, шаблоны Twig и многое другое кешируется в PHP-объекты, хранящиеся в файлах файловой системы.

По умолчанию, эти кешированные файлы в основном хранятся в каталоге var/cache/. Однако, каждое окружение кеширует свой собственный набор файлов:

1
2
3
4
5
6

your-project/
├─ var/
│  ├─ cache/
│  │  ├─ dev/   # cache directory for the *dev* environment
│  │  └─ prod/  # cache directory for the *prod* environment
│  ├─ ...

Иногда при отладке может быть полезным инспектировать кешированный файл, чтобы понять, как что-то работает. Если будете так делать, не забудьте посмотреть в каталог окружения, которое вы используете (чаще всего dev/ при разработке и отладке). Несмотря на возможные различия, каталог var/cache/dev/ включает в себя следующее:

appDevDebugProjectContainer.php

Кешированный “сервис-контейнер”, который представляет кешированную конфигурацию приложения.

appDevUrlGenerator.php

PHP-класс сгенерированный из конфигурации маршрутизации и используемый при генерировании URL.

appDevUrlMatcher.php

PHP-класс, используемый для сопоставления маршрутов - смотрите сюда, чтобы увидеть скомпилированную логику регулярных выражений, используемую для сопоставления входящих URL с разными маршрутами.

twig/

Этот каталог кодержит все кешированные шаблоны Twig.

Дальнейшее продвижение¶

Прочтите статью о /configuration/external_parameters.