Symfony 服务容器：在测试环境中访问私有服务及高级公共化技巧

本文详细探讨了在symfony应用中，特别是在集成测试场景下，如何有效访问和管理私有服务。文章首先推荐使用symfony内置的测试工具访问私有服务，随后介绍了通过配置`_defaults`或自定义编译器通行证将服务公共化的替代方案，并分析了它们的适用场景及局限性，旨在提供一套全面的服务访问策略。

在Symfony应用程序的开发和维护过程中，尤其是在编写集成测试时，经常需要直接访问依赖注入（DI）容器中的特定服务。默认情况下，Symfony的服务多为私有，旨在封装内部实现细节并鼓励通过构造函数注入。然而，在某些测试场景下，直接获取或操作私有服务变得必要。本文将介绍几种在Symfony中访问私有服务，或将其公共化的策略。

一、推荐方法：利用Symfony测试工具访问私有服务

对于功能和集成测试，Symfony提供了专门的测试基类，如Symfony\Bundle\FrameworkBundle\Test\WebTestCase和Symfony\Bundle\FrameworkBundle\Test\KernelTestCase。这些基类内置了便捷机制，允许测试代码直接访问私有服务，而无需修改服务的公共性配置。

自Symfony 4.1版本起，通过这些测试基类，可以直接使用static::$container属性来获取一个“特殊”的容器实例。这个容器能够直接解析并返回私有服务，极大地简化了测试代码。

示例：

<?php

namespace App\Tests;

use Symfony\Bundle\FrameworkBundle\Test\KernelTestCase;
use App\Service\MyPrivateService; // 假设有一个私有服务

class MyServiceTest extends KernelTestCase
{
    public function testPrivateServiceAccess(): void
    {
        self::bootKernel(); // 启动内核

        // 通过 static::$container 直接获取私有服务
        $privateService = static::$container->get(MyPrivateService::class);

        $this->assertInstanceOf(MyPrivateService::class, $privateService);
        // ... 对服务进行测试
    }
}

注意事项：

• 这是在测试环境中访问私有服务的首选和推荐方法，因为它不需要对服务定义进行任何修改，保持了生产环境的配置纯净。
• 这种方法仅适用于继承自WebTestCase或KernelTestCase的测试类。
• 确保在访问容器之前调用self::bootKernel()来启动Symfony内核。

二、替代方案一：通过配置默认值公共化服务

如果由于特定原因（例如，非标准测试框架或需要容器在更广泛的范围内公共化服务），上述方法不适用，可以考虑在特定环境（如test环境）中配置服务默认值为公共。

可以在config/services_test.yaml文件中添加如下配置：

# config/services_test.yaml
services:
    _defaults:
        public: true

工作原理：

• _defaults配置块允许为所有服务定义默认行为。
• public: true会将所有自动装配（autowired）的服务默认设置为公共。

局限性：

• 这种方法只影响那些通过自动装配或在当前配置文件中明确定义的服务。
• 由第三方Bundle定义的服务，如果它们没有在当前配置文件中被覆盖，其公共性设置将不受此影响，仍然保持私有。这意味着你可能无法通过这种方式访问到所有私有服务。

三、替代方案二：使用编译器通行证强制公共化所有服务

最全面但也是最复杂的方案是创建一个自定义的编译器通行证（Compiler Pass），在服务容器编译阶段遍历所有服务定义，并将其强制设置为公共。这种方法可以确保所有服务（包括由Bundle定义的服务）都变为公共。

拾贝

一键同步微信读书所有笔记和划线，并在新标签页回顾

186

查看详情

1. 创建编译器通行证：

创建一个实现CompilerPassInterface的类，例如MakeServicesPublicPass.php：

<?php

namespace App\DependencyInjection\Compiler;

use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;

class MakeServicesPublicPass implements CompilerPassInterface
{
    public function process(ContainerBuilder $container): void
    {
        // 遍历所有服务定义，将其设置为公共
        foreach ($container->getDefinitions() as $id => $definition) {
            $definition->setPublic(true);
        }

        // 遍历所有服务别名，将其设置为公共
        foreach ($container->getAliases() as $id => $alias) {
            $alias->setPublic(true);
        }
    }
}

2. 在测试环境中注册编译器通行证：

为了确保这个通行证只在测试环境生效，你需要在你的Kernel类中，通过configureContainer()方法有条件地注册它。

<?php

// src/Kernel.php
namespace App;

use App\DependencyInjection\Compiler\MakeServicesPublicPass; // 引入编译器通行证
use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Kernel as BaseKernel;

class Kernel extends BaseKernel
{
    use MicroKernelTrait;

    // ... 其他方法

    protected function configureContainer(ContainerBuilder $container): void
    {
        // ... 其他配置加载

        if ($this->environment === 'test') {
            $container->addCompilerPass(new MakeServicesPublicPass());
        }
    }

    // ... 其他方法
}

工作原理：

• 编译器通行证在服务容器被编译成可用的状态之前执行。
• MakeServicesPublicPass会遍历容器中的所有服务定义（Definition）和别名（Alias），并调用setPublic(true)方法，强制它们变为公共。
• 通过在configureContainer中根据环境判断，可以确保此通行证仅在test环境被激活。

优点：

• 这是最彻底的解决方案，能够确保所有服务（包括由Bundle定义的）都变为公共。

缺点：

• 相对复杂，需要编写额外的PHP代码。
• 过度公共化服务可能掩盖设计问题，并增加容器启动时的额外处理开销（尽管在测试环境通常可以接受）。

总结与最佳实践

在Symfony中访问私有服务，尤其是在测试场景下，应优先考虑使用框架提供的内置测试工具。

1. 首选方案： 对于集成或功能测试，始终推荐使用Symfony\Bundle\FrameworkBundle\Test\WebTestCase或KernelTestCase，并通过static::$container直接获取私有服务。这种方法既高效又符合最佳实践，且不会污染生产环境的服务配置。
2. 次选方案： 如果第一种方法不适用，且你只需要公共化自动装配的服务，可以在config/services_test.yaml中设置_defaults: public: true。
3. 最终方案： 当需要确保所有服务（包括第三方Bundle服务）都公共化时，且其他方法均不可行时，可以考虑实现一个自定义的编译器通行证，并仅在测试环境中注册。

选择哪种方法取决于具体的测试需求和环境限制。通常情况下，利用Symfony的测试基类是满足大多数集成测试场景的最佳实践。

以上就是Symfony 服务容器：在测试环境中访问私有服务及高级公共化技巧的详细内容，更多请关注php中文网其它相关文章！