Используйте класс Action вместо Controller в Symfony

Aug 23 2020

Я сторонник подхода Action Class, использующего вместо Controller . Объяснение очень простое: очень часто Контроллер включает в себя множество действий, следуя принципу внедрения зависимостей, мы должны передать все необходимые зависимости конструктору, и это создает ситуацию, когда Контроллер имеет огромное количество зависимостей, но в определенный момент времени (например, запрос) мы используем только некоторые зависимости. Этот спагетти-код сложно поддерживать и тестировать.

Чтобы уточнить, я уже использовал этот подход в Zend Framework 2, но там он называется Middleware . Я нашел нечто подобное в API-Platform, где также используется класс Action вместо Controller, но проблема в том, что я не знаю, как его приготовить.

UPD: как я могу получить следующий класс действий и заменить стандартный контроллер и какую конфигурацию я должен добавить в обычный проект Symfony?

<?php
declare(strict_types=1);

namespace App\Action\Product;

use App\Entity\Product;
use Doctrine\ORM\EntityManager;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Method;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Routing\Annotation\Route;

class SoftDeleteAction
{
    /**
     * @var EntityManager
     */
    private $entityManager; /** * @param EntityManager $entityManager
     */
    public function __construct(EntityManager $entityManager) { $this->entityManager = $entityManager; } /** * @Route( * name="app_product_delete", * path="products/{id}/delete" * ) * * @Method("DELETE") * * @param Product $product
     *
     * @return Response
     */
    public function __invoke(Request $request, $id): Response
    {
        $product = $this->entityManager->find(Product::class, $id); $product->delete();
        $this->entityManager->flush();

        return new Response('', 204);
    }
}

Ответы

3 Cerad Aug 23 2020 at 21:45

Вопрос немного расплывчатый для stackoverflow, хотя тоже немного интересен. Итак, вот некоторые детали настройки.

Начните с готового проекта скелета S4:

symfony new --version=lts s4api
cd s4api
bin/console --version # 4.4.11
composer require orm-pack

Добавьте SoftDeleteAction

namespace App\Action\Product;
class SoftDeleteAction
{
    private $entityManager; public function __construct(EntityManagerInterface $entityManager)
    {
        $this->entityManager = $entityManager;
    }
    public function __invoke(Request $request, int $id) : Response
    {
        return new Response('Product ' . $id);
    }
}

И определим маршрут:

# config/routes.yaml
app_product_delete:
    path: /products/{id}/delete
    controller: App\Action\Product\SoftDeleteAction

На данный момент проводка почти завершена. Если вы перейдете по URL-адресу, вы получите:

The controller for URI "/products/42/delete" is not callable:

Причина в том, что сервисы по умолчанию являются частными. Обычно вы расширяете AbstractController, который заботится о том, чтобы сделать службу общедоступной, но в этом случае самый быстрый подход - просто пометить действие как контроллер:

# config/services.yaml
    App\Action\Product\SoftDeleteAction:
        tags: ['controller.service_arguments']

На этом этапе у вас должно быть рабочее действие.

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

Вы также можете подумать о добавлении пустого ControllerServiceArgumentsInterface, а затем использовать функциональность services instanceof для применения тега контроллера, чтобы вам больше не нужно было вручную определять службы контроллера.

Но этого должно быть достаточно, чтобы вы начали.

1 SerhiiPopov Sep 24 2020 at 18:38

Подход, который я пытался реализовать, называется шаблоном ADR (Action-Domain-Responder), и Symfony уже поддерживает его, начиная с версии 3.3. Вы можете называть его вызываемыми контроллерами .

Из официальных документов:

Контроллеры также могут определять одно действие с помощью метода __invoke (), который является обычной практикой при следовании шаблону ADR (Action-Domain-Responder):

// src/Controller/Hello.php
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));
    }
}