注册为应用服务的库双向依赖时Auto-wiring循环引用问题求助

我之前在处理DI自动装配的双向依赖场景时，也碰到过一模一样的循环引用错误，这种情况确实挺棘手的，给你分享几个经过实践验证的解决办法，按推荐优先级排序：

1. 重构代码，提取公共依赖（最推荐的长期方案） #

循环引用往往暗示着代码职责划分不够清晰——两个服务互相依赖对方的部分方法，说明这些方法其实可以独立出来成为一个新的公共服务。举个例子：

• 原来ServiceALibrary调用ServiceBLibrary的sharedMethodX()
• 同时ServiceBLibrary调用ServiceALibrary的sharedMethodY()

你可以把这两个共享方法抽离到一个新的SharedServiceLibrary里，然后让ServiceA和ServiceB都注入这个新服务，彻底打破循环。这样不仅解决了问题，还让代码结构更清晰，符合单一职责原则。

2. 使用延迟注入（Lazy Injection）（快速解决首选） #

如果暂时没法重构代码，延迟注入是最省心的方案。DI容器会延迟实例化被标记为“lazy”的服务，直到第一次调用它的方法时才创建，这样就避免了初始化时的循环引用。

在Symfony中实现的两种方式： #

方式一：使用属性标记

use Symfony\Component\DependencyInjection\Attribute\Lazy;

class ServiceALibrary
{
    // 给依赖的ServiceB加上#[Lazy]属性
    public function __construct(#[Lazy] private ServiceBLibrary $serviceB)
    {
    }
}

方式二：在配置文件中设置

在services.yaml里给其中一个或两个服务开启lazy模式：

services:
    App\Library\ServiceALibrary:
        lazy: true
    App\Library\ServiceBLibrary:
        lazy: true

3. 使用Setter注入代替构造函数注入 #

构造函数注入是DI的推荐方式，但如果循环依赖实在无法避免，可以改用Setter注入。这种方式不在构造函数里注入依赖，而是通过Setter方法在容器初始化完成后再注入。

示例代码：

class ServiceALibrary
{
    private ?ServiceBLibrary $serviceB = null;

    // 提供Setter方法注入ServiceB
    public function setServiceB(ServiceBLibrary $serviceB): void
    {
        $this->serviceB = $serviceB;
    }

    public function doSomething()
    {
        // 使用前要确保ServiceB已注入
        if ($this->serviceB === null) {
            throw new \RuntimeException('ServiceBLibrary未注入，请检查DI配置');
        }
        $this->serviceB->someMethod();
    }
}

对应的DI配置：

services:
    App\Library\ServiceALibrary:
        calls:
            - [setServiceB, ['@App\Library\ServiceBLibrary']]
    App\Library\ServiceBLibrary:
        arguments: ['@App\Library\ServiceALibrary']

4. 使用服务定位器（Service Locator） #

服务定位器允许你按需获取依赖服务，而不是在构造函数里直接注入。你可以创建一个定位器，只包含需要的依赖，然后在服务内部按需获取。

示例代码：

use Symfony\Component\DependencyInjection\ServiceLocator;

class ServiceALibrary
{
    private ServiceLocator $serviceLocator;

    public function __construct(ServiceLocator $serviceLocator)
    {
        $this->serviceLocator = $serviceLocator;
    }

    public function doSomething()
    {
        // 按需获取ServiceB
        /** @var ServiceBLibrary $serviceB */
        $serviceB = $this->serviceLocator->get(ServiceBLibrary::class);
        $serviceB->someMethod();
    }
}

对应的DI配置：

services:
    App\Library\ServiceALibrary:
        arguments: ['@service.locator.shared']
    
    # 定义服务定位器
    service.locator.shared:
        class: Symfony\Component\DependencyInjection\ServiceLocator
        arguments:
            - {
                App\Library\ServiceBLibrary: '@App\Library\ServiceBLibrary'
              }
        tags: ['container.service_locator']

内容的提问来源于stack exchange，提问作者Adambean