Как определять контроллеры как сервисы

В Symfony контроллер не должен быть зарегистрирован как сервис. Но если вы используете конфигурацию services.yaml по умолчанию , и ваши контроллеры расширяют класс AbstractController, они уже автоматически зарегистрированы, как сервисы. Это означает, что вы можете использовать внедрение зависимостей, как в любой другой нормальный сервис.

Если ваши контроллеры не расширяют класс AbstractController, вы должны ясно пометить ваши сервисы контроллера как public. Как вариант, вы можете применить тег controller.service_arguments к вашим сервисам контроллера. Это сделает тегированные сервисы public и позволит вам внедрять сервисы в параметрах метода:

1
2
3
4
5
6
7

# config/services.yaml

# контроллеры импортируются отдельно, чтобы гарантировать, что сервисы могут быть внедрены
# в качестве аргумента действия, даже если вы не расширяете никакой базовый класс контроллера
App\Controller\:
   resource: '../src/Controller/'
   tags: ['controller.service_arguments']

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

# config/services.yaml

# эта расширенная конфигурация необходима только если не используется автомонтирование/автоконфигурация,
# что не распространено и не рекомендуется

abstract_controller.locator:
    class: Symfony\Component\DependencyInjection\ServiceLocator
    arguments:
        -
            router: '@router'
            request_stack: '@request_stack'
            http_kernel: '@http_kernel'
            session: '@session'
            parameter_bag: '@parameter_bag'
            # здесь вы можете добавить больше сервисов по мере необходимости (например, сервис `serializer`)
            # и посмотреть на класс AbstractController, чтобы увидеть, какие сервисы
            # определены в локаторе

App\Controller\:
    resource: '../src/Controller/'
    tags: ['controller.service_arguments']
    calls:
        - [setContainer, ['@abstract_controller.locator']]

По желанию, вы можете использовать PHP-атрибут #[AsController], чтобы автоматически пприменить тег controller.service_arguments к вашим сервисам контроллера:

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

// src/Controller/HelloController.php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\AsController;
use Symfony\Component\Routing\Attribute\Route;

#[AsController]
class HelloController
{
    #[Route('/hello', name: 'hello', methods: ['GET'])]
    public function index(): Response
    {
        // ...
    }
}

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

Используйте синтаксис service_id::method_name, чтобы ссылаться на метод контроллера. Если id сервиса являвется полностью квалифицированными именем класса (FQCN) вашего контроллера, как рекомендует Symfony, то синтаксис будет таким же, как если бы контроллер не был сервисом, вроде: App\Controller\HelloController::index:

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

// src/Controller/HelloController.php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

class HelloController
{
    #[Route('/hello', name: 'hello', methods: ['GET'])]
    public function index(): Response
    {
        // ...
    }
}

1
2
3
4
5

# config/routes.yaml
hello:
    path:       /hello
    controller: App\Controller\HelloController::index
    methods:    GET

1
2
3
4
5
6
7
8
9
10

<!-- 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">

    <route id="hello" path="/hello" controller="App\Controller\HelloController::index" methods="GET"/>

</routes>

1
2
3
4
5
6
7
8
9
10

// config/routes.php
use App\Controller\HelloController;
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;

return function (RoutingConfigurator $routes): void {
    $routes->add('hello', '/hello')
        ->controller([HelloController::class, 'index'])
        ->methods(['GET'])
    ;
};

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

// src/Controller/Hello.php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Attribute\Route;

#[Route('/hello/{name}', name: 'hello')]
class Hello
{
    public function __invoke(string $name = 'World'): Response
    {
        return new Response(sprintf('Hello %s!', $name));
    }
}

1
2
3
4

# config/routes.yaml
hello:
    path:       /hello/{name}
    controller: App\Controller\HelloController

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

<!-- 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">

    <route id="hello" path="/hello/{name}">
        <default key="_controller">App\Controller\HelloController</default>
    </route>

</routes>

1
2
3
4
5
6

use App\Controller\HelloController;

// app/config/routing.php
$collection->add('hello', new Route('/hello', [
    '_controller' => HelloController::class,
]));

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

// src/Controller/HelloController.php
namespace App\Controller;

use Symfony\Component\HttpFoundation\Response;
use Twig\Environment;

class HelloController
{
    public function __construct(
        private Environment $twig,
    ) {
    }

    public function index(string $name): Response
    {
        $content = $this->twig->render(
            'hello/index.html.twig',
            ['name' => $name]
        );

        return new Response($content);
    }
}