Как создать пользовательский загрузчик маршрутов

Дата обновления перевода 2023-01-12

Как создать пользовательский загрузчик маршрутов

Базовые приложения могут определять все свои маршруты в одном файле конфигурации - обычно, config/routes.yaml (см. ). Однако, в большинстве приложений распространено импортирование обозначения маршрутов из разных источников: PHP-атрибутов в файлах контроллера, YAML, XML или PHP файлов, храняшихся в каком-то каталоге и т.д.

Встроенные загрузчики маршрутов

Symfony предоставляет несколько загррузчиков для наиболее распорстраненных нужд:

YAML
XML
PHP

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
        # config/routes.yaml
app_file:
    # загружает маршруты из заданого файла маршрутизации, хранящегося в каком-то пакете
    resource: '@AcmeBundle/Resources/config/routing.yaml'

app_psr4:
    # загружает маршруты из PHP-атрибутов контроллеров, найденных в заданном корне пространства имен PSR-4
    resource:
        path: '../src/Controller/'
        namespace: App\Controller
    type: attribute

app_attributes:
    # загружает маршруты из PHP-атибутов контроллеров, найденных в этом каталоге
    resource: '../src/Controller/'
    type:     attribute

app_class_attributes:
    # загружает маршруты из PHP-атрибутов заданного класса
    resource: App\Controller\MyController
    type:     attribute

app_directory:
    # загружает маршруты из YAML, XML или PHP файлов, найденных в этом каталоге
    resource: '../legacy/routing/'
    type:     directory

app_bundle:
    # загружает маршруты из YAML, XML или PHP файлов, найденных в каком-то каталоге пакета
    resource: '@AcmeOtherBundle/Resources/config/routing/'
    type:     directory
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
        <!-- config/routes.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <!-- загружает маршруты из заданого файла маршрутизации, хранящегося в каком-то пакете -->
    <import resource="@AcmeBundle/Resources/config/routing.yaml"/>

    <!-- загружает маршруты из PHP-атрибутов контроллеров, найденных в заданном корне пространства имен PSR-4 -->
    <import type="attribute">
        <resource path="../src/Controller/" namespace="App\Controller"/>
    </import>

    <!-- загружает маршруты из PHP-атибутов контроллеров, найденных в этом каталоге -->
    <import resource="../src/Controller/" type="attribute"/>

    <!-- загружает маршруты из PHP-атрибутов заданного класса -->
    <import resource="App\Controller\MyController" type="attribute"/>

    <!-- загружает маршруты из YAML, XML или PHP файлов, найденных в этом каталоге -->
    <import resource="../legacy/routing/" type="directory"/>

    <!-- загружает маршруты из YAML, XML или PHP файлов, найденных в каком-то каталоге пакета -->
    <import resource="@AcmeOtherBundle/Resources/config/routing/" type="directory"/>
</routes>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
        // config/routes.php
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes) {
    // загружает маршруты из заданого файла маршрутизации, хранящегося в каком-то пакете
    $routes->import('@AcmeBundle/Resources/config/routing.yaml');

    // загружает маршруты из PHP-атрибутов  (#[Route(...)]) контроллеров, найденных 
    // в заданном корне пространства имен PSR-4
    $routes->import(
        ['path' => '../src/Controller/', 'namespace' => 'App\Controller'],
        'attribute',
    );

    // загружает маршруты из PHP-атибутов (#[Route(...)]) контроллеров, найденных 
    // в этом каталоге
    $routes->import('../src/Controller/', 'attribute');

    // загружает маршруты из PHP-атрибутов (#[Route(...)]) заданного класса
    $routes->import('App\Controller\MyController', 'attribute');

    // загружает маршруты из YAML, XML или PHP файлов, найденных в этом каталоге
    $routes->import('../legacy/routing/', 'directory');

    // загружает маршруты из YAML, XML или PHP файлов, найденных в каком-то каталоге пакета
    $routes->import('@AcmeOtherBundle/Resources/config/routing/', 'directory');
};
    

6.1

Значение attribute второго аргрумента import() было представлено в Symfony 6.1.

6.2

Функция импорта маршрутов из корня пространства имен PSR-4 была представлена в Symfony 6.2.

Note

При импорте источников, ключ (например, app_file) - это имя коллекции. Просто убедитесь в том, что он уникальный для файла, чтобы никакие другие строки его не переопределяли.

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

Что такое пользовательский загрузчик маршрутов

Пользовательский загрузчик маршрутов позволяет вам генерировать маршруты, основанные на неких договорённостях или шаблонах. Примером такого использования является библиотека OpenAPI-Symfony-Routing, где маршруты генерируются в зависимости от аннотаций OpenAPI/Swagger. Другой пример - SonataAdminBundle, который создает маршруты, основыванясь на соглашениях CRUD.

Загрузка маршрутов

Маршруты в приложении Symfony загружаются с помощью DelegatingLoader. Этот загрузчик использует несколько других загрузчиков (делегатов) для загрузки ресурсов разных типов, например YAML-файлов или атрибутов #[Route] в файлах контроллера. Специализированные загрузчики внедряют LoaderInterface и таким образом имеют два важных метода: supports() и load().

Возьмём эти строки из routes.yaml:

YAML
XML
PHP

        1
2
3
4
        # config/routes.yaml
controllers:
    resource: ../src/Controller/
    type: attribute
    

        1
2
3
4
5
6
7
8
9
        <!-- config/routes.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <import resource="../src/Controller" type="attribute"/>
</routes>
    

        1
2
3
4
5
6
        // config/routes.php
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes) {
    $routes->import('../src/Controller', 'attribute');
};
    

Когда главный загрузчик разбирает это, он обращается ко всем зарегистрированным загрузчикам-делегатам и вызывает их метод supports() с заданным ресусром (../src/Controller/) и типом (attribute) в качестве аргументов. Когда один из загрузчиков возвращает true, будет вызван его метод load(), который должен вернуть RouteCollection, содержащий объекты Route.

Note

Маршруты, загруженные этим способом, будут кешированы маршрутизатором так же, как и когда они определны в одном из форматов по умолчанию (например, XML, YAML, PHP файлах).

Загрузка маршрутов с пользовательским сервисом

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

Чтобы сделать это, определите type: service в качестве типа загружаемого источника маршрутизации, и сконфигурируйте сервис и метод, чтобы они вызывали:

YAML
XML
PHP

        1
2
3
4
        # config/routes.yaml
admin_routes:
    resource: 'admin_route_loader::loadRoutes'
    type: service
    

        1
2
3
4
5
6
7
8
9
        <!-- config/routes.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <import resource="admin_route_loader::loadRoutes" type="service"/>
</routes>
    

        1
2
3
4
5
6
        // config/routes.php
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes) {
    $routes->import('admin_route_loader::loadRoutes', 'service');
};
    

В этом примере, маршруты загружаются, вызывая метод loadRoutes() сервиса, ID которого admin_route_loader. Ваш сервис не должен расширять или реализовывать никакой особенный класс, но вызванный метод должен возвращать объект RouteCollection.

Если вы используете автоконфигурацию , ваш класс должен реализовывать интерфейс RouteLoaderInterface, чтобы быть тегированным автоматически. Если вы не используете автоконфигурацию, добавьте вручную тег routing.route_loader.

Note

Маршруты, определенные с использованием сервиса загрузчика маршрутов, будут автоматически кешированы фреймворком. Поэтому когда вашему сервису нужно загрузить новые маршруты, не забудьте очистить кеш.

Tip

Если ваш сервис вызываемый, вам не нужно указывать метод для использования.

Создание пользовательского загрузчика

Для того, чтобы загружать маршруты из пользовательского источника (т.е. из чего-либо кроме аннотаций и файлов YAML или XML), вам нужно создать пользовательский загрузчик маршрутов. Этот загрузчик должен внедрять LoaderInterface.

В большинстве случаев, его легче расширить из
Loader вместо того, чтобы
внедрять LoaderInterface самостоятельно.

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

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
        // src/Routing/ExtraLoader.php
namespace App\Routing;

use Symfony\Component\Config\Loader\Loader;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

class ExtraLoader extends Loader
{
    private $isLoaded = false;

    public function load($resource, string $type = null)
    {
        if (true === $this->isLoaded) {
            throw new \RuntimeException('Do not add the "extra" loader twice');
        }

        $routes = new RouteCollection();

        // подготовьте новый маршрут
        $path = '/extra/{parameter}';
        $defaults = [
            '_controller' => 'App\Controller\ExtraController::extra',
        ];
        $requirements = [
            'parameter' => '\d+',
        ];
        $route = new Route($path, $defaults, $requirements);

        // добавьте новый маршрут в коллекцию маршрутов
        $routeName = 'extraRoute';
        $routes->add($routeName, $route);

        $this->isLoaded = true;

        return $routes;
    }

    public function supports($resource, string $type = null)
    {
        return 'extra' === $type;
    }
}
    

Убедитесь в том, что контроллер, который вы указываете, действительно существует. В этом случае, вам нужно создать метод extra() в ExtraController:

        1
2
3
4
5
6
7
8
9
10
11
12
13
        // src/Controller/ExtraController.php
namespace App\Controller;

use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\Response;

class ExtraController extends AbstractController
{
    public function extra($parameter)
    {
        return new Response($parameter);
    }
}
    

Теперь, определите сервис для ExtraLoader:

YAML
XML
PHP

        1
2
3
4
5
6
        # config/services.yaml
services:
    # ...

    App\Routing\ExtraLoader:
        tags: [routing.loader]
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        <!-- config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services
        https://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <!-- ... -->

        <service id="App\Routing\ExtraLoader">
            <tag name="routing.loader"/>
        </service>
    </services>
</container>
    

        1
2
3
4
5
6
7
8
9
10
11
12
        // config/services.php
namespace Symfony\Component\DependencyInjection\Loader\Configurator;

use App\Routing\ExtraLoader;

return static function (ContainerConfigurator $container) {
    $services = $configurator->services();

    $services->set(ExtraLoader::class)
        ->tag('routing.loader')
    ;
};
    

Отметьте тег routing.loader. Все сервисы с этим тегом будут отмечены, как потенциальные загрузчики маршрутов и добавлены в качестве специализированных загрузчиков маршрутов в сервис routing.loader service, который является экзеплмяром DelegatingLoader.

Использование пользовательского загрузчика

Если вы больше ничего не делали, то ваш пользовательский загрузчик маршрутов не будет вызван. Что вам осталось сделать, так это добавить несколько строчек в конфигурацию маршрутизации:

YAML
XML
PHP

        1
2
3
4
        # config/routes.yaml
app_extra:
    resource: .
    type: extra
    

        1
2
3
4
5
6
7
8
9
        <!-- config/routes.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<routes xmlns="http://symfony.com/schema/routing"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/routing
        https://symfony.com/schema/routing/routing-1.0.xsd">

    <import resource="." type="extra"/>
</routes>
    

        1
2
3
4
5
6
        // config/routes.php
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes) {
    $routes->import('.', 'extra');
};
    

Важной частью здесь является ключ type. Его значение должно быть extra, так как это тот тип, который поддерживает ExtraLoader, и таким образом его метод load() точно будет вызван. Ключ resource неважен для ExtraLoader, поэтому он установлен в значении . (одна точка).

Note

Маршруты, определённые с использованием пользовательских загрузчиков маршрутов, будут автоматически кешированы фреймворком. Так что когда вы будете что-либо изменять в самом классе загрузчика, не забудьте очистить кеш.

Более продвинутые загрузчики

Если ваш пользовательский загрузчик маршрутов расширен из Loader, как показано выше, вы также можете с пользой использовать предоставленный распознаватель, экземпляр LoaderResolver, для загрузки вторичных ресурсов маршрутизации.

Конечно же, вам все еще нужно внедрить supports() и load(). Когда вам захочется загрузить другой ресурс - например, YAML-файл конфигурации маршрутизации - вы можете вызвать метод import():

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
        // src/Routing/AdvancedLoader.php
namespace App\Routing;

use Symfony\Component\Config\Loader\Loader;
use Symfony\Component\Routing\RouteCollection;

class AdvancedLoader extends Loader
{
    public function load($resource, string $type = null)
    {
        $routes = new RouteCollection();

        $resource = '@ThirdPartyBundle/Resources/config/routes.yaml';
        $type = 'yaml';

        $importedRoutes = $this->import($resource, $type);

        $routes->addCollection($importedRoutes);

        return $routes;
    }

    public function supports($resource, string $type = null)
    {
        return 'advanced_extra' === $type;
    }
}
    

Note

Имя ресурса и тип импортированной конфигурации маршрутизации могут быть любыми, если они будут поддерживаться загрузчиком конфигурации маршрутизации ((YAML, XML, PHP, аннотация, и т.д.).

Note

Для более продвинутого использования, посмотрите ChainRouter, предоставленный проектом Symfony CMF. Этот маршрутизатор позволяет приложениям исползовать сочетание двух и более маршрутизаторов, например, для того, чтобы продолжать использовать систему маршрутизации Symfony по умолчанию, при написании пользовательского маршрутизатора.