[Из песочницы] Обзор Symfony компонента: Config06.06.2018 15:18

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

Ниже представлен перевод статьи Symfony2 components overview: Config. Оригинал был опубликован в 2014 году и нем указывается вторая версия Symfony, но информация актуальна и для последней, на данный момент, четвертой версии.

Давайте представим, что мы хотим создать генератор блогов, который будет принимать несколько параметров таких как заголовок (title), описание (description), количество постов на главной странице (posts_main_page), иконки соцсетей (social) и наличие или отсутствие RSS ленты (rss). Для этих целей, мы опишем конфигурационный файл в формате YAML:

blog:
    title: My blog
    description: This is just a test blog
    rss: true
    posts_main_page: 2
    social:
        twitter:
            url: http://twitter.com/raulfraile
            icon: twitter.png
        sensiolabs_connect:
            url: https://connect.sensiolabs.com/profile/raulfraile
            icon: sensiolabs_connect.png

Теперь попробуем распарсить наш файл, проверим наличие обязательных полей, установим при необходимости значения по умолчанию. Все полученные данные проверим на соответствие установленным правилам, например rss может содержать только булевое значение, а в posts_main_page должно находиться целочисленное значение в интервале от 1 до 10. Эти процедуры нам придется повторять каждый раз при обращении к файлу, если же конечно не используется система кеширования. Кроме того подобный механизм усложняет использование файлов других форматов как INI, XML или JSON.

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

Архитектура

Архитектура делится на две основные части:

1. Определение иерархической структуры параметров.
   Компонент позволяет определить формат источника конфигурации, который может быть чем угодно, от простого INI-файла до чего-то более эзотерического, такого как специальный протокол конфигурационных сообщений. Используя класс TreeBuilder, мы можем определить типы значений, сделать их обязательными / необязательными и установить значение по умолчанию.
2. Обнаружение, загрузка и обработка.
   После того, как формат источника указан, он должен быть найден, загружен и обработан. В завершении, компонент вернет нам простой массив с проверенными значениями или выбросит исключение при ошибке.

Пример

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

root('blog');

        $rootNode
            ->children()
                ->scalarNode('title')
                    ->isRequired()
                ->end()
                ->scalarNode('description')
                    ->defaultValue('')
                ->end()
                ->booleanNode('rss')
                    ->defaultValue(false)
                ->end()
                ->integerNode('posts_main_page')
                    ->min(1)
                    ->max(10)
                    ->defaultValue(5)
                ->end()
                ->arrayNode('social')
                    ->arrayPrototype()
                        ->children()
                            ->scalarNode('url')->end()
                            ->scalarNode('icon')->end()
                        ->end()
                    ->end()
                ->end()
            ->end()
        ;

        return $treeBuilder;
    }
}

Впечатляет?! Но только не сильно волнуйтесь, если вы видите подобную структуру PHP кода в первый раз, DSL-синтаксис в нем, всегда выглядит немного странно. В примере выше, мы определили корневой узел blog и от него выстроили структуру дерева конфигурации, ветвями которого являются необходимые нам параметры и правила к их значениям. К примеру title обозначен как обязательный параметр скалярного типа, description как опциональный параметр, который по умолчанию пуст, в rss ожидаем булевое значение, которое по умолчанию равно false, а posts_main_page должен содержать целочисленное значение в диапазоне от 1 до 10, при этом 5 по умолчанию.

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

load($locator->locate('config.yml'));

// обработка данных
$processor = new Processor();
$configuration = new Configuration();
try {
    $processedConfiguration = $processor->processConfiguration(
        $configuration,
        $configValues
    );

    // проверка данных
    var_dump($processedConfiguration);
} catch (Exception $e) { 
    echo $e->getMessage() . PHP_EOL;
}

array(5) {
  'title' =>
  string(7) "My blog"
  'description' =>
  string(24) "This is just a test blog"
  'rss' =>
  bool(true)
  'posts_main_page' =>
  int(2)
  'social' =>
  array(2) {
    'twitter' =>
    array(2) {
      'url' =>
      string(29) "http://twitter.com/raulfraile"
      'icon' =>
      string(11) "twitter.png"
    }
    'sensiolabs_connect' =>
    array(2) {
      'url' =>
      string(49) "https://connect.sensiolabs.com/profile/raulfraile"
      'icon' =>
      string(22) "sensiolabs_connect.png"
    }
  }
}

array(5) {
  ...
  'rss' =>
  bool(false)
  'posts_main_page' =>
  int(5)

isFresh()) {   
    $directories = array(__DIR__.'/config');
    $locator = new FileLocator($directories); 

    $loader = new YamlConfigLoader($locator);
    $configFilePath = $locator->locate($configFile);
    $configValues = $loader->load($configFilePath);
    $resource = new FileResource($configFilePath); 

    $processor = new Processor();
    $configuration = new Configuration();
    try {
        $processedConfiguration = $processor->processConfiguration(
            $configuration,
            $configValues
        ); 

        // сериализация массива и сохранение
        $cache->write(serialize($processedConfiguration), array($resource));
    } catch (Exception $e) {
        echo $e->getMessage() . PHP_EOL;
    }

}

$loaderResolver = new LoaderResolver(array(
    new YamlConfigLoader($locator),
    new XmlConfigLoader($locator)
));
$delegatingLoader = new DelegatingLoader($loaderResolver);
$configValues = $delegatingLoader->load($locator->locate('config.xml'));

dump($configuration);

blog:
    title:                ~ # Required
    description:          ''
    rss:                  false
    posts_main_page:      5
    social:
        url:                  ~
        icon:                 ~