Управление кэшированием роутов

Author: ProklUng

DependencyInjection/Configuration.php

@@ -27,7 +27,7 @@ public function getConfigTreeBuilder(): TreeBuilder
                 ->scalarNode('router_request_context_host')->defaultValue('%kernel.site.host%')->end()
                 ->scalarNode('router_request_context_scheme')->defaultValue('http')->end()
                 ->scalarNode('router_request_context_base_url')->defaultValue('')->end()
-                ->scalarNode('router_cache_path')->defaultValue('%kernel.cache_dir%/routes')->end()
+                ->scalarNode('router_cache_path')->defaultValue(null)->end()
                 ->scalarNode('router_config_file')->defaultValue('app/routes.yaml')->end()
                 ->booleanNode('router_check_exists_controller')->defaultValue(false)->end()
                 ->arrayNode('controller_annotations_path')

DependencyInjection/WpSymfonyRouterExtension.php

@@ -167,5 +167,14 @@ private function registerRouterConfiguration(
                     new Reference('routing.loader.annotation'),
                 ]);
         }
+
+        // Применить кэширование роутов, если это задано опцией.
+        if ($config['router_cache_path']) {
+            $routerDefinition = $container->getDefinition('router');
+            $routerDefinition->addMethodCall(
+                'setConfigCacheFactory',
+                [new Reference('config_cache_factory')]
+            );
+        }
     }
 }

Resources/config/services.yaml

@@ -32,7 +32,11 @@ services:
       - '@routing.loader'
       - '%kernel.project_dir%/%router.config.file%'
       - debug: '%kernel.debug%'
-        # cache_dir: '%router.cache.path%'
+        cache_dir: '%router.cache.path%'
+        generator_class: Symfony\Component\Routing\Generator\CompiledUrlGenerator
+        generator_dumper_class: Symfony\Component\Routing\Generator\Dumper\CompiledUrlGeneratorDumper
+        matcher_class: Symfony\Bundle\FrameworkBundle\Routing\RedirectableCompiledUrlMatcher
+        matcher_dumper_class: Symfony\Component\Routing\Matcher\Dumper\CompiledUrlMatcherDumper
       - '@request.context'
 
   router.default: '@router'
@@ -54,7 +58,7 @@ services:
   symfony_router:
     class: Prokl\WpSymfonyRouterBundle\Services\Router\InitRouter
     arguments:
-      - '@routes.collection'
+      - '@router'
       - '@json.error.controller'
       - '@event_dispatcher'
       - '@controller_resolver'
@@ -72,6 +76,22 @@ services:
 
   symfony.get.routes: '@routes.collection'
 
+  config.resource.self_checking_resource_checker:
+    class: Symfony\Component\Config\Resource\SelfCheckingResourceChecker
+    tags:
+      - { name: config_cache.resource_checker, priority: -990 }
+
+  dependency_injection.config.container_parameters_resource_checker:
+    class: Symfony\Component\DependencyInjection\Config\ContainerParametersResourceChecker
+    arguments: ['@service_container']
+    tags:
+      - { name: config_cache.resource_checker, priority: -980 }
+
+  config_cache_factory:
+    class: Symfony\Component\Config\ResourceCheckerConfigCacheFactory
+    arguments:
+      - !tagged_iterator config_cache.resource_checker
+
   Symfony\Component\HttpKernel\Controller\ControllerResolver: ~
 
   Prokl\WpSymfonyRouterBundle\Services\Controllers\RedirectingController: ~
@@ -134,10 +154,6 @@ services:
   # Фасад. Сработает только, если активирован бандл Facade-Bundle.
   Prokl\WpSymfonyRouterBundle\Services\Facades\RunRoute: ~
 
-  # Нативный сервис из Symfony.
-  config_cache_factory:
-    class: Symfony\Component\Config\ResourceCheckerConfigCacheFactory
-
   # Утилиты для работы с роутами.
   routing.utils:
     class: Prokl\WpSymfonyRouterBundle\Services\Utils\RouteChecker

Services/Router/InitRouter.php

@@ -10,15 +10,14 @@
 use Symfony\Component\HttpKernel\Controller\ArgumentResolverInterface;
 use Symfony\Component\HttpKernel\Controller\ControllerResolverInterface;
 use Symfony\Component\HttpKernel\HttpKernel;
-use Symfony\Component\Routing\Matcher\UrlMatcher;
-use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
 use Symfony\Component\Routing\RequestContext;
 use Symfony\Component\Routing\RouteCollection;
 use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\EventListener\ErrorListener;
 use Symfony\Component\HttpKernel\EventListener\ResponseListener;
 use Symfony\Component\HttpKernel\EventListener\RouterListener;
+use Symfony\Component\Routing\RouterInterface;
 
 /**
  * Class InitRouter
@@ -37,6 +36,7 @@
  * @since 06.03.2021 Инициация события kernel.terminate.
  * @since 21.03.2021 URL matcher опционально пробрасывается снаружи.
  * @since 03.05.2021 Обработка исключений события kernel.terminate.
+ * @since 24.07.2021 Поддержка кэширования роутов.
  */
 class InitRouter
 {
@@ -45,6 +45,11 @@ class InitRouter
      */
     private static $bundlesRoutes = [];
 
+    /**
+     * @var RouterInterface $router Router.
+     */
+    private $router;
+
     /**
      * @var RouteCollection $routeCollection Коллекция роутов.
      */
@@ -97,29 +102,29 @@ class InitRouter
      * @since 19.11.2020 RequestStack пробрасывается снаружи.
      * @since 21.03.2021 URL matcher опционально пробрасывается снаружи.
      *
-     * @param RouteCollection             $routeCollection    Коллекция роутов.
+     * @param RouterInterface             $router             Роутер.
      * @param ErrorControllerInterface    $errorController    Error controller.
      * @param EventDispatcherInterface    $eventDispatcher    Event dispatcher.
      * @param ControllerResolverInterface $controllerResolver Controller resolver.
      * @param ArgumentResolverInterface   $argumentResolver   Argument resolver.
      * @param Request                     $request            Request приложения.
      * @param RequestStack                $requestStack       Request stack.
-     * @param UrlMatcherInterface|null    $urlMatcher         URL matcher.
      */
     public function __construct(
-        RouteCollection $routeCollection,
+        RouterInterface $router,
         ErrorControllerInterface $errorController,
         EventDispatcherInterface $eventDispatcher,
         ControllerResolverInterface $controllerResolver,
         ArgumentResolverInterface $argumentResolver,
         Request $request,
-        RequestStack $requestStack,
-        UrlMatcherInterface $urlMatcher = null
+        RequestStack $requestStack
     ) {
         $this->request = $request;
         $this->resolver = $controllerResolver;
         $this->argumentResolver = $argumentResolver;
-        $this->routeCollection = $routeCollection;
+
+        $this->router = $router;
+        $this->routeCollection = $router->getRouteCollection();
 
         $this->requestStack = $requestStack;
         $this->requestStack->push($request);
@@ -132,11 +137,7 @@ public function __construct(
         $this->mixRoutesBundles();
 
         // Инициализация необходимого для запуска роутера.
-        $matcher = $urlMatcher ?? new UrlMatcher(
-            $this->routeCollection,
-            $requestContext
-        );
-
+        $matcher = $this->router->getMatcher();
         $matcher->setContext($requestContext);
 
         $this->dispatcher = $eventDispatcher;

readme.MD

@@ -17,7 +17,8 @@
 
 - `enabled` - Использовать бандл. По умолчанию `true`.
 - `controller_annotations_path` - массив с путями к контроллерам, использующим аннотации. 
-- `router_cache_path` - путь к кэшу аннотаций. По умолчанию `%kernel.cache_dir%/routes`. 
+- `router_cache_path` - путь к кэшу аннотаций (вида `%kernel.cache.dir%/routes`). По умолчанию `null`. 
+   Если задан, то роуты будут кэшироваться.  
 - `router_config_file` - путь к файлу с конфигурацией роутов. По умолчанию  `app/routes.yaml`. Файл может быть в любом поддерживаемом Symfony формате - Yaml, PHP, XML и т.д. 
 - `router_check_exists_controller` - проверять на существование классы-контроллеры. По умолчанию `false`.
 - `resource` - путь к конфигурационному файлу роутов. По умолчанию: `%kernel.project_dir%/app/routes.yaml`.