SymfonyでControllerの代わりにActionクラスを使用する

Aug 23 2020

私はコントローラーの代わりに使用するアクションクラスアプローチを順守しています。説明は非常に簡単です。多くの場合、コントローラーには多くのアクションが含まれます。依存関係の注入の原則に従う場合、必要なすべての依存関係をコンストラクターに渡す必要があります。これにより、コントローラーに膨大な数の依存関係があるが、特定の瞬間に状況が発生します。(リクエストなど)一部の依存関係のみを使用します。そのスパゲッティコードを維持してテストするのは難しいです。

明確にするために、私はすでにZend Framework 2でそのアプローチを使用していましたが、ミドルウェアという名前が付けられています。API-Platformで似たようなものを見つけました。ここでは、Controllerの代わりにActionクラスも使用していますが、問題は、それを調理する方法がわからないことです。

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バージョンから開始されたこれをすでにサポートしています。これをInvokableControllersと呼ぶことができます。

公式ドキュメントから:

コントローラーは、__ 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));
    }
}