Как создать RouteCollection из папки контроллеров с аннотироваными методами?

Question

[Киазим Хутаба]

Всем доброго времени суток!

В процессе изучения и эксперементирования с компонентами Symfony возникла следующая задача:
В корне проекта есть папка src/Controllers в которой лежат контроллеры. Методы в них аннотированы. Необходимо пройтись по всем контроллерам в папке и подпапках, и собрать маршруты в Symfony класс RouteCollection.

Просьба к людям знающим помочь с данным вопросом!

P.S. Используется только компонент route, а не весь фреймворк

Comments

[BoShurik]

Используется только symfony/router без самого фреймворка? В фреймворке эта задача решена из коробке, или я не понял и вам нужно что-то другое?

[Киазим Хутаба]

Да, используются только router и annotations

[BoShurik]

Киазим Хутаба, а зачем вам отдельно RouteCollection?

[Киазим Хутаба]

Поясню. В папке src/Controllers есть куча контроллеров (HomeController, PostController, e.t.c). В каждом контроллере есть методы, которые срабатывают на опредленный маршрут - все стандартно, как и в самом фреймворке.

Каждый метод, который срабатывает на маршрут, содержит аннотацию @Route.

Как известно конфигурацию роутинга в Symfony можно организовать с помощью yaml и php файлов, однако мне нужно использовать именно аннотации. Я не использую весь фреймворк, а только компонент symfony/routing.

Предполагается, что после того как со всех контроллеров будут собраны аннотации, то полученные классы Route, на основе этих аннотаций, будут помещены в контейнер RouteCollection, с которым уже понятно что делать.

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

В компоненте роутинга есть класс AnnotationDirectoryLoader, но как и, что в него передать я так и не понял.

Прошу поправить меня, если, я что-то упускаю.

Answer 1

[BoShurik]

1. Вам надо создать AnnotationClassLoader, задачей которого преобразовывать аннотации в роуты. Абстрактный класс есть в компоненте, вам надо только определить метод configureRoute. За основу можно взять код из фреймворка

Должно получится что-то вроде этого:

namespace App\Router;

use Symfony\Component\Routing\Loader\AnnotationClassLoader as BaseLoader;
use Symfony\Component\Routing\Route;

class AnnotationClassLoader extends BaseLoader
{
    protected function configureRoute(Route $route, \ReflectionClass $class, \ReflectionMethod $method, $annot)
    {
        if ('__invoke' === $method->getName()) {
            $route->setDefault('_controller', $class->getName());
        } else {
            $route->setDefault('_controller', $class->getName().'::'.$method->getName());
        }
    }
}

2. И сконфигурировать все это дело (придется использовать symfony/config):

use секция, на всякий случай

use App\Router\AnnotationClassLoader;
use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\AnnotationRegistry;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\Config\Loader\DelegatingLoader;
use Symfony\Component\Config\Loader\LoaderResolver;
use Symfony\Component\Routing\Loader\AnnotationDirectoryLoader;
use Symfony\Component\Routing\Loader\AnnotationFileLoader;
use Symfony\Component\Routing\Router;

$autoloader = require_once __DIR__ . '/../vendor/autoload.php';

AnnotationRegistry::registerLoader(array($autoloader, 'loadClass'));

$reader = new AnnotationReader();
$annotationClassLoader = new AnnotationClassLoader($reader);

$fileLocator = new FileLocator([__DIR__]);

$loaderResolver = new LoaderResolver([
    new AnnotationFileLoader($fileLocator, $annotationClassLoader),
    new AnnotationDirectoryLoader($fileLocator, $annotationClassLoader),
]);

$loader = new DelegatingLoader($loaderResolver);

$router = new Router($loader, __DIR__ . '/../src/Controller');

dump($router->getRouteCollection());

Comments

[BoShurik]

Киазим Хутаба сработало?

[Киазим Хутаба]

Да, сработало. Единственное, для прода, стоит добавить

$router = new Router($loader, __DIR__ . '/src/Controllers', ['cache_dir' => __DIR__.'/cache']);

для кеширования маршрутов.

Спасибо.

Answer 2

[Дмитрий Дерепко]

Посмотрите исходники консольной команды bin/console debug:router

https://symfony.com/doc/current/routing.html

Answer 3

[Mysterion]

Попробуйте:

$router = $this->container->get('router');
$routes = $router->getRouteCollection()->all();

Comments

[BoShurik]

В проде такое лучше не делать: https://github.com/symfony/symfony-docs/issues/6710