关于弃用 ServiceLocatorAware

一两个月前，我们推出了一个新版本的zend-mvc，它提供了许多向前兼容的功能，以帮助用户为即将发布的v3版本准备他们的应用程序。

其中一个显然颇具争议：在v3中，zend-servicemanager不再定义ServiceLocatorAwareInterface，当您尝试将服务定位器注入应用程序时，这个特定版本的zend-mvc会引发弃用通知服务，或在您的控制器中拉取服务定位器。

争论是这样的：

• “依赖注入太难理解了！”
• “这个特性简化了开发！”
• “如果这很糟糕，为什么它会出现在第一名？”

这些人通常会跟在后面：

• 说他们会更换框架（好吧，我猜？）；
• 要求恢复该功能（嗯，否）；
• 要求删除弃用通知（为什么？这样您就可以延迟升级直到您要求恢复该功能时的痛苦？）；或
• 询问变更的理由。

所以，我决定做最后一个，证明更改的合理性，它解决了我们不做中间两个的原因，并解决了为什么关于ServiceLocatorAware的有用性的假设和断言是主要是被误导了。

最初发布在其他地方

这最初是作为对问题的评论发布的。我决定将它发布到我的博客上以吸引更多的观众，并提供更多的背景和细节。

最初发布在其他地方

这最初是作为对问题的评论发布的。我决定将它发布到我的博客上以吸引更多的观众，并提供更多的背景和细节。

zend-servicemanager的目的是用作控制反转容器。

它从来没有打算作为通用服务定位器（有趣的是，链接细节主要是模式的缺点！）；这个角色是本着“快速应用程序开发”和“简化初始开发”的精神强加给它的，但其意图是，一旦类稳定下来，就应该重构以注入依赖项。（而且我们都知道忙碌的开发人员会发生什么：重构被推迟或永远不会发生。）

为什么不应该注入服务定位器？

谷歌“服务定位器反模式”以了解为什么不应该使用它。要点归结为：

• 依赖隐藏。
• 间接错误。
• 类型安全。
• 脆弱性。

让我们逐一分析。

依赖隐藏

“依赖隐藏”是什么意思？

看看这个类签名：

class Foo implements DispatchableInterface, ServiceLocatorAwareInterface
{
    /* Defined by DispatchableInterface */
    public function dispatch(Request $request, Response $response);

    /* Defined by ServiceLocatorAwareInterface */
    public function setServiceLocator(ServiceLocatorInterface $serviceLocator);
    public function getServiceLocator();
}

基于此，您会期望：

• 您可以在没有依赖项的情况下实例化对象。
• 如果您觉得有必要，您可以将服务定位器传递给实例。
• 您应该能够通过向它传递一个请求和响应实例来执行dispatch()，它应该会成功返回。

服务定位器是模糊的；它的用途不明确，而且显然不是必需的依赖项，因为它在setter方法中。

因此，您为dispatch()方法编写了一个测试，您得到了一个ServiceNotFoundException。怎么了？

您深入了解dispatch()方法的代码：

public function dispatch(Request $request, Response $response)
{
    $authentication = $this->serviceLocator->get('authentication');

    if (! $authentication->hasIdentity()) {
        $response->setStatus(401);
        return $response;
    }

    $identity = $authentication->getIdentity();
    $response->setBody(
        $this->serviceLocator->get('renderer')->render(
            'foo',
            ['identity' => $identity]
        )
    );
    return $response;
}

ServiceNotFoundException可能被抛出的位置有两个：在方法的第一行，或在setBody()调用中。在这两种情况下，您都面临着一个难题：

• 您现在知道服务定位器是必需的。从最初看班级来看，这并不明显；它似乎是一个可选依赖项。
• 您不知道每个authentication和renderer服务。

class Foo implements DispatchableInterface
{
    public function __construct(
        AuthenticationService $authentication,
        RendererInterface $renderer
    );

    /* Defined by DispatchableInterface */
    public function dispatch(Request $request, Response $response);
}