Настройка маршрутов в Symfony от атрибутов до кастомных лоадеров

Продвинутые примеры настройки маршрутов Symfony

1. Условная маршрутизация с ExpressionLanguage

// src/Controller/ConditionalController.php
use Symfony\Component\Routing\Annotation\Route;

class ConditionalController extends AbstractController
{
    #[Route('/special-offer', name: 'special_offer', condition: "request.headers.get('X-Test') == 'true'")]
    public function special(): Response
    {
        return new Response('Condition met');
    }
}

Маршрут доступен только если в запросе присутствует заголовок X-Test: true. Условие может использовать объекты request, params, context. Ошибка: неправильный синтаксис выражения приводит к исключению.

// curl -H "X-Test: true" https://example.com/special-offer
// > Condition met
// curl https://example.com/special-offer
// > 404 Not Found

2. Использование нескольких методов и схем

#[Route('/contact', name: 'contact', methods: ['GET', 'POST'], schemes: ['https'])]
public function contact(): Response
{
    // ...
}

Метод может обрабатывать и GET (отображение формы) и POST (отправка). Схема https обязательна. Если не указать schemes, маршрут будет работать для любого протокола.

// http://example.com/contact -> 404, т.к. не https
// https://example.com/contact -> OK

3. Редирект с помощью маршрута

// config/routes.yaml
old_products:
    path: /old-products
    controller: Symfony\Bundle\FrameworkBundle\Controller\RedirectController::redirectAction
    defaults:
        route: product_list
        permanent: true

Вместо написания контроллера используется встроенный RedirectController. Редирект 301 (permanent) на маршрут product_list. Можно указать permanent: false для 302.

// GET /old-products -> 301 Location: /products

4. Сложные требования с регулярными выражениями

#[Route('/article/{slug}', name: 'article_show', requirements: ['slug' => '[a-z0-9\-]+'])]
public function show(string $slug): Response {}

Допускаются только строчные буквы, цифры и дефис. Ошибка: если slug содержит заглавные или спецсимволы, маршрут не срабатывает - возвращается 404.

// /article/my-article -> OK
// /article/My_Article! -> 404

5. Группировка и префикс с общим контроллером

// src/Controller/Api/V1/UserController.php
#[Route('/api/v1/users', name: 'api_users_')]
class UserController extends AbstractController
{
    #[Route('', name: 'list', methods: ['GET'])]
    public function list(): Response {}

    #[Route('/{id}', name: 'show', methods: ['GET'], requirements: ['id' => '\d+'])]
    public function show(int $id): Response {}
}

Все маршруты класса начинаются с /api/v1/users. Имена: api_users_list, api_users_show. Параметр name на классе задаёт префикс имени.

// GET /api/v1/users -> list()
// GET /api/v1/users/42 -> show(42)

6. Динамическая загрузка маршрутов через кастомный лоадер

// src/Routing/ExtraRouteLoader.php
class ExtraRouteLoader implements LoaderInterface
{
    public function load($resource, $type = null)
    {
        $routes = new RouteCollection();
        $route = new Route('/extra', ['_controller' => 'App\Controller\ExtraController::index']);
        $routes->add('extra_route', $route);
        return $routes;
    }

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

Регистрируется как сервис с тегом routing.loader. В config/routes.yaml подключается: extra: resource: . type: extra. Позволяет генерировать маршруты программно, например, из базы данных.

// GET /extra -> ExtraController::index()

7. Маршруты с локализацией и переводом пути

// config/routes/translated.yaml
product_list_en:
    path: /{_locale}/products
    controller: App\Controller\ProductController::list
    requirements:
        _locale: en|fr

product_list_fr:
    path: /{_locale}/produits
    controller: App\Controller\ProductController::list
    requirements:
        _locale: fr

Для разных языков разные пути, ведущие к одному и тому же контроллеру. Лучше использовать пакет lunetics/locale-bundle или JMSTranslationBundle для автоматической генерации.

// /en/products -> controller
// /fr/produits -> controller (тот же)