Маршрутизация¶

Создание маршрутов¶

Для начала, установите пакет аннотаций:

1

$ composer require annotations

Маршрут - это карта от пути URL к контроллеру. Представьте, что вы хотите один маршрут, точно совпадающий с /blog, а второй - более динамический, который может совпадать с любым URL, вроде /blog/my-post или /blog/all-about-symfony:

Благодаря этим двум маршрутам:

• Если пользователь переходит в /blog, первый маршрут подходит и выполняется list();
• Если вользователь переходит в /blog/*, второй маршрут подходит и выполняется show(). Так как путь маршрута /blog/{slug}, в show() определяется переменная $slug, совпадающая с этим значением. Например, если пользователь переходит на /blog/yay-routing, тогда $slug будет равняться yay-routing.

Если в вашем маршруте есть {placeholder}, тогда эта часть становится метасимволом (wildcard): она подходит под любое значение. Ваш контроллер теперь может также иметь аргумент под названием $placeholder (названия метасимвола и аргумента должны совпадать).

Каждый маршрут также имеет внутренне имя: blog_list и blog_show. Они могут быть любыми (при условии, что каждое уникально) и пока не имеют никакого значения. Вы будете использовать их позже, чтобы генерировать URL.

Добавляем ограничения {метасимволы}¶

Представьте, что путь blog_list будет содержать список постов блога с разбивкой по страницам, с URL типа /blog/2 и /blog/3 для страниц 2 и 3. Если вы измените путь этого маршрута на /blog/{page}, у вас возникнет проблема:

• blog_list: /blog/{page} будет подходить под /blog/*;
• blog_show: /blog/{slug} будет также подходить под /blog/*.

Когда два маршрута подходят под один и тот же URL, первый маршрут, который загружается - выигрывает. К сожалению, это значит, что /blog/yay-routing будет подходить с ``blog_list`. Нехорошо!

Для того, чтобы это исправить, добавьте ограничение, указывающее, что метасимвол {page} может подходить только под URL с набором цифр:

\d+ - это регулярное выражение, которое подходит под набор цифр любой длины. Теперь:

Чтобы узнать о других ограничениях маршрутов, например, HTTP-методе, имени хоста и динамических выражениях, см. Ограничения маршрутов.

Устанавливаем значение по умолчанию для {placeholder}¶

В предыдущем примере, blog_list имеет путь /blog/{page}. Если пользователь зайдет на /blog/1, он подойдёт. Но если пользователь зайдет на /blog, то он не подойдёт. Как только вы добавите в маршрут {placeholder}, он должен иметь значение.

Так как же сделать так, чтобы blog_list подходил, когда пользователь заходит на /blog? Путем добавления значения по умолчанию:

Теперь, когда пользователь заходит на /blog, маршрут blog_list будет подходить, а $page теперь по умолчанию будет иметь значение 1.

Список всех ваших маршрутов¶

По мере роста вашего приложения, у вас в итоге появится много маршрутов! Чтобы увидеть их все, выполните:

1

$ php bin/console debug:router

1
2
3
4
5
6

------------------------------ -------- -------------------------------------
 Имя                           Метод    Путь
------------------------------ -------- -------------------------------------
 app_lucky_number              ANY    /lucky/number/{max}
 ...
------------------------------ -------- -------------------------------------

Пример продвинутой маршрутизации¶

Держа все это в уме, посмотрите на этот продвинутый пример:

Как вы увидели, этот маршрут будет подходить только если часть {_locale} URL будет либо en, либо fr, и если {year} будет числом. Этот маршрут также показывает,как вы можете использовать точку вместо слеша между заполнителями. URL, подходящие под этот маршрут, могут выглядеть так:

• /articles/en/2010/my-post
• /articles/fr/2010/my-post.rss
• /articles/en/2013/my-latest-post.html

Шаблон именования контроллера¶

Значене controller в ваших маршрутах имеет очень простой формат CONTROLLER_CLASS::METHOD. Если ваш контроллер зарегистрирован, как сервис, то вы также можете использовать только одно двоеточие-разделитель (например, service_name:index).

Генерирование URL¶

Система маршрутизации также может генерировать URL. В действительности, маршрутизация - это двусторонняя система: прокдадыване пути от URL к контроллеру, а также маршрута обратно к URL.

Для генерации URL, вам нужно будет указать имя маршрута (например, blog_show) и любые метасимволы (например, slug = my-blog-post), используемые в пути для этого маршрута. С этой информацией, можно с легкостью сгенерировать любой URL:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

class MainController extends Controller
{
    public function show($slug)
    {
        // ...

        // /blog/my-blog-post
        $url = $this->generateUrl(
            'blog_show',
            array('slug' => 'my-blog-post')
        );
    }
}

Если вам нужно сгенерировать URL из сервиса, типизируйте сервис UrlGeneratorInterface:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

// src/Service/SomeService.php

use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

class SomeService
{
    private $router;

    public function __construct(UrlGeneratorInterface $router)
    {
        $this->router = $router;
    }

    public function someMethod()
    {
        $url = $this->router->generate(
            'blog_show',
            array('slug' => 'my-blog-post')
        );
        // ...
    }
}

1
2
3
4
5

$this->router->generate('blog', array(
    'page' => 2,
    'category' => 'Symfony',
));
// /blog/2?category=Symfony

1
2
3
4

use Symfony\Component\Routing\Generator\UrlGeneratorInterface;

$this->generateUrl('blog_show', array('slug' => 'my-blog-post'), UrlGeneratorInterface::ABSOLUTE_URL);
// http://www.example.com/blog/my-blog-post

Устранение проблем¶

Вот некоторые самые распространенные ошибки, с которыми вы можете столкнуться во время работы с маршрутизацией:

# Контроллер "AppBundleControllerBlogController::showAction()" требует, чтобы вы предоставили значение для аргумента "$slug".

Controller "AppBundleControllerBlogController::showAction()" requires that you provide a value for the "$slug" argument.

Это происходит, когда ваш метод контроллера имеет аргумент (например, $slug):

1
2
3
4

public function show($slug)
{
    // ..
}

Но ваш путь маршрута не имеет метасимвола {slug} (например, он /blog/show). Добавьте {slug} к вашему пути маршрута: /blog/show/{slug}, либо определите значение по умолчанию для аргумента (например, $slug = null).

Некоторым обязательным параметрам не хватает ("slug") для генерирования URL для маршрута "blog_show".

Это означает, что вы пробуете создать URL маршруту blog_show, но вы не указываете значение slug (которое является обязательным, так как оно имеет {slug}) для метасимвола в пути маршрута. Чтобы исправить это, укажите значение slug при генерировани маршрута:

1
2
3
4

$this->generateUrl('blog_show', array('slug' => 'slug-value'));

// или, в Twig
// {{ path('blog_show', {'slug': 'slug-value'}) }}

Перевод маршрутов¶

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

Продолжайте!¶

Маршрутизация - готово! Теперь, исследуйте силу контроллеров.

Узнайте больше о маршрутизации¶