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

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

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

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

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

  • YAML
1
2
3
4
5
6
7
# config/services.yaml

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

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

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

  • Annotations
  • Attributes
  • YAML
  • XML
  • PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// src/Controller/HelloController.php
namespace App\Controller;

use Symfony\Component\Routing\Annotation\Route;

class HelloController
{
    /**
     * @Route("/hello", name="hello", methods={"GET"})
     */
    public function index()
    {
        // ...
    }
}

Вызываемые контроллеры

Контроллеры также могут определять одно действие, используя метод __invoke(), что является распространенной практикой при следовании паттерну ADR (Действие-Домен-Ответчик):

  • Annotations
  • Attributes
  • YAML
  • XML
  • PHP
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// src/Controller/Hello.php
namespace App\Controller;

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

/**
 * @Route("/hello/{name}", name="hello")
 */
class Hello
{
    public function __invoke($name = 'World')
    {
        return new Response(sprintf('Hello %s!', $name));
    }
}

Альтернативы базовых методов контроллера

При использовании контроллера, определённого как сервиса, вы всё ещё можете расширить базовый контроллер AbstractController, и использовать его сокращения. Но, вы не обязаны это делать! Вы можете выбрать не расширять ничего и использовать внедрение зависимоти, чтобы получить доступ к разным сервисам.

Базовый исходный код класса контроллера - это отличный способ увидеть, как можно добиться выполнения общих задач. Например, $this->render() обычно используется для отображения шаблона Twig и возвращения Ответа. Но, вы также можете сделать это напрямую:

В контроллере, определённом как сервис, вы можете вместо этого внедрить сервис twig и использовать его напрямую:

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
// src/Controller/HelloController.php
namespace App\Controller;

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

class HelloController
{
    private $twig;

    public function __construct(Environment $twig)
    {
        $this->twig = $twig;
    }

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

        return new Response($content);
    }
}

Вы также можете использовать специальное внедрение зависимости на основе действий, чтобы получаь сервисы в качестве аргументов ваших методов действий контроллера.

Базовые методы контроллера и их сервисные замены

Наилучший способ увидеть, как заменить базовые воспомогательные методы Controller - это посмотреть на класс AbstractController, содержащий его логику.

Если вы хотите узнать, какое типизирование использовать для каждого сервиса, смотрите метод getSubscribedServices() в AbstractController.