在Symfony中使用Action类而不是Controller



我使用操作类方法来代替控制器。解释很简单:Controller通常包括许多操作,当遵循DependencyInjection原则时,我们必须将所有必需的依赖项传递给构造函数,这会导致Controller具有大量依赖项,但在特定时刻(例如请求(我们只使用一些依赖项。很难维护和测试那个意大利面条式的代码。

为了澄清,我已经在Zend Framework 2中使用过这种方法,但在那里它被命名为中间件。我在API-Platform中发现了类似的东西,他们也使用Action类而不是Controller,但问题是我不知道如何烹饪它

UPD:我如何获得下一个操作类并替换标准控制器,以及我应该在常规Symfony项目中添加哪些配置?

<?php
declare(strict_types=1);
namespace AppActionProduct;
use AppEntityProduct;
use DoctrineORMEntityManager;
use SensioBundleFrameworkExtraBundleConfigurationMethod;
use SymfonyComponentHttpFoundationRequest;
use SymfonyComponentHttpFoundationResponse;
use SymfonyComponentRoutingAnnotationRoute;
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);
}
}

我试图实现的方法被命名为ADR模式(Action Domain Responder(,Symfony已经从3.3版本开始支持它。您可以将其称为可调用控制器。

来自官方文件:

控制器也可以使用__invoke((方法定义单个操作,这是遵循ADR模式(操作域响应程序(时的常见做法:

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

这个问题对stackoverflow来说有点模糊,尽管它也有点有趣。下面是一些配置细节。

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

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

添加SoftDeleteAction

namespace AppActionProduct;
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: AppActionProductSoftDeleteAction

此时,接线几乎完成。如果你去你得到的网址:

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

原因是默认情况下服务是私有的。通常情况下,您会从AbstractController进行扩展,该控制器负责将服务公开,但在这种情况下,最快的方法是将操作标记为控制器:

# config/services.yaml
AppActionProductSoftDeleteAction:
tags: ['controller.service_arguments']

在这一点上,你应该有一个工作有线的行动。

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

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

但这应该足以让你开始。

最新更新