使用 Dagger 2 在库模块中注入应用程序上下文

我正在构建一个具有一些功能的应用程序：ContentProvider、SyncAdapter、作业服务和相关的持久性逻辑。在这些之上是带有 UI 的活动。我试图将所有上述功能放在一个单独的库模块中，因为理论上它们的逻辑是独立的并且可以由任何应用程序重用。

现在 Dagger2 来了。我的库依赖关系图的第一个节点（主组件）确实需要提供 Context，并且该 Context 必须从应用程序注入，因为库作用域具有与应用程序相同的生命周期。显然，为了自包含，我的库不应该直接使用我的 Application 类。

这些是我想到的可能性：

• 在我的应用程序中构建库的主要组件，并将其存储在全局静态类/枚举中，按照建议here但我担心使用这样的静态引用可能是一种反模式。
• 在库中打包一个应用程序类，该类构建库范围内的组件，将应用程序上下文转换为库中的此类以使用该组件，然后在主应用程序上扩展此应用程序类。这是可行的，但如果有多个库，它就不再可行了。
• 使用工厂模式：将提供方法放入提供工厂的库组件中，而工厂又被赋予本地可用的上下文作为参数。 （正如所解释的here）。这似乎是可行的，尽管它增加了额外的复杂性。
• 最后但并非最不重要的一点是，放弃尝试模块化组件，因为依赖于应用程序上下文破坏了模块化的概念。

这样做的正确方法是什么？

匕首 2 安卓版来救援。它提供了以下概念：AndroidInjector，这是一个Component可以用于以静态方式注入实例，而无需知道依赖项提供程序。此外，使用Dagger-开箱即用提供前缀类，注入的依赖项看起来像是来自无处。惊人的。

您所要做的就是在库中声明一个顶级Module它安装在应用程序中Component. This Module将提供所有依赖项和SubComponent库需要的s，会自动继承@AppContext Context您在依赖关系图中播种的内容，准备好注入库中的任何位置，以及您通过主应用程序提供的每个依赖关系Component.

这是一个简短的示例（用 Kotlin 编写）：

@Component(modules = [
    AndroidSupportInjectionModule::class,
    AppModule::class,
    LibraryModule::class //plug-in the library to the dependency graph
])
@Singleton
interface AppComponent : AndroidInjector<App> {

    @Component.Builder
    abstract class Builder : AndroidInjector.Builder<App>() {

        @BindsInstance
        abstract fun appContext(@AppContext context: Context)

        override fun seedInstance(instance: App) {
            appContext(instance)
        }
    }
}

编辑：扩展示例

应用程序子类的示例：

// DaggerApplication provides out-of-the-box support to all the AndroidInjectors.
// See the class' code to understand the magic.
public class App extends DaggerApplication {

@Override
protected AndroidInjector<? extends DaggerApplication> applicationInjector() {
    // We only provide its own Injector, the Application Injector,
    // that is the previous AppComponent
    return DaggerAppComponent.builder().create(this);
}

在你的 Android 库中：

@Module
public abstract class LibraryModule {

    @ContributesAndroidInjector
    public abstract LibraryActivity contributeLibraryActivityInjector();

}

public class LibraryActivity extends DaggerAppCompatActivity {

    @Inject
    @AppContext
    Context appContext;

    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceSate);
        // here you automagically have your injected application context!
        ExternalSingleton.getInstance(appContext)
    }
}