php - Symfony 4 服务依赖注入(inject)——构造函数与方法

Question

所以我有一个 Symfony Controller ，我正在通过参数将所需的服务注入(inject)到我的方法中。

其中一个参数 (MySqlGroupDAO $groupDAO) 被该 Controller 类的所有方法使用。

目前，我将“公共(public)”参数作为每个方法中的最后一个参数传递，如下所示:

/**
 * @Route("/{id}", methods={"POST"})
 * @IsGranted("EDIT_GROUP", subject="parentGroup")
 */
public function addGroup(Request $request, MySqlGroupDAO $groupDAO)  {
    $group = new Group();
    //code to init group from request

    $groupDAO->addGroup($group);

    return new Response("Adding $groupName");
}

这样做可以让我消除我的 __construct 方法。但是，我不确定这是最好的方法。因为它在所有方法中都很常见，所以重新添加我的构造函数并做这样的事情会更好吗？:

private $groupDAO;

public function __construct(
    Config $config,
    ValidatorInterface $validator,
    TranslatorInterface $translator,
    RequestStack $requestStack
) {
    parent::__construct($config, $validator, $translator, $requestStack);
    $this->groupDAO = new MySqlGroupDAO($config);
}


/**
 * @Route("/{id}", methods={"POST"})
 * @IsGranted("EDIT_GROUP", subject="parentGroup")
 */
public function addGroup(Request $request)  {
    $group = new Group();
    //code to init group from request

    $this->groupDAO->addGroup($group);

    return new Response("Adding $groupName");
}

在这样做的过程中，我在我的所有方法中(在这个特定的类中)消除了大约六个参数。但是我在我的构造函数中添加回来，这需要我添加一个类参数，并在我的构造函数中注入(inject)几个额外的参数，因为它扩展了另一个类。

以一种方式与另一种方式相比有优势吗？

谢谢。

Answer 1

在 Controller 的路由方法中使用 DI 的原因:

• 不易受 parent::__construct 方法变化的影响。在构造函数上使用 DI 意味着只要发生​​变化，您就必须调整代码。另请注意，某些 Symfony bundle 可能会假定 Controller 具有特定签名，如果没有，则可能会使事情变得更加复杂。
• 如果至少有一个路由不使用该服务，通过使用这些细粒度的 DI，我们可以避免在不必要时实例化服务(如果它有自己的 DI 尚未使用，这可能会很昂贵别的地方)。这可以通过使用 lazy services 来大部分抵消。不过。

在构造函数中使用 DI 的原因:

• 在 Controller 以外的服务中(以及在 Controller 的路由方法之外的方法中，如果有的话)，您不能使用 Autowiring 。如果您想使用方法的参数注入(inject)依赖项，则必须在每次调用时手动传递该依赖项。这反过来意味着无论哪个服务调用该方法本身都应该在所需服务上有一个 DI。因此，问题发生了转移，但它不能无限地转移，并且在某些时候你会想要在父级上使用一些 Autowiring 。

在构造函数中使用 DI 的替代方法:

您还可以使用 setter injection并配置您的服务 this way .这在功能上与在构造函数中使用 DI 非常相似，但它绕过了从父构造函数生成不同签名以及在父构造函数更改时需要更多维护工作的主要缺点。

您还可以使其更易于用于您经常注入(inject)的服务。使需要此 DI 的服务实现接口(interface)并使用 _instanceof 配置它们. Symfony 用它的 ContainerAwareInterface 做到了这一点甚至有一个形式为 ContainerAwareTrait 的促进者声明 setter 和属性。在您的情况下，如果多个服务需要 MySqlGroupDAO 服务，您可以定义一个 MySqlGroupDAOAwareTrait 和 MySqlGroupDAOAwareInterface，添加一个 MySqlGroupDAOAwareInterface 在您的 services.yaml 的 _instanceof 部分中输入，并使用特征并在需要 DI 的服务中实现接口(interface)。

---

2021 年 11 月编辑:

这个答案仍在被新人阅读，所以我想我会用 Symfony 5.2 添加的东西来完成它(并且它需要 PHP 8):使用 PHP 属性进行依赖注入(inject)。

这允许在不触及 services.yaml 的情况下进行 Setter 注入(inject)，并且它允许公共(public)属性注入(inject)。这是这两个文档的示例:

use Symfony\Contracts\Service\Attribute\Required;

class SomeService
{
    // Example of public property injection
    #[Required]
    public Bar $bar;

    // Example of setter injection without editing services.yaml
    #[Required]
    public function setFoo(Foo $foo): void
    {
        // ...
    }
}

请注意，上面使用的属性和 setter 方法需要公开(这可能适合也可能不适合您)。

阅读更多信息 https://symfony.com/blog/new-in-symfony-5-2-php-8-attributes .