如何让我的 PHP IDE 理解依赖注入容器？

Question

目前情况：我的项目中有依赖项，我通过使用依赖项注入来解决。我想通过使用依赖项注入容器 (DIC) 来执行下一个逻辑步骤，以简化依赖项的管理并延迟加载类。

我查看了 Bucket，Pimple 和 sfServiceContainer 进行了一些测试，并且确实了解 DIC 的工作方式。我可能会选择 Pimple，因为它简单且强大。如果我没有遇到这个问题：

由于 DIC 提供的抽象，我正在使用的 IDE (PHPStorm) 不再理解我的代码中发生的情况。它不明白 $container['mailer'] 或 $sc->mailer 持有类对象。我也尝试过 Netbeans IDE：同样的问题。

这对我来说确实是一个问题，因为我的 IDE 变得毫无用处。在处理类时，我不想在没有代码提示、自动完成和重构工具的情况下进行编程。我不希望我的 IDE 在验证代码时发现各种误报。

所以我的问题是：有人处理过这个问题并找到解决方案吗？

Answer 1

您可以“手动”定义变量的类：

/** @var YourClassType $mailer */
$mailer = $container['mailer'];

在 PhpStorm 中（以及通过 标准），使用两个星号并在变量名称之前写入数据类型。

您可以编写没有变量名称的数据类型（但不能编写没有数据类型的名称）。

Answer 2

虽然您每次访问容器时都可以告诉 IDE 从容器中提取的对象的类型，但最好只执行一次。以下两种解决方案都涉及对容器进行子类化。我刚刚开始使用 Pimple，无论如何都建议这样做。

对于使用通过 -> 访问或通过神奇的 __get 方法公开的实例成员的容器，您可以告诉 IDE 它们持有什么类型。这很棒，因为它在代码运行时不涉及任何额外的解析——只有 IDE 会受到它的干​​扰。

/**
 * My container. It contains things. Duh.
 *
 * @property MyService $service
 * @property MyDao $dao
 */
class MyContainer extends Container { }

对于 Pimple 和其他充当数组的容器，您可以为您需要的顶级对象创建访问器函数。虽然这意味着在创建容器时需要进行更多解析，但应该只完成一次并保存在 APC 中。无论如何，我更喜欢方法而不是数组访问，因为它将容易忘记的数组键放在自动完成的方法中。

class MyContainer extends Pimple
{
    /**
     * @return MyService
     */
    public function getMyService() {
        return $this['service'];
    }
}

顺便说一句，对于 NetBeans 中带有 @var 的类型提示内联变量，您需要使用 /* 和一个星号。这不是文档块注释，并且不适用于 /** 或 //。此外，名称位于类型之前。

public function foo() {
    /* @var $service MyService */
    $service = $container['service'];
    ...
}

Answer 3

由于 IDE 不执行代码，因此它们不知道并且需要您的帮助。我知道这也适用于 Eclipse 和其他 IDE：提示变量的类型。

Netbeans / Phpstorm / PDT / ZendStudio 示例

/* @var $mailer MailerInterface */
$mailer = $sc->mailer

代码完成再次开始在 $mailer 上运行。

对于 PDT，重要的是：

1. 注释仅以一个 * 开头。
2. 首先是变量名称，然后是提示。

替代注释变体

由于它受到了很多讨论，因此它在 IDE 之间可能有所不同。然而，大多数 IDE 支持以上述方式对内联代码变量进行变量提示。因此，根据 IDE，这可能会以不同的方式编写，但类似，就像这里前面有两个星号：

/** @var $mailer MailerInterface */

PHPDoc 兼容性

如果您模仿内联代码的类 var doc-comment，PHPDoc 解析器可能会出现问题，如下所示：

/** @var MailerInterface $mailer  */

该文档通常用于类变量（@var - 记录类变量的数据类型）。 PHPDoc 在注释后缺少类变量的定义，这给 QA 带来了负担。

然而，当以 PHPDoc 类变量风格编写时，某些 IDE 也会为简单变量提供代码完成功能。我不知道这是否会对当前类的代码完成产生副作用，然后作为新成员可能会引入实际上不存在的成员。

Answer 4

对于那些从谷歌来到这里的人。

PHPStorm 实际上提供了一种解决此类问题的方法，而不是一遍又一遍地编写 PHPDocs——以 此处描述 获得顺利工作的自动完成和类型检查。

Answer 5

Pimple只是介绍一下容器构建器的原理。如果你理解了，你就不再需要 Pimple 了：

class Container
{
    private $shared = array();

    public function getService() {
        return new Service(
            this->getFirstDependence(),
            this->getSecondDependence()
        );
    }

    protected function getFirstDependence() {
        return new FirstDependence(
            this->getSecondDependence()
        );
    }

    protected function getSecondDependence() {
        return isset($this->shared[__METHOD__]) ? $this->shared[__METHOD__] : $this->shared[__METHOD__] =
        new SecondDependence(
        );
    }
}

这样 Pimple 就不会隐藏混合 $c['some key'] 中对象的类型。编辑容器时，您会收到自动完成建议。 Phpstorm 能够自动解析代码中的方法返回类型。你会有透明的容器。您可以覆盖容器：

class TestContainer extends Container
{
    protected function getFirstDependence() {
        return new FirstDependenceMock(
        );
    }
}

说实话，用“编程”语言编写的容器是错误的方法。容器的职责是将初始化的对象图带给调用者。访问“编程语言”可以轻松违反该责任。一些用于配置依赖关系的 DSL 更好。此外，大多数原始依赖信息（构造函数的参数类型提示）都会被 Pimple 和 sfDepenencyContainer 忽略，从而使您的配置变得臃肿且脆弱。

Answer 6

我知道问题仅与 DIC 有关，但有一个 Silex Pimple Dumper 服务提供商它将容器转储到 json 文件。同一作者编写了一个 PHPStorm 插件，它可以读取该文件并使用服务名称打开自动完成功能及其类型（类、字符串等）。我正在使用这两个组件，我可以说它们是 Silex/Pimple 自动完成的不错选择。