在不是捆绑包的包中定义 Symfony2 服务

Question

我正在为一个 Symfony 应用程序构建一个包，该应用程序使用了我编写的几个不同的组件。我将调用捆绑包 MyAppBundle。

我的包使用的组件本身并不依赖于 Symfony，但我希望能够为每个组件定义一组 Symfony 服务，这些服务将在每个单独包的 services.yml 文件中定义 -但我不希望这些包成为完全成熟的捆绑包。

为什么？因为我不希望包依赖于 Symfony 框架，所以我不想将包构建为 Symfony 包，并且我希望能够通过注册单个 MyAppBundle 来为我的应用程序注册所有必需的服务，同时如果我愿意，我可以灵活地在不相关的 Symfony 应用程序中使用这些组件的服务。如果我将它们制作成完整的包，那么我必须将每个包单独加载到我的 AppKernel 中，这是我不想要的。

这应该很容易 - 根据我只需要构建容器扩展的文档：http://symfony.com/doc/current/book/service_container.html#importing-configuration-via-container-extensions

所以我为我的组件创建了一个容器扩展来加载它的服务定义：

namespace MyComponent;

class MyComponentExtension extends \Symfony\Component\DependencyInjection\Extension\Extension
{

    public function load(array $configs, ContainerBuilder $container)
    {
        $loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
        $loader->load('services.yml');
    }

}

我只是不确定如何从 MyAppBundle 加载此扩展程序？关于如何从另一个包加载扩展的信息似乎很少。也许这不是推荐的做事方式，但由于上述原因，我认为我的用例是合理的。

到目前为止，我从 MyAppBundle 加载 MyComponentExtension 的最佳尝试是：

namespace MyAppBundle;

class MyAppBundle extends Bundle
{

    public function build(ContainerBuilder $container)
    {
        $extensions = array(
            new MyComponentExtension(),
            new MyOtherComponentExtension()
        );
        $aliases = array();
        foreach($extensions as $extension) {
            $container->registerExtension($extension);
            $aliases[] = $extension->getAlias();
        }
        $container->addCompilerPass(new MergeExtensionConfigurationPass($aliases));
    }

}

“addCompilerPass”位是从我能找到的少量信息中收集到的，我相当确定它是错误的。当我这样做时，我无法访问 MyComponentExtension 提供的服务。我很确定我只需要确保将定义正确编译到容器中，但不确定如何执行此操作！

Answer 1

有两种类型的耦合：硬耦合和软耦合。 然后你就有了解耦。

解耦

当您将组件与捆绑包分离时，您要么让每个部分依赖于一个公共接口 (http://en.wikipedia.org/wiki/Dependency_inversion_principle)。

或者你可以有一个单向的依赖。在这种情况下，bundle 将依赖于组件。一个例子是依赖于 Symfony 组件的 Symfony 框架包。

对于第一个示例，您将使用配置来定义要使用的类。 然后包含第二个，您将在包中为组件的类定义服务。同样，这就是 Symfony Framework Bundle 所做的。

软耦合

这是当一个库引用另一个（或另一个抽象），但不需要它（除非您尝试使用它，之后它间接成为硬依赖）。例如，如果缺少提供它的资源，则会省略附加功能。

这方面的一个例子是将你的依赖注入放在组件中，提供对 Symfony 的支持，但不需要它。

例如，看看Symfony\Bridge\Doctrine\DependencyInjection\AbstractDoctrineExtension。

常见的策略是创建一个抽象扩展，然后在包中覆盖它。 如果需要进一步集成 (http://en.wikipedia.org/wiki/Liskov_substitution_principle)，捆绑包可以覆盖组件的某些部分。

不管怎样

理想的情况是组件可以单独使用 (http://en.wikipedia.org/wiki/Single_responsibility_principle)，并且只使用 Symfony 将它们引导为服务。

解耦

Bundle => depends on => Component
Component depends on nothing

软依赖

Bundle => depends on => Component  
Component -> supports -> Symfony

你不应该做的是创建一个双向依赖。那就是每个部分都静态地相互依赖。

编辑以回应如何：

你可以，虽然你为什么需要对我来说仍然是个谜。

class MyAppBundle extends Bundle
{
    /**
     * Override extension getter.
     */
    public function getContainerExtension()
    {
        if(null === $this->extension) {
            $this->extension = new My\Component\Extension();
        }

        return $this->extension;
    }
}

Answer 2

您可能使这变得比需要的更难。您的 MyAppExtension 可以轻松地从组件库中加载 services.yml。无需组件扩展。

class MyAppBundleExtension extends Extension
{
    public function load(array $configs, ContainerBuilder $container)
    {
        $loader = new Loader\YamlFileLoader($container, 
            new FileLocator('path_to_component_library'));
        $loader->load('services.yml');
    }

获取组件库的路径是唯一的小挑战，但即使是硬编码也不错。

话虽如此，您确实应该考虑为您的库制作一个桥接包。它真正需要的只是一个 Bundle 类、Extension 类和 services.yml 文件。您的图书馆本身可以保持原样。

桥是 Symfony 2 框架用来访问 Twig 和 Doctrine 等库的工具。很确定它们也适用于您的图书馆。看看：vendor/symfony/monolog-bundle 为例。

Answer 3

下面是我最终选择的解决方案。我使用静态 buildContainer 方法在 MyComponent 中创建了一个加载器类：

<?php

namespace MyComponent;

use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;

class MyComponentLoader
{

    /**
     * Loads component services into a container.
     *
     * @param ContainerBuilder $container
     */
    public static function buildContainer(ContainerBuilder $container)
    {
        $loader = new YamlFileLoader($container, new FileLocator(__DIR__ . '/Resources/config'));
        $loader->load('services.yml');
    }

}

然后我将服务从 MyAppBundle 中的 MyAppExtension 加载到我的容器中：

<?php

namespace MyAppBundle\DependencyInjection;

use MyComponent\MyComponentLoader;
use MyOtherComponent\MyOtherComponentLoader;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Extension\Extension;
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;

class SmartCloneExtension extends Extension
{

    public function load(array $configs, ContainerBuilder $container)
    {
        MyComponentLoader::buildContainer($container);
        MyOtherComponentLoader::buildContainer($container);
    }

}