如何在仍然使用 Dagger2 的同时解决循环依赖？

Posted 2023-02-18

【中文标题】如何在仍然使用 Dagger2 的同时解决循环依赖？

【英文标题】：How to resolve a circular dependency while still using Dagger2?

【发布时间】：2017-11-26 08:10:01

【问题描述】：

我有两个类，Foo<T> 和 Bar，它们相互依赖，还有其他各种类。我正在使用 Dagger-2 进行依赖注入，但如果我天真地添加循环依赖，Dagger 在运行时会遇到堆栈溢出。什么是重构类来解决这个问题的好方法，同时仍然使用 Dagger 注入所有其他依赖项，并且对现有调用的重复和更改最少？

【参考方案1】：

经过大量的思考和与同事的交谈，我们最终做了以下事情：

class Foo<T> extends FooWithoutDep<T> 
    @Inject Foo(Bar bar, OtherDep1 dep1, OtherDep2 dep2) 
        super(dep1, dep2);
        setBarDep(bar);
    


class FooWithoutDep<T> 
    //Field declarations elided
    @Inject FooWithoutDep(OtherDep1 dep1, OtherDep2 dep2) 
        //Normal constructor stuff
    
    void setBarDep(Bar bar)  this.bar = bar; 

    //The rest of the actual logic


class Bar 
    //Field declarations elided
    @Inject Bar(FooWithoutDep<Thing> foo, OtherDep3 dep3) 
        this.foo = foo;
        this.foo.setBarDep(this);
        this.dep3 = dep3;
    

    //Code that uses Foo and the other dependencies

解释这一点——我们将 Foo 的实际逻辑移到了父类 (FooWithoutDep) 中，该类将循环依赖项作为可设置字段而不是构造函数参数。然后原始类只包含一个构造函数，它接受循环依赖并调用setter。另一个类 Bar 依赖于父类 (FooWithoutDep)，并显式调用 setter，传递自身 (this)。这使得对该类的所有现有引用保持不变，同时仍使用 Dagger 注入所有依赖项。

这似乎令人困惑，值得在这里写出来。

【讨论】：

我觉得这段代码有问题，在Bar构造函数中没有创建对象时引用this，应该只在构造函数后引用this。但如果我错了，请纠正我。

不，在 Java 中通常在构造函数中引用 this -- 除非我误解了你的意思......

是的，但是当对象没有完全构造时，你怎么能引用它呢？我在某处读到这是一种不好的做法。这段代码的另一个问题是我认为它不会让 gc 清理对象，所以当你不再需要对象时记得 setBarDep(null)。

【参考方案2】：

简单的方法是在一侧使用Lazy<T>。

Lazy<Foo> foo;

@Inject
Bar(Lazy<Foo> foo) 
    this.foo = foo;


// use foo.get(); when needed

【讨论】：

等等——为什么会这样？每当您调用get 时，它是否仍会陷入循环？

如果你只在实际使用时调用get()，那么一侧初始化自己，而另一侧只稍后初始化。只是不要在构造函数中调用.get()。我以前做过这个，它有效，但它是简单的出路。

OK，所以当你实际使用它时（即调用foo.get()）Dagger需要构造Foo的依赖实例，其中包括一个@的new实例987654328@，这需要Lazy<Foo> 的新实例——但这就是循环终止的地方？

当我尝试它时它似乎工作，它们都没有作用域。

请注意，如果你使用kotlin，你应该导入dagger.Lazy而不是kotlin.Lazy。

【参考方案3】：

这就是我解决它的方法，没有父类。

第 1 类：引擎。 （在组件界面中）

@Provides
public Engine myEngine(Context context) 
    return new Engine (context);

第 2 类：零件。 Engine 也需要 Parts 实例，但创建延迟。

@Inject
public Parts(Context context, Engine engine) 
    this.context = context;
    this.engine= engine;
    engine.setParts(this);

可以实现循环依赖，但必须先启动一个类。

再次，如果可能，重构代码以避免循环 DI。