在 Symfony 中使用 Action class 而不是 Controller

Question

我坚持使用 Action Class 方法，而不是 Controller。解释很简单：通常 Controller 包含许多操作，当遵循 Dependency Injection 原则时，我们必须将所有必需的依赖项传递给构造函数，而这当 Controller 具有大量依赖项时，但在特定时刻（例如请求）我们只使用一些依赖项。很难维护和测试意大利面条代码。

澄清一下，我已经在 Zend Framework 2 中使用过这种方法，但它被命名为 Middleware. I've found something similar in API-Platform, where they also use Action class 而不是 Controller，但问题是我不知道如何处理它.

更新：如何获取下一个 Action Class 并替换标准 Controller 以及我应该在常规 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);
    }
}

Answer 1

这个问题对于 Whosebug 来说有点模糊，但它也有点有趣。所以这里有一些配置细节。

从开箱即用的 S4 骨架项目开始：

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

添加软删除操作

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 扩展 public 但在这种情况下，最快的方法是将操作标记为控制器：

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

此时你应该有一个有效的连接动作。

当然有很多变化和一些细节。您需要将路由限制为 POST 或假 DELETE。

您还可以考虑添加一个空的 ControllerServiceArgumentsInterface，然后使用服务 instanceof 功能来应用控制器标签，这样您就不再需要手动定义控制器服务了。

但这应该足以让您入门。

Answer 2

我尝试实现的方法被命名为 ADR pattern (Action-Domain-Responder) and Symfony has already supported this started from 3.3 version. You can refer to it as Invokable Controllers。

来自官方文档：

Controllers can also define a single action using the __invoke() method, which is a common practice when following the ADR pattern (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));
    }
}

在 Symfony 中使用 Action class 而不是 Controller

Use Action class instead of Controller in Symfony

action

symfony

symfony4